Azure OpenAI dalam referensi pratinjau REST API v1 Model Microsoft Foundry

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

Inferensi bidang data

Sisa artikel ini membahas rilis API pratinjau v1 baru kami dari spesifikasi inferensi sarana data OpenAI Azure. Pelajari lebih lanjut di panduan siklus hidup API kami.

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

Membuat ucapan

POST {endpoint}/openai/v1/audio/speech?api-version=preview

Menghasilkan audio teks ke ucapan 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
versi-API	kueri	Tidak.		Versi API Model Microsoft Foundry yang eksplisit yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.

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 dihasilkan audionya. Panjang maksimum adalah 4096 karakter.	Yes
instructions	string	Kontrol suara audio yang Anda hasilkan dengan instruksi tambahan. Tidak berfungsi dengan tts-1 atau tts-1-hd.	Tidak.
model	string	Model yang digunakan untuk permintaan konversi teks ke suara ini.	Yes
response_format	objek	Format output audio yang didukung untuk teks ke ucapan.	Tidak.
speed	nomor/angka	Kecepatan ucapan untuk audio yang dihasilkan. Nilai valid berada dalam rentang dari 0,25 hingga 4,0, dengan 1,0 sebagai nilai default dan nilai yang lebih tinggi menghasilkan ucapan yang lebih cepat.	Tidak.	1
stream_format	enum	Format untuk mengalirkan audio. Format yang didukung adalah sse dan audio. sse tidak didukung untuk tts-1 atau tts-1-hd. Nilai yang mungkin: sse, audio	Tidak.
voice	objek		Yes

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/octet-stream	string

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureErrorResponse

Contoh

Contoh

Mensintesis audio dari teks yang disediakan.

POST {endpoint}/openai/v1/audio/speech?api-version=preview

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

Respons: Kode Status: 200

{
  "body": "101010101"
}

Membuat transkripsi

POST {endpoint}/openai/v1/audio/transcriptions?api-version=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
versi-API	kueri	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.

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
chunking_strategy	objek		Tidak.
└─ prefix_padding_ms (isian_awalan_dalam_milidetik)	bilangan bulat	Jumlah audio yang akan disertakan sebelum ucapan yang terdeteksi oleh VAD (dalam milidetik).	Tidak.	300
└─ durasi_keheningan_dalam_milidetik (silence_duration_ms)	bilangan bulat	Durasi keheningan untuk mendeteksi pemberhentian ucapan (dalam milidetik). Dengan nilai yang lebih pendek, model akan merespons lebih cepat, tetapi mungkin melompat pada jeda singkat dari pengguna.	Tidak.	200
└─ ambang batas	nomor/angka	Ambang sensitivitas (0,0 hingga 1,0) untuk deteksi aktivitas suara. 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.	0,5
└─ jenis	enum	Harus diatur ke server_vad untuk mengaktifkan penggugusan manual menggunakan VAD sisi server. Nilai yang mungkin: server_vad	Tidak.
berkas	string		Yes
filename	string	Nama file atau pengidentifikasi deskriptif opsional untuk mengaitkannya dengan data audio.	Tidak.
include[]	array	Informasi tambahan untuk disertakan dalam respons transkripsi. logprobs akan mengembalikan probabilitas log token dalam respons untuk memahami keyakinan model dalam transkripsi. logprobs hanya berfungsi dengan response_format diatur ke json dan hanya dengan model gpt-4o-transcribe, gpt-4o-transcribe-diarize, gpt-4o-mini-transcribe, dan gpt-4o-mini-transcribe-2025-12-15.	Tidak.
bahasa	string	Bahasa audio input. Menyediakan bahasa input dalam format ISO-639-1 (misalnya en) akan meningkatkan akurasi dan latensi.	Tidak.
model	string	Model yang digunakan untuk permintaan transkripsi ini.	Tidak.
minta	string	Teks opsional untuk memandu gaya model atau melanjutkan segmen audio sebelumnya. Perintah harus cocok dengan bahasa audio.	Tidak.
response_format	objek		Tidak.
aliran	Boolean	Jika diatur ke true, data respons model akan dialirkan ke klien saat dibuat menggunakan peristiwa yang dikirim server. Catatan: Streaming tidak didukung untuk whisper-1 model dan akan diabaikan.	Tidak.	False
suhu	nomor/angka	Suhu pengambilan sampel, antara 0 dan 1. Nilai yang lebih tinggi seperti 0,8 akan membuat output lebih acak, sementara nilai yang lebih rendah seperti 0,2 akan membuatnya lebih fokus dan deterministik. Jika diatur ke 0, model akan menggunakan probabilitas log untuk secara otomatis meningkatkan suhu hingga ambang batas tertentu terpukul.	Tidak.	0
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: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	AzureAudioTranscriptionResponse
teks/polosan	string

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureErrorResponse

Contoh

Contoh

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

POST {endpoint}/openai/v1/audio/transcriptions?api-version=preview

{
 "file": "<binary audio data>",
 "model": "whisper-1",
 "response_format": "text"
}

Respons: Kode Status: 200

{
  "body": "plain text when requesting text, srt, or vtt"
}

Membuat terjemahan

POST {endpoint}/openai/v1/audio/translations?api-version=preview

Mendapatkan teks yang ditranskripsikan bahasa Inggris dan metadata terkait dari data audio lisan 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
versi-API	kueri	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.

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		Yes
filename	string	Nama file opsional atau pengidentifikasi deskriptif untuk dikaitkan dengan data audio	Tidak.
model	string	Model yang digunakan untuk permintaan terjemahan ini.	Tidak.
minta	string	Teks opsional untuk memandu gaya model atau melanjutkan segmen audio sebelumnya. Prompt harus dalam bahasa Inggris.	Tidak.
response_format	objek		Tidak.
suhu	nomor/angka	Suhu pengambilan sampel, antara 0 dan 1. Nilai yang lebih tinggi seperti 0,8 akan membuat output lebih acak, sementara nilai yang lebih rendah seperti 0,2 akan membuatnya lebih fokus dan deterministik. Jika diatur ke 0, model akan menggunakan probabilitas log untuk secara otomatis meningkatkan suhu hingga ambang batas tertentu terpukul.	Tidak.	0

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	AzureAudioTranslationResponse
teks/polosan	string

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureErrorResponse

Contoh

Contoh

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

POST {endpoint}/openai/v1/audio/translations?api-version=preview

{
 "file": "<binary audio data>",
 "model": "whisper-1",
 "response_format": "text"
}

Respons: Kode Status: 200

{
  "body": "plain text when requesting text, srt, or vtt"
}

Membuat penyelesaian obrolan

POST {endpoint}/openai/v1/chat/completions?api-version=preview

Membuat penyelesaian 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
versi-API	kueri	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.

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, , aacmp3, flac, opus,pcm16	Tidak.
└─ suara	objek		Tidak.
data_sources	array	Sumber data yang digunakan untuk fitur On Your Data, eksklusif untuk 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	enum	Menentukan fungsi tertentu melalui {"name": "my_function"} memaksa model untuk memanggil fungsi tersebut. Nilai yang mungkin: none, auto	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 akan bervariasi per model, tetapi nilai antara -1 dan 1 harus mengurangi atau meningkatkan kemungkinan pilihan; nilai seperti -100 atau 100 harus menghasilkan larangan atau pilihan eksklusif dari token yang relevan.	Tidak.	Tidak ada
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. Nilai ini dapat digunakan untuk mengontrol biaya teks yang dihasilkan melalui API. Nilai ini sekarang dihapuskan sebagai pengganti max_completion_tokens, dan tidak kompatibel dengan model seri o1.	Tidak.
messages	array	Daftar pesan yang terdiri dari percakapan sejauh ini. Bergantung pada model yang Anda gunakan, berbagai jenis pesan (modalitas) didukung, seperti teks, gambar, dan audio.	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, dan mengkueri objek melalui API atau dasbor. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter.	Tidak.
Modalitas	objek	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.
model	string	Pengidentifikasi penyebaran model yang akan digunakan untuk permintaan kompletasi obrolan.	Yes
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	objek	Apakah akan mengaktifkan panggilan fungsi paralel selama penggunaan alat.	Tidak.
prediksi	objek	Representasi dasar output yang diprediksi dari model.	Tidak.
└─ jenis	OpenAI.ChatOutputPredictionType		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	objek	model seri o 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.	Tidak.
response_format	objek		Tidak.
└─ jenis	enum	Nilai yang mungkin: text, json_object, json_schema	Tidak.
seed	bilangan bulat	Fitur ini ada di Beta. Jika ditentukan, sistem kami akan melakukan upaya terbaik untuk sampel secara deterministik, sehingga permintaan berulang dengan yang sama seed dan parameter harus mengembalikan hasil yang sama. Determinisme tidak dijamin, dan Anda harus merujuk ke system_fingerprint parameter respons untuk memantau perubahan di backend.	Tidak.
stop	objek	Tidak didukung dengan model penalaran yang terbaru o3 dan o4-mini. Hingga 4 urutan di mana API akan berhenti menghasilkan token lebih lanjut. Teks yang dikembalikan tidak akan berisi urutan berhenti.	Tidak.
simpan	Boolean	Apakah menyimpan output permintaan penyelesaian obrolan ini untuk digunakan dalam distilasi model atau produk evaluasi atau tidak.	Tidak.	False
aliran	Boolean	Jika diatur ke true, data respons model akan dialirkan ke klien saat sedang dihasilkan menggunakan peristiwa yang dikirim oleh server.	Tidak.	False
stream_options	objek	Opsi untuk respons streaming. Hanya atur ini saat Anda mengatur stream: true.	Tidak.
└─ sertakan_penggunaan	Boolean	Jika diatur, bagian tambahan akan dialirkan sebelum pesan data: [DONE]. Bidang usage pada gugus ini menunjukkan statistik penggunaan token untuk seluruh permintaan, dan choices bidang akan selalu menjadi array kosong. Semua bagian lainnya juga akan menyertakan usage bidang, tetapi dengan nilai null. NOTA: Jika aliran terganggu, Anda mungkin tidak menerima gugus penggunaan akhir yang berisi total penggunaan token untuk permintaan tersebut.	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
tool_choice	OpenAI.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.	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	AzureUserSecurityContext	Konteks keamanan pengguna berisi beberapa parameter yang menjelaskan aplikasi itu sendiri, dan pengguna akhir yang berinteraksi dengan aplikasi. 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: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	AzureCreateChatCompletionResponse
text/event-stream	AzureCreateChatCompletionStreamResponse

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureErrorResponse

Contoh

Contoh

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

POST {endpoint}/openai/v1/chat/completions?api-version=preview

{
 "model": "gpt-4o-mini",
 "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?..."
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Membuat penyematan

POST {endpoint}/openai/v1/embeddings?api-version=preview

Membuat vektor penyematan yang mewakili 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
versi-API	kueri	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.

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	enum	Format untuk mengembalikan penggabungan dalam. Dapat berupa float atau base64. Nilai yang mungkin: float, base64	Tidak.
Masukan	string atau array		Yes
model	string	Model yang digunakan untuk permintaan penyematan.	Yes
pengguna	string	Pengidentifikasi unik yang mewakili pengguna akhir Anda, yang dapat membantu OpenAI memantau dan mendeteksi penyalahgunaan.	Tidak.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	OpenAI.CreateEmbeddingResponse

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureErrorResponse

Contoh

Contoh

Kembalikan penyematan untuk prompt tertentu.

POST {endpoint}/openai/v1/embeddings?api-version=preview

{
 "model": "text-embedding-ada-002",
 "input": [
  "this is a test"
 ]
}

Respons: Kode Status: 200

{
  "body": {
    "data": [
      {
        "index": 0,
        "embedding": [
          -0.012838088,
          -0.007421397,
          -0.017617522,
          -0.028278312,
          -0.018666342,
          0.01737855,
          -0.01821495,
          -0.006950092,
          -0.009937238,
          -0.038580645,
          0.010674067,
          0.02412286,
          -0.013647936,
          0.013189907,
          0.0021125758,
          0.012406612,
          0.020790534,
          0.00074595667,
          0.008397198,
          -0.00535031,
          0.008968075,
          0.014351576,
          -0.014086051,
          0.015055214,
          -0.022211088,
          -0.025198232,
          0.0065186154,
          -0.036350243,
          0.009180495,
          -0.009698266,
          0.009446018,
          -0.008463579,
          -0.0040426035,
          -0.03443847,
          -0.00091273896,
          -0.0019217303,
          0.002349888,
          -0.021560553,
          0.016515596,
          -0.015572986,
          0.0038666942,
          -8.432463e-05,
          0.0032178196,
          -0.020365695,
          -0.009631885,
          -0.007647093,
          0.0033837722,
          -0.026764825,
          -0.010501476,
          0.020219658,
          0.024640633,
          -0.0066912062,
          -0.036456455,
          -0.0040923897,
          -0.013966565,
          0.017816665,
          0.005366905,
          0.022835068,
          0.0103488,
          -0.0010811808,
          -0.028942121,
          0.0074280356,
          -0.017033368,
          0.0074877786,
          0.021640211,
          0.002499245,
          0.013316032,
          0.0021524043,
          0.010129742,
          0.0054731146,
          0.03143805,
          0.014856071,
          0.0023366117,
          -0.0008243692,
          0.022781964,
          0.003038591,
          -0.017617522,
          0.0013309394,
          0.0022154662,
          0.00097414135,
          0.012041516,
          -0.027906578,
          -0.023817508,
          0.013302756,
          -0.003003741,
          -0.006890349,
          0.0016744611
        ]
      }
    ],
    "usage": {
      "prompt_tokens": 4,
      "total_tokens": 4
    }
  }
}

Daftar evaluasi

GET {endpoint}/openai/v1/evals?api-version=preview

Mencantumkan evaluasi untuk project.

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	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.
aoai-evals	header	Yes	string Nilai yang mungkin: preview	Mengaktifkan access ke AOAI Evals, fitur pratinjau. Fitur ini mengharuskan header 'aoai-evals' diatur ke 'pratinjau'.
after	kueri	Tidak.	string	Identifier untuk evaluasi terakhir dari permintaan pemutaran halaman sebelumnya.
limit	kueri	Tidak.	bilangan bulat	Batas jumlah evaluasi yang akan dikembalikan dalam satu respons penomoran halaman.
order	kueri	Tidak.	string Nilai yang mungkin: asc, desc	Urutkan urutan untuk evaluasi menurut tanda waktu. Gunakan asc untuk urutan naik atau desc untuk urutan turun.
susun_berdasarkan	kueri	Tidak.	string Nilai yang mungkin: created_at, updated_at	Evaluasi dapat diurutkan berdasarkan waktu pembuatan atau waktu terakhir diperbarui. Gunakan created_at untuk waktu pembuatan atau updated_at untuk waktu terakhir diperbarui.

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: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	OpenAI.EvalList

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureErrorResponse

Createeval

POST {endpoint}/openai/v1/evals?api-version=preview

Buat struktur evaluasi yang dapat digunakan untuk menguji performa model.

Evaluasi adalah serangkaian kriteria pengujian dan sumber data. Setelah membuat evaluasi, Anda dapat menjalankannya pada model dan parameter model yang berbeda. Kami mendukung beberapa jenis penilai dan sumber data.

CATATAN: API OpenAI Azure ini dalam pratinjau dan dapat berubah.

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	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.
aoai-evals	header	Yes	string Nilai yang mungkin: preview	Mengaktifkan access ke AOAI Evals, fitur pratinjau. Fitur ini mengharuskan header 'aoai-evals' diatur ke 'pratinjau'.

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
konfigurasi_sumber_data	objek		Yes
└─ jenis	OpenAI.EvalDataSourceConfigType		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, dan mengkueri objek melalui API atau dasbor. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter.	Tidak.
Nama	string	Nama evaluasi.	Tidak.
kode status	enum	Nilai yang mungkin: 201	Yes
kriteria_pengujian	array	Daftar penilai untuk semua sesi evaluasi yang dijalankan dalam grup ini. Grader dapat mereferensikan variabel dalam sumber data menggunakan notasi kurung kurawal ganda, seperti {{item.variable_name}}. Untuk mereferensikan output model, gunakan sample namespace (yaitu, {{sample.output_text}}).	Yes

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	OpenAI.Eval

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureErrorResponse

Dapatkan evaluasi

GET {endpoint}/openai/v1/evals/{eval_id}?api-version=preview

Ambil evaluasi dengan ID-nya. Mengambil evaluasi dengan ID-nya.

CATATAN: API OpenAI Azure ini dalam pratinjau dan dapat berubah.

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	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.
aoai-evals	header	Yes	string Nilai yang mungkin: preview	Mengaktifkan access ke AOAI Evals, fitur pratinjau. Fitur ini mengharuskan header 'aoai-evals' diatur ke 'pratinjau'.
eval_id	path	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: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	OpenAI.Eval

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureErrorResponse

Evaluasi pembaruan

POST {endpoint}/openai/v1/evals/{eval_id}?api-version=preview

Perbarui pilih, properti yang dapat diubah dari evaluasi tertentu.

CATATAN: API OpenAI Azure ini dalam pratinjau dan dapat berubah.

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	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.
aoai-evals	header	Yes	string Nilai yang mungkin: preview	Mengaktifkan access ke AOAI Evals, fitur pratinjau. Fitur ini mengharuskan header 'aoai-evals' diatur ke 'pratinjau'.
eval_id	path	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	OpenAI.MetadataPropertyForRequest	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.
Nama	string		Tidak.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	OpenAI.Eval

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureErrorResponse

Hapus evaluasi

DELETE {endpoint}/openai/v1/evals/{eval_id}?api-version=preview

Menghapus evaluasi tertentu.

CATATAN: API OpenAI Azure ini dalam pratinjau dan dapat berubah.

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	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.
aoai-evals	header	Yes	string Nilai yang mungkin: preview	Mengaktifkan access ke AOAI Evals, fitur pratinjau. Fitur ini mengharuskan header 'aoai-evals' diatur ke 'pratinjau'.
eval_id	path	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: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	objek

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureErrorResponse

Mendapatkan eksekusi evaluasi

GET {endpoint}/openai/v1/evals/{eval_id}/runs?api-version=preview

Ambil daftar eksekusi untuk evaluasi tertentu.

CATATAN: API OpenAI Azure ini dalam pratinjau dan dapat berubah.

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	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.
aoai-evals	header	Yes	string Nilai yang mungkin: preview	Mengaktifkan access ke AOAI Evals, fitur pratinjau. Fitur ini mengharuskan header 'aoai-evals' diatur ke 'pratinjau'.
eval_id	path	Yes	string
after	kueri	Tidak.	string
limit	kueri	Tidak.	bilangan bulat
order	kueri	Tidak.	string Nilai yang mungkin: asc, desc
status	kueri	Tidak.	string Nilai yang mungkin: queued, , in_progresscompleted, canceled,failed

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: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	OpenAI.EvalRunList

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureErrorResponse

Membuat eval run

POST {endpoint}/openai/v1/evals/{eval_id}/runs?api-version=preview

Buat eksekusi evaluasi baru, mulai proses penilaian.

CATATAN: API OpenAI Azure ini dalam pratinjau dan dapat berubah.

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	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.
aoai-evals	header	Yes	string Nilai yang mungkin: preview	Mengaktifkan access ke AOAI Evals, fitur pratinjau. Fitur ini mengharuskan header 'aoai-evals' diatur ke 'pratinjau'.
eval_id	path	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
sumber data	objek		Yes
└─ jenis	OpenAI.EvalRunDataSourceType		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, dan mengkueri objek melalui API atau dasbor. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter.	Tidak.
Nama	string	Nama eksekusi.	Tidak.

Responses

Kode Status: 201

Deskripsi: Permintaan telah berhasil dan sumber daya baru telah dibuat sebagai hasilnya.

Content-Type	Jenis	Deskripsi
application/json	OpenAI.EvalRun

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureErrorResponse

Dapatkan eksekusi evaluasi

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}?api-version=preview

Ambil evaluasi tertentu yang dijalankan oleh ID-nya.

CATATAN: API OpenAI Azure ini dalam pratinjau dan dapat berubah.

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	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.
aoai-evals	header	Yes	string Nilai yang mungkin: preview	Mengaktifkan access ke AOAI Evals, fitur pratinjau. Fitur ini mengharuskan header 'aoai-evals' diatur ke 'pratinjau'.
eval_id	path	Yes	string
run_id	path	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: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	OpenAI.EvalRun

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureErrorResponse

Batalkan eksekusi evaluasi

POST {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}?api-version=preview

Batalkan evaluasi tertentu yang dijalankan oleh ID-nya.

CATATAN: API OpenAI Azure ini dalam pratinjau dan dapat berubah.

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	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.
aoai-evals	header	Yes	string Nilai yang mungkin: preview	Mengaktifkan access ke AOAI Evals, fitur pratinjau. Fitur ini mengharuskan header 'aoai-evals' diatur ke 'pratinjau'.
eval_id	path	Yes	string
run_id	path	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: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	OpenAI.EvalRun

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureErrorResponse

Deleteevalrun

DELETE {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}?api-version=preview

Hapus evaluasi tertentu yang dijalankan oleh ID-nya.

CATATAN: API OpenAI Azure ini dalam pratinjau dan dapat berubah.

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	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.
aoai-evals	header	Yes	string Nilai yang mungkin: preview	Mengaktifkan access ke AOAI Evals, fitur pratinjau. Fitur ini mengharuskan header 'aoai-evals' diatur ke 'pratinjau'.
eval_id	path	Yes	string
run_id	path	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: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	objek

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureErrorResponse

Mendapatkan item output eksekusi evaluasi

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}/output_items?api-version=preview

Dapatkan daftar item output untuk eksekusi evaluasi tertentu.

CATATAN: API OpenAI Azure ini dalam pratinjau dan dapat berubah.

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	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.
aoai-evals	header	Yes	string Nilai yang mungkin: preview	Mengaktifkan access ke AOAI Evals, fitur pratinjau. Fitur ini mengharuskan header 'aoai-evals' diatur ke 'pratinjau'.
eval_id	path	Yes	string
run_id	path	Yes	string
after	kueri	Tidak.	string
limit	kueri	Tidak.	bilangan bulat
status	kueri	Tidak.	string Nilai yang mungkin: fail, pass
order	kueri	Tidak.	string Nilai yang mungkin: asc, desc

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: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	OpenAI.EvalRunOutputItemList

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureErrorResponse

Dapatkan item output eksekusi evaluasi

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}/output_items/{output_item_id}?api-version=preview

Ambil item output tertentu dari evaluasi yang dijalankan oleh ID-nya.

CATATAN: API OpenAI Azure ini dalam pratinjau dan dapat berubah.

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	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.
aoai-evals	header	Yes	string Nilai yang mungkin: preview	Mengaktifkan access ke AOAI Evals, fitur pratinjau. Fitur ini mengharuskan header 'aoai-evals' diatur ke 'pratinjau'.
eval_id	path	Yes	string
run_id	path	Yes	string
output_item_id	path	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: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	OpenAI.EvalRunOutputItem

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureErrorResponse

Membuat file

POST {endpoint}/openai/v1/files?api-version=preview

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	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.

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
kedaluwarsa_setelah	objek		Yes
└─ jangkar	AzureFileExpiryAnchor		Tidak.
└─ detik	bilangan bulat		Tidak.
berkas	string		Yes
purpose	enum	Tujuan yang dimaksudkan dari file yang diunggah. Salah satu dari: - assistants: Digunakan dalam Assistants API - batch: Digunakan dalam API Batch - fine-tune: Digunakan untuk penyempurnaan - evals: Digunakan untuk evaluasi himpunan data Nilai yang mungkin: assistants, batch, fine-tune, evals	Yes

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	AzureOpenAIFile

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureErrorResponse

Contoh

Contoh

POST {endpoint}/openai/v1/files?api-version=preview

Mencantumkan file

GET {endpoint}/openai/v1/files?api-version=preview

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	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.
purpose	kueri	Tidak.	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: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	AzureListFilesResponse

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureErrorResponse

Mengambil file

GET {endpoint}/openai/v1/files/{file_id}?api-version=preview

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	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.
file_id	path	Yes	string	ID file yang akan digunakan untuk permintaan ini.

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: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	AzureOpenAIFile

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureErrorResponse

Hapus file

DELETE {endpoint}/openai/v1/files/{file_id}?api-version=preview

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	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.
file_id	path	Yes	string	ID file yang akan digunakan untuk permintaan ini.

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: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	OpenAI.DeleteFileResponse

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureErrorResponse

Unduh file

GET {endpoint}/openai/v1/files/{file_id}/content?api-version=preview

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	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.
file_id	path	Yes	string	ID file yang akan digunakan untuk permintaan ini.

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: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/octet-stream	string

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureErrorResponse

Rungrader

POST {endpoint}/openai/v1/fine_tuning/alpha/graders/run?api-version=preview

Jalankan grader.

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	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.

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
Grader	objek	Objek StringCheckGrader yang melakukan perbandingan string antara input dan referensi menggunakan operasi tertentu.	Yes
└─ calculate_output (menghitung_output)	string	Rumus untuk menghitung output berdasarkan hasil grader.	Tidak.
└─ metrik_penilaian	enum	Metrik evaluasi yang akan digunakan. Salah satu dari fuzzy_match, , bleugleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5, atau rouge_l. Nilai yang mungkin: fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5, rouge_l	Tidak.
└─ siswa kelas	objek		Tidak.
└─ tag gambar	string	Tag gambar yang digunakan untuk skrip python.	Tidak.
└─ masukan	array	Teks input. Ini mungkin termasuk string templat.	Tidak.
└─ model	string	Model yang digunakan untuk evaluasi.	Tidak.
└─ nama	string	Nama penilai.	Tidak.
└─ operasi	enum	Operasi pemeriksaan string yang perlu dilakukan. Salah satu dari eq, ne, like, atau ilike. Nilai yang mungkin: eq, ne, like, ilike	Tidak.
└─ rentang	array	Rentang skor. Secara default menjadi [0, 1].	Tidak.
└─ referensi	string	Teks yang sedang dinilai.	Tidak.
└─ parameter_pengambilan_sampel		Parameter pengambilan sampel untuk model.	Tidak.
└─ sumber	string	Kode sumber skrip python.	Tidak.
└─ jenis	enum	Tipe objek, yang selalu multi. Nilai yang mungkin: multi	Tidak.
item		Item himpunan data yang disediakan untuk grader. Ini akan digunakan untuk mengisi item namespace.	Tidak.
model_sample	string	Sampel model yang akan dievaluasi. Nilai ini akan digunakan untuk mengisi sample namespace. Variabel output_json akan diisi jika sampel model adalah string JSON yang valid.	Yes

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	OpenAI.RunGraderResponse

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureErrorResponse

Memvalidasi grader

POST {endpoint}/openai/v1/fine_tuning/alpha/graders/validate?api-version=preview

Memvalidasi grader.

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	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.

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
Grader	objek	Objek StringCheckGrader yang melakukan perbandingan string antara input dan referensi menggunakan operasi tertentu.	Yes
└─ calculate_output (menghitung_output)	string	Rumus untuk menghitung output berdasarkan hasil grader.	Tidak.
└─ metrik_penilaian	enum	Metrik evaluasi yang akan digunakan. Salah satu dari fuzzy_match, , bleugleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5, atau rouge_l. Nilai yang mungkin: fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5, rouge_l	Tidak.
└─ siswa kelas	objek		Tidak.
└─ tag gambar	string	Tag gambar yang digunakan untuk skrip python.	Tidak.
└─ masukan	array	Teks input. Ini mungkin termasuk string templat.	Tidak.
└─ model	string	Model yang digunakan untuk evaluasi.	Tidak.
└─ nama	string	Nama penilai.	Tidak.
└─ operasi	enum	Operasi pemeriksaan string yang perlu dilakukan. Salah satu dari eq, ne, like, atau ilike. Nilai yang mungkin: eq, ne, like, ilike	Tidak.
└─ rentang	array	Rentang skor. Secara default menjadi [0, 1].	Tidak.
└─ referensi	string	Teks yang sedang dinilai.	Tidak.
└─ parameter_pengambilan_sampel		Parameter pengambilan sampel untuk model.	Tidak.
└─ sumber	string	Kode sumber skrip python.	Tidak.
└─ jenis	enum	Tipe objek, yang selalu multi. Nilai yang mungkin: multi	Tidak.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	OpenAI.ValidateGraderResponse

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureErrorResponse

Membuat pekerjaan penyempurnaan

POST {endpoint}/openai/v1/fine_tuning/jobs?api-version=preview

Membuat pekerjaan penyempurnaan yang memulai proses pembuatan model baru dari himpunan data tertentu.

Respons mencakup detail pekerjaan yang diantrekan termasuk status pekerjaan dan nama model yang disempurnakan setelah selesai.

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	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.

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
hyperparameter	objek	Hyperparameter yang digunakan untuk pekerjaan penyempurnaan. Nilai ini sekarang tidak digunakan lagi demi method, dan harus diteruskan di bawah method parameter .	Tidak.
└─ batch_size	enum	Nilai yang mungkin: auto	Tidak.
└─ pengali_kecepatan_pembelajaran	enum	Nilai yang mungkin: auto	Tidak.
└─ n_epochs	enum	Nilai yang mungkin: auto	Tidak.
integrasi	array	Daftar integrasi yang akan diaktifkan untuk pekerjaan penyempurnaan Anda.	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, dan mengkueri objek melalui API atau dasbor. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter.	Tidak.
metode	OpenAI.FineTuneMethod	Metode yang digunakan untuk penyempurnaan.	Tidak.
model	string (lihat model yang valid di bawah)	Nama model untuk menyempurnakan.	Yes
seed	bilangan bulat	Seed mengendalikan reproduksibilitas tugas. Menggunakan seed dan parameter pekerjaan yang sama seharusnya menghasilkan hasil yang sama, tetapi mungkin berbeda dalam kasus yang jarang terjadi. Jika benih tidak ditentukan, satu akan dihasilkan untuk Anda.	Tidak.
Akhiran	string	String hingga 64 karakter yang akan ditambahkan ke nama model yang disempurnakan. Misalnya, suffix "custom-model-name" akan menghasilkan nama model seperti ft:gpt-4o-mini:openai:custom-model-name:7p4lURel.	Tidak.	Tidak ada
file_pelatihan	string	ID file yang diunggah yang berisi data pelatihan. Himpunan data Anda harus diformat sebagai file JSONL. Selain itu, Anda harus mengunggah file Anda dengan tujuan fine-tune. Konten file harus berbeda tergantung pada apakah model menggunakan format obrolan, penyelesaian, atau jika metode penyempurnaan menggunakan format preferensi.	Yes
validation_file	string	ID file yang diunggah yang berisi data validasi. Jika Anda menyediakan file ini, data digunakan untuk menghasilkan metrik validasi secara berkala selama penyempurnaan. Metrik ini dapat dilihat dalam file hasil penyempurnaan. Data yang sama tidak boleh ada dalam file pelatihan dan validasi. Himpunan data Anda harus diformat sebagai file JSONL. Anda harus mengunggah file Anda dengan tujuan fine-tune.	Tidak.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	OpenAI.FineTuningJob

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureErrorResponse

Mencantumkan pekerjaan penyempurnaan yang dipaginasi

GET {endpoint}/openai/v1/fine_tuning/jobs?api-version=preview

Mencantumkan pekerjaan penyempurnaan organisasi Anda

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	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.
after	kueri	Tidak.	string	Pengidentifikasi untuk pekerjaan terakhir dari permintaan penomoran halaman sebelumnya.
limit	kueri	Tidak.	bilangan bulat	Jumlah pekerjaan penyempurnaan yang akan diambil.

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: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	OpenAI.ListPaginatedFineTuningJobsResponse

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureErrorResponse

Mengambil pekerjaan penyempurnaan

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}?api-version=preview

Dapatkan info tentang pekerjaan penyempurnaan.

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	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.
ID_pekerjaan_penyesuaian	path	Yes	string	ID pekerjaan penyempurnaan.

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: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	OpenAI.FineTuningJob

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureErrorResponse

Membatalkan pekerjaan penyempurnaan

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/cancel?api-version=preview

Segera batalkan pekerjaan yang menyempurnakan.

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	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.
ID_pekerjaan_penyesuaian	path	Yes	string	ID pekerjaan penyempurnaan untuk dibatalkan.

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: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	OpenAI.FineTuningJob

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureErrorResponse

Mencantumkan titik pemeriksaan pekerjaan penyempurnaan

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints?api-version=preview

Cantumkan titik pemeriksaan untuk pekerjaan penyempurnaan.

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	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.
ID_pekerjaan_penyesuaian	path	Yes	string	ID pekerjaan penyempurnaan untuk mendapatkan titik pemeriksaan.
after	kueri	Tidak.	string	Pengidentifikasi untuk ID titik pemeriksaan terakhir dari permintaan penomoran halaman sebelumnya.
limit	kueri	Tidak.	bilangan bulat	Jumlah titik pemeriksaan yang akan diambil.

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: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	OpenAI.ListFineTuningJobCheckpointsResponse

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureErrorResponse

Mencantumkan peristiwa penyempurnaan

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/events?api-version=preview

Dapatkan pembaruan status untuk pekerjaan penyempurnaan.

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	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.
ID_pekerjaan_penyesuaian	path	Yes	string	ID pekerjaan penyempurnaan untuk mendapatkan peristiwa.
after	kueri	Tidak.	string	Pengidentifikasi untuk peristiwa terakhir dari permintaan penomoran halaman sebelumnya.
limit	kueri	Tidak.	bilangan bulat	Jumlah peristiwa yang akan diambil.

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: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	OpenAI.ListFineTuningJobEventsResponse

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureErrorResponse

Menjeda pekerjaan penyempurnaan

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/pause?api-version=preview

Jeda pekerjaan yang menyempurnakan.

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	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.
ID_pekerjaan_penyesuaian	path	Yes	string	ID pekerjaan penyempurnaan untuk dijeda.

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: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	OpenAI.FineTuningJob

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureErrorResponse

Melanjutkan pekerjaan penyempurnaan

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/resume?api-version=preview

Lanjutkan pekerjaan yang dijeda yang disempurnakan.

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	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.
ID_pekerjaan_penyesuaian	path	Yes	string	ID pekerjaan penyempurnaan untuk dilanjutkan.

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: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	OpenAI.FineTuningJob

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureErrorResponse

Membuat pengeditan gambar

POST {endpoint}/openai/v1/images/edits?api-version=preview

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	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.

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
latar belakang	enum	Memungkinkan untuk mengatur transparansi untuk latar belakang gambar yang dihasilkan. Parameter ini hanya didukung untuk gpt-image-1model seri. Harus salah satu dari transparent, opaque atau auto (nilai default). Ketika auto digunakan, model akan secara otomatis menentukan latar belakang terbaik untuk gambar. Jika transparent, format output perlu mendukung transparansi, sehingga harus diatur ke png (nilai default) atau webp. Nilai yang mungkin: transparent, opaque, auto	Tidak.
citra	string atau array		Yes
masker	string		Tidak.
model	string	Penyebaran model yang digunakan untuk operasi pengeditan gambar.	Yes
n	bilangan bulat	Jumlah gambar yang akan dihasilkan. Harus antara 1 dan 10.	Tidak.	1
kompresi keluaran	bilangan bulat	Tingkat kompresi (0-100%) untuk gambar yang dihasilkan. Parameter ini hanya didukung untuk model-model seri gpt-image-1 dengan format output webp atau jpeg, dan nilai defaultnya adalah 100.	Tidak.	100
format keluaran	enum	Format di mana gambar yang dihasilkan dikembalikan. Parameter ini hanya didukung untuk gpt-image-1model seri. Harus salah satu dari png, , jpegatau webp. Nilai defaultnya adalah png. Nilai yang mungkin: png, jpeg, webp	Tidak.
minta	string	Deskripsi teks gambar yang diinginkan. Panjang maksimum adalah 1000 karakter untuk dall-e-2, dan 32000 karakter untuk gpt-image-1model seri.	Yes
kualitas	enum	Kualitas gambar yang akan dihasilkan. high, medium dan low hanya didukung untuk gpt-image-1model seri. dall-e-2 hanya mendukung kualitas standard. Secara default menjadi auto. Nilai yang mungkin: standard, , lowmedium, high,auto	Tidak.
response_format	enum	Format di mana gambar yang dihasilkan dikembalikan. Harus salah satu dari url atau b64_json. URL hanya berlaku selama 60 menit setelah gambar dibuat. Parameter ini hanya didukung untuk dall-e-2, karena gpt-image-1model seri akan selalu mengembalikan gambar yang dikodekan base64. Nilai yang mungkin: url, b64_json	Tidak.
ukuran	enum	Ukuran gambar yang dihasilkan. Harus salah satu dari 1024x1024, 1536x1024 (lanskap), 1024x1536 (potret), atau auto (nilai default) untuk model seri gpt-image-1, dan salah satu dari 256x256, 512x512, atau 1024x1024 untuk dall-e-2. Nilai yang mungkin: 256x256, , 512x5121024x1024, 1536x1024, 1024x1536,auto	Tidak.
pengguna	string	Pengidentifikasi unik yang mewakili pengguna akhir Anda, yang dapat membantu OpenAI memantau dan mendeteksi penyalahgunaan.	Tidak.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	AzureImagesResponse

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureErrorResponse

Createimage

POST {endpoint}/openai/v1/images/generations?api-version=preview

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	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.

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	enum	Memungkinkan untuk mengatur transparansi untuk latar belakang gambar yang dihasilkan. Parameter ini hanya didukung untuk gpt-image-1model seri. Harus salah satu dari transparent, opaque atau auto (nilai default). Ketika auto digunakan, model akan secara otomatis menentukan latar belakang terbaik untuk gambar. Jika transparent, format output perlu mendukung transparansi, sehingga harus diatur ke png (nilai default) atau webp. Nilai yang mungkin: transparent, opaque, auto	Tidak.
model	string	Penyebaran model yang digunakan untuk pembuatan gambar.	Yes
moderation	enum	Kontrol tingkat moderasi konten untuk gambar yang dihasilkan oleh gpt-image-1model seri. Harus berupa low untuk pemfilteran yang kurang ketat atau auto (nilai default). Nilai yang mungkin: low, auto	Tidak.
n	bilangan bulat	Jumlah gambar yang akan dihasilkan. Harus antara 1 dan 10. Untuk dall-e-3, hanya n=1 didukung.	Tidak.	1
kompresi keluaran	bilangan bulat	Tingkat kompresi (0-100%) untuk gambar yang dihasilkan. Parameter ini hanya didukung untuk model-model seri gpt-image-1 dengan format output webp atau jpeg, dan nilai defaultnya adalah 100.	Tidak.	100
format keluaran	enum	Format di mana gambar yang dihasilkan dikembalikan. Parameter ini hanya didukung untuk gpt-image-1model seri. Harus salah satu dari png, , jpegatau webp. Nilai yang mungkin: png, jpeg, webp	Tidak.
minta	string	Deskripsi teks gambar yang diinginkan. Panjang maksimum adalah 32000 karakter untuk gpt-image-1model seri, 1000 karakter untuk dall-e-2 dan 4000 karakter untuk dall-e-3.	Yes
kualitas	enum	Kualitas gambar yang akan dihasilkan. - auto (nilai default) akan secara otomatis memilih kualitas terbaik untuk model yang diberikan. - high, medium dan low didukung untuk seri gpt-image-1. - hd dan standard didukung untuk dall-e-3. - standard adalah satu-satunya opsi untuk dall-e-2. Nilai yang mungkin: standard, , hdlow, medium, high,auto	Tidak.
response_format	enum	Format di mana gambar yang dihasilkan dengan dall-e-2 dan dall-e-3 dikembalikan. Harus salah satu dari url atau b64_json. URL hanya berlaku selama 60 menit setelah gambar dibuat. Parameter ini tidak didukung untuk gpt-image-1model seri yang akan selalu mengembalikan gambar yang dikodekan base64. Nilai yang mungkin: url, b64_json	Tidak.
ukuran	enum	Ukuran gambar yang dihasilkan. Harus salah satu dari 1024x1024, 1536x1024 (lanskap), 1024x1536 (potret), atau auto (nilai default) untuk model seri gpt-image-1, salah satu dari 256x256, 512x512, atau 1024x1024 untuk dall-e-2, dan salah satu dari 1024x1024, 1792x1024, atau 1024x1792 untuk dall-e-3. Nilai yang mungkin: auto, , 1024x10241536x1024, 1024x1536, 256x256, 512x512, , 1792x10241024x1792	Tidak.
gaya	enum	Gaya gambar yang dihasilkan. Parameter ini hanya didukung untuk dall-e-3. Harus salah satu dari vivid atau natural. Vivid menyebabkan model cenderung untuk menghasilkan citra hiper-realistis dan dramatis. Alami menyebabkan model menghasilkan gambar yang terlihat lebih alami dan kurang hiper-realistis. Nilai yang mungkin: vivid, natural	Tidak.
pengguna	string	Pengidentifikasi unik yang mewakili pengguna akhir Anda, yang dapat membantu OpenAI memantau dan mendeteksi penyalahgunaan.	Tidak.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	AzureImagesResponse

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureErrorResponse

Contoh

Contoh

Membuat gambar yang diberi perintah.

POST {endpoint}/openai/v1/images/generations?api-version=preview

{
 "model": "dall-e-3",
 "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
          }
        }
      }
    ]
  }
}

Mencantumkan model

GET {endpoint}/openai/v1/models?api-version=preview

Mencantumkan model yang saat ini tersedia, dan menyediakan informasi dasar tentang masing-masing model seperti pemilik dan ketersediaan.

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	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.

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: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	OpenAI.ListModelsResponse

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureErrorResponse

Mengambil model

GET {endpoint}/openai/v1/models/{model}?api-version=preview

Mengambil instans model, memberikan informasi dasar tentang model seperti pemilik dan izin.

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	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.
model	path	Yes	string	ID model yang digunakan untuk permintaan ini.

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: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	OpenAI.Model

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureErrorResponse

Membuat respons

POST {endpoint}/openai/v1/responses?api-version=preview

Membuat tanggapan berdasarkan model.

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	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.

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	Boolean	Apakah akan menjalankan respons model di latar belakang.	Tidak.	False
termasuk	array	Tentukan data output tambahan untuk disertakan dalam respons model. Nilai yang saat ini didukung adalah: - code_interpreter_call.outputs: Menyertakan output eksekusi kode python dalam item panggilan alat penerjemah kode. - computer_call_output.output.image_url: Sertakan url gambar dari output panggilan komputer. - file_search_call.results: Sertakan hasil pencarian dari alat pencari file. - message.input_image.image_url: Sertakan url gambar dari pesan input. - message.output_text.logprobs: Sertakan logprobs dengan pesan asisten. - reasoning.encrypted_content: Menyertakan versi terenkripsi dari token penalaran dalam output item penalaran. Ini memungkinkan item penalaran digunakan dalam percakapan berkelanjutan saat menggunakan API Respons tanpa status (seperti ketika parameter store diatur ke false, atau ketika organisasi terdaftar dalam program tanpa retensi data).	Tidak.
Masukan	string atau array		Tidak.
instructions	string	Pesan sistem (atau pengembang) dimasukkan ke 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 yang terlihat dan token penalaran	Tidak.
max_tool_calls	bilangan bulat	Jumlah maksimum total panggilan ke alat bawaan yang dapat diproses dalam respons. Jumlah maksimum ini berlaku di semua panggilan alat bawaan, bukan per alat individual. Setiap upaya lebih lanjut untuk memanggil alat oleh model akan diabaikan.	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, 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	Penyebaran model yang digunakan untuk pembuatan respons ini.	Yes
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.
minta	objek	Referensi ke templat perintah dan variabelnya.	Tidak.
└─ ID	string	Pengidentifikasi unik templat perintah yang akan digunakan.	Tidak.
└─ variabel	OpenAI.ResponsePromptVariables	Peta nilai opsional untuk mengganti variabel dalam perintah Anda. Nilai substitusi dapat berupa string, atau jenis input respons lainnya seperti gambar atau file.	Tidak.
└─ versi	string	Versi opsional templat prompt.	Tidak.
reasoning	objek	model seri o saja Opsi konfigurasi untuk model penalaran.	Tidak.
└─ usaha	OpenAI.ReasoningEffort	model seri o 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.	Tidak.
└─ menghasilkan_ringkasan	enum	Tidak digunakan lagi: gunakan summary sebagai gantinya. Ringkasan penalaran yang dilakukan oleh model. Ini dapat berguna untuk men-debug dan memahami proses penalaran model. Salah satu dari auto, concise, atau detailed. Nilai yang mungkin: auto, concise, detailed	Tidak.
└─ ringkasan	enum	Ringkasan penalaran yang dilakukan oleh model. Ini dapat berguna untuk men-debug dan memahami proses penalaran model. Salah satu dari auto, concise, atau detailed. Nilai yang mungkin: auto, concise, detailed	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
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
kirim pesan teks	objek	Opsi konfigurasi untuk respons teks dari model. Dapat berupa teks biasa atau data JSON terstruktur.	Tidak.
└─ bentuk	OpenAI.ResponseTextFormatConfiguration		Tidak.
tool_choice	objek	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.	Tidak.
└─ jenis	OpenAI.ToolChoiceObjectType	Menunjukkan bahwa model harus menggunakan alat bawaan untuk menghasilkan respons.	Tidak.
perangkat	array	Sekumpulan alat yang dapat dipanggil model ketika menghasilkan respons. Kamu 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, seperti pencarian file. - Panggilan fungsi (alat kustom): Fungsi yang ditentukan oleh Anda, memungkinkan model untuk memanggil kode Anda sendiri.	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.	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
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.
pengguna	string	Pengidentifikasi unik yang mewakili pengguna akhir Anda, yang dapat membantu OpenAI memantau dan mendeteksi penyalahgunaan.	Tidak.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	AzureResponse
text/event-stream	OpenAI.ResponseStreamEvent

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureErrorResponse

Contoh

Contoh

Membuat respons model

POST {endpoint}/openai/v1/responses?api-version=preview

Dapatkan respons

GET {endpoint}/openai/v1/responses/{response_id}?api-version=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
versi-API	kueri	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.
response_id	path	Yes	string
include[]	kueri	Tidak.	array

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: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	AzureResponse

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureErrorResponse

Hapus tanggapan

DELETE {endpoint}/openai/v1/responses/{response_id}?api-version=preview

Menghapus respons berdasarkan ID.

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	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.
response_id	path	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: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	objek

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureErrorResponse

Mencantumkan item input

GET {endpoint}/openai/v1/responses/{response_id}/input_items?api-version=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
versi-API	kueri	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.
response_id	path	Yes	string
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 dandesc 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. Sebagai contoh, jika Anda membuat permintaan untuk daftar dan menerima 100 objek yang diakhiri dengan obj_foo, panggilan berikutnya dapat menyertakan before=obj_foo agar dapat mengambil halaman sebelumnya dari daftar tersebut.

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: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	OpenAI.ResponseItemList

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureErrorResponse

Mencantumkan penyimpanan vektor

GET {endpoint}/openai/v1/vector_stores?api-version=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
versi-API	kueri	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.
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 dandesc 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. Sebagai contoh, jika Anda membuat permintaan untuk daftar dan menerima 100 objek yang diakhiri dengan obj_foo, panggilan berikutnya dapat menyertakan before=obj_foo agar dapat mengambil halaman sebelumnya dari daftar tersebut.

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: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	OpenAI.ListVectorStoresResponse

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureErrorResponse

Membuat penyimpanan vektor

POST {endpoint}/openai/v1/vector_stores?api-version=preview

Membuat 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	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.

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	objek	Strategi default. Strategi ini saat ini menggunakan max_chunk_size_tokens dari 800 dan chunk_overlap_tokens dari 400.	Tidak.
└─ statis	OpenAI.StaticChunkingStrategy		Tidak.
└─ jenis	enum	Selalu static. Nilai yang mungkin: static	Tidak.
kedaluwarsa_setelah	OpenAI.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, dan mengkueri objek melalui API atau dasbor. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter.	Tidak.
Nama	string	Nama toko vektor.	Tidak.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	OpenAI.VectorStoreObject

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureErrorResponse

Contoh

Contoh file tidak ditemukan: ./examples/vector_stores.json

Dapatkan penyimpanan vektor

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}?api-version=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
versi-API	kueri	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.
vector_store_id	path	Yes	string	ID penyimpanan vektor yang akan diambil.

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: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	OpenAI.VectorStoreObject

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureErrorResponse

Mengubah penyimpanan vektor

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}?api-version=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
versi-API	kueri	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.
vector_store_id	path	Yes	string	ID penyimpanan vektor untuk dimodifikasi.

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	objek	Kebijakan kedaluwarsa untuk penyimpanan vektor.	Tidak.
└─ jangkar	enum	Tanda waktu jangkar setelah kebijakan kedaluwarsa berlaku. Jangkar yang didukung: last_active_at. Nilai yang mungkin: last_active_at	Tidak.
└─ hari	bilangan bulat	Jumlah hari setelah waktu jangkar penyimpanan vektor akan kedaluwarsa.	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, dan mengkueri objek melalui API atau dasbor. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter.	Tidak.
Nama	string	Nama toko vektor.	Tidak.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	OpenAI.VectorStoreObject

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureErrorResponse

Menghapus penyimpanan vektor

DELETE {endpoint}/openai/v1/vector_stores/{vector_store_id}?api-version=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
versi-API	kueri	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.
vector_store_id	path	Yes	string	ID penyimpanan vektor yang akan 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: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	OpenAI.DeleteVectorStoreResponse

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureErrorResponse

Membuat batch file penyimpanan vektor

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches?api-version=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
versi-API	kueri	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.
vector_store_id	path	Yes	string	ID penyimpanan vektor untuk membuat batch 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

Isi Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan	Default
attributes	objek	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.
chunking_strategy	OpenAI.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: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	OpenAI.VectorStoreFileBatchObject

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureErrorResponse

Mendapatkan batch file penyimpanan vektor

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=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
versi-API	kueri	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.
vector_store_id	path	Yes	string	ID penyimpanan vektor tempat batch file berada.
batch_id	path	Yes	string	ID batch file yang sedang diambil.

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: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	OpenAI.VectorStoreFileBatchObject

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureErrorResponse

Batalkan batch file penyimpanan vektor

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel?api-version=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
versi-API	kueri	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.
vector_store_id	path	Yes	string	ID penyimpanan vektor tempat batch file berada.
batch_id	path	Yes	string	ID batch file yang akan dibatalkan.

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: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	OpenAI.VectorStoreFileBatchObject

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureErrorResponse

Mencantumkan file dalam batch penyimpanan vektor

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=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
versi-API	kueri	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.
vector_store_id	path	Yes	string	ID penyimpanan vektor tempat batch 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 dandesc 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. Sebagai contoh, jika Anda membuat permintaan untuk daftar dan menerima 100 objek yang diakhiri dengan obj_foo, panggilan berikutnya dapat menyertakan before=obj_foo agar dapat mengambil halaman sebelumnya dari daftar tersebut.
filter	kueri	Tidak.		Filter menurut status file. Salah satu dari in_progress, completed, failed, cancelled.

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: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	OpenAI.ListVectorStoreFilesResponse

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureErrorResponse

Mencantumkan file penyimpanan vektor

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/files?api-version=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
versi-API	kueri	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.
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 dandesc 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. Sebagai contoh, jika Anda membuat permintaan untuk daftar dan menerima 100 objek yang diakhiri dengan obj_foo, panggilan berikutnya dapat menyertakan before=obj_foo agar dapat mengambil halaman sebelumnya dari daftar tersebut.
filter	kueri	Tidak.		Filter menurut status file. Salah satu dari in_progress, completed, failed, cancelled.

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: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	OpenAI.ListVectorStoreFilesResponse

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureErrorResponse

Membuat file penyimpanan vektor

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/files?api-version=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
versi-API	kueri	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.
vector_store_id	path	Yes	string	ID penyimpanan vektor yang digunakan untuk membuat berkas.

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	objek	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.
chunking_strategy	OpenAI.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: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	OpenAI.VectorStoreFileObject

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureErrorResponse

Mendapatkan file penyimpanan vektor

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/files/{file_id}?api-version=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
versi-API	kueri	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.
vector_store_id	path	Yes	string	ID penyimpanan vektor tempat file berada.
file_id	path	Yes	string	ID file yang diambil.

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: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	OpenAI.VectorStoreFileObject

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureErrorResponse

Memperbarui atribut file penyimpanan vektor

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/files/{file_id}?api-version=preview

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	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.
vector_store_id	path	Yes	string
file_id	path	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
attributes	objek	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: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	OpenAI.VectorStoreFileObject

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureErrorResponse

Menghapus file penyimpanan vektor

DELETE {endpoint}/openai/v1/vector_stores/{vector_store_id}/files/{file_id}?api-version=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
versi-API	kueri	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.
vector_store_id	path	Yes	string	ID penyimpanan vektor tempat file berada.
file_id	path	Yes	string	ID file yang akan 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: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	OpenAI.DeleteVectorStoreFileResponse

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureErrorResponse

Tugas pembuatan video - Buatlah

POST {endpoint}/openai/v1/video/generations/jobs?api-version=preview

Membuat pekerjaan pembuatan video baru.

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	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.

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
height	bilangan bulat	Tinggi video. Dimensi berikut didukung: 480x480, 854x480, 720x720, 1280x720, 1080x1080 dan 1920x1080 dalam orientasi lanskap dan potret.	Yes
model	string	Nama penyebaran yang akan digunakan untuk permintaan ini.	Yes
n_seconds	bilangan bulat	Durasi pekerjaan pembuatan video. Harus antara 1 dan 20 detik.	Tidak.	5
n_variants	bilangan bulat	Jumlah video yang akan dibuat sebagai varian untuk pekerjaan ini. Harus antara 1 dan 5. Dimensi yang lebih kecil memungkinkan lebih banyak varian.	Tidak.	1
minta	string	Arahan untuk pekerjaan pembuatan video ini.	Yes
width	bilangan bulat	Lebar dari video. Dimensi berikut didukung: 480x480, 854x480, 720x720, 1280x720, 1080x1080 dan 1920x1080 dalam orientasi lanskap dan potret.	Yes

Isi Permintaan

Tipe Konten: multipart/form-data

Nama	Tipe	Deskripsi	Diperlukan	Default
files	array		Yes
height	bilangan bulat	Tinggi video. Dimensi berikut didukung: 480x480, 854x480, 720x720, 1280x720, 1080x1080 dan 1920x1080 dalam orientasi lanskap dan potret.	Yes
inpaint_items	array	Item inpainting opsional untuk pekerjaan pembuatan video ini.	Tidak.
model	string	Nama penyebaran yang akan digunakan untuk permintaan ini.	Yes
n_seconds	bilangan bulat	Durasi pekerjaan pembuatan video. Harus antara 1 dan 20 detik.	Tidak.	5
n_variants	bilangan bulat	Jumlah video yang akan dibuat sebagai varian untuk pekerjaan ini. Harus antara 1 dan 5. Dimensi yang lebih kecil memungkinkan lebih banyak varian.	Tidak.	1
minta	string	Arahan untuk pekerjaan pembuatan video ini.	Yes
width	bilangan bulat	Lebar dari video. Dimensi berikut didukung: 480x480, 854x480, 720x720, 1280x720, 1080x1080 dan 1920x1080 dalam orientasi lanskap dan potret.	Yes

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	VideoGenerationJob

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureOpenAIVideoGenerationErrorResponse

Contoh

Contoh file tidak ditemukan: ./examples/create_video_generation_job_simple.json

Pekerjaan pembuatan video - Daftar

GET {endpoint}/openai/v1/video/generations/jobs?api-version=preview

Mencantumkan pekerjaan pembuatan video.

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	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.
sebelum	kueri	Tidak.	string
after	kueri	Tidak.	string
limit	kueri	Yes	bilangan bulat
statuses	kueri	Tidak.	array

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: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	VideoGenerationJobList

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureOpenAIVideoGenerationErrorResponse

Contoh

Contoh file tidak ditemukan: ./examples/get_video_generation_job_list.json

Pekerjaan pembuatan video - Dapatkan

GET {endpoint}/openai/v1/video/generations/jobs/{job-id}?api-version=preview

Mengambil properti pekerjaan pembuatan video.

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	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.
job-id	path	Yes	string	ID pekerjaan pembuatan video yang akan digunakan untuk permintaan OpenAI Azure.

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: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	VideoGenerationJob

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureOpenAIVideoGenerationErrorResponse

Contoh

Contoh file tidak ditemukan: ./examples/get_video_generation_job.json

Pekerjaan pembuatan video - Hapus

DELETE {endpoint}/openai/v1/video/generations/jobs/{job-id}?api-version=preview

Menghapus pekerjaan pembuatan video.

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	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.
job-id	path	Yes	string	ID pekerjaan pembuatan video yang akan digunakan untuk permintaan OpenAI Azure.

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

Deskripsi: Tidak ada konten untuk dikirim untuk permintaan ini, tetapi header mungkin berguna.

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureOpenAIVideoGenerationErrorResponse

Generasi video - Dapatkan

GET {endpoint}/openai/v1/video/generations/{generation-id}?api-version=preview

Mengambil pembuatan video berdasarkan ID.

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	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.
generation-id	path	Yes	string	ID pembuatan video yang akan digunakan untuk permintaan OpenAI Azure.

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: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	VideoGeneration

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureOpenAIVideoGenerationErrorResponse

Contoh

Contoh file tidak ditemukan: ./examples/get_video_generation.json

Pembuatan video - Ambil gambar mini

GET {endpoint}/openai/v1/video/generations/{generation-id}/content/thumbnail?api-version=preview

Mengambil gambar mini konten video yang dihasilkan.

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	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.
generation-id	path	Yes	string	ID pembuatan video yang akan digunakan untuk permintaan OpenAI Azure.

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: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
gambar/jpg	string

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureOpenAIVideoGenerationErrorResponse

Pembuatan video - Mengambil konten video

GET {endpoint}/openai/v1/video/generations/{generation-id}/content/video?api-version=preview

Mengambil konten video yang dihasilkan.

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	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.
generation-id	path	Yes	string	ID pembuatan video yang akan digunakan untuk permintaan OpenAI Azure.
kualitas	kueri	Tidak.

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: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
video/mp4	string

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureOpenAIVideoGenerationErrorResponse

Pembuatan video - Hanya mengambil header videocontent

HEAD {endpoint}/openai/v1/video/generations/{generation-id}/content/video?api-version=preview

Mengambil header untuk konten video yang dihasilkan.

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	Tidak.		Versi eksplisit dari API Model Foundry yang akan digunakan untuk permintaan ini. v1 jika tidak ditentukan lain.
generation-id	path	Yes	string	ID pembuatan video yang akan digunakan untuk permintaan OpenAI Azure.
kualitas	kueri	Tidak.

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: Permintaan telah berhasil.

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	AzureOpenAIVideoGenerationErrorResponse

Komponen

AudioTaskLabel

Menentukan kemungkinan deskriptor untuk respons operasi audio yang tersedia.

Harta benda	Nilai
Deskripsi	Menentukan kemungkinan deskriptor untuk respons operasi audio yang tersedia.
Jenis	string
Nilai	transcribe translate

AudioTranslationSegment

Informasi yang diperluas tentang satu segmen data audio yang diterjemahkan. Segmen umumnya mewakili kira-kira 5-10 detik ucapan. Batas segmen biasanya terjadi di antara kata tetapi belum tentu kalimat.

Nama	Tipe	Deskripsi	Diperlukan	Default
avg_logprob	nomor/angka	Probabilitas log rata-rata yang terkait dengan segmen audio ini.	Yes
compression_ratio	nomor/angka	Rasio kompresi segmen audio ini.	Yes
akhir	nomor/angka	Waktu di mana segmen ini berakhir relatif terhadap awal audio yang diterjemahkan.	Yes
id	bilangan bulat	Indeks berbasis 0 dari segmen ini dalam terjemahan.	Yes
no_speech_prob	nomor/angka	Probabilitas tidak ada deteksi ucapan dalam segmen audio ini.	Yes
seek	bilangan bulat	Posisi pencarian yang terkait dengan pemrosesan segmen audio ini. Posisi pencarian dinyatakan sebagai seratus detik. Model dapat memproses beberapa segmen dari satu posisi pencarian, jadi sementara posisi pencarian tidak akan pernah mewakili waktu yang lebih baru daripada awal segmen, awal segmen dapat mewakili waktu yang jauh lebih lambat daripada posisi pencarian terkait segmen.	Yes
mulai	nomor/angka	Waktu saat segmen ini mulai relatif terhadap awal audio yang diterjemahkan.	Yes
suhu	nomor/angka	Skor suhu yang terkait dengan segmen audio ini.	Yes
kirim pesan teks	string	Teks terjemahan yang merupakan bagian dari segmen audio ini.	Yes
tokens	array	ID token yang cocok dengan teks yang diterjemahkan dalam segmen audio ini.	Yes

AzureAIFoundryModelsApiVersion

Harta benda	Nilai
Jenis	string
Nilai	v1 preview

AzureAudioTranscriptionResponse

Informasi hasil untuk operasi yang mentranskripsikan audio lisan ke dalam teks tertulis.

Nama	Tipe	Deskripsi	Diperlukan	Default
duration	nomor/angka	Total durasi audio yang diproses untuk menghasilkan informasi transkripsi yang menyertainya.	Tidak.
bahasa	string	Bahasa lisan yang terdeteksi dalam data audio yang ditranskripsikan. Ini dinyatakan sebagai kode bahasa ISO-639-1 dua huruf seperti 'en' atau 'fr'.	Tidak.
segments	array	Kumpulan informasi tentang waktu, probabilitas, dan detail lainnya dari setiap segmen audio yang diproses.	Tidak.
tugas	objek	Menentukan kemungkinan deskriptor untuk respons operasi audio yang tersedia.	Tidak.
kirim pesan teks	string	Teks hasil transkripsi untuk data audio yang diberikan.	Yes
words	array	Kumpulan informasi tentang waktu setiap kata yang diproses.	Tidak.

AzureAudioTranslationResponse

Informasi hasil untuk operasi yang menerjemahkan audio lisan ke dalam teks tertulis.

Nama	Tipe	Deskripsi	Diperlukan	Default
duration	nomor/angka	Total durasi audio yang diproses untuk menghasilkan informasi terjemahan yang menyertainya.	Tidak.
bahasa	string	Bahasa lisan yang terdeteksi dalam data audio yang diterjemahkan. Ini dinyatakan sebagai kode bahasa ISO-639-1 dua huruf seperti 'en' atau 'fr'.	Tidak.
segments	array	Kumpulan informasi tentang waktu, probabilitas, dan detail lainnya dari setiap segmen audio yang diproses.	Tidak.
tugas	objek	Menentukan kemungkinan deskriptor untuk respons operasi audio yang tersedia.	Tidak.
kirim pesan teks	string	Teks yang diterjemahkan untuk data audio yang disediakan.	Yes

AzureChatCompletionResponseMessage

Komponen model respons yang diperluas untuk pesan respons penyelesaian obrolan pada Azure OpenAI service. Model ini menambahkan dukungan untuk konteks pesan obrolan, yang digunakan oleh fitur "On Your Data" untuk niat, kutipan, dan informasi lain yang terkait dengan generasi yang ditingkatkan oleh pengambilan data.

Nama	Tipe	Deskripsi	Diperlukan	Default
Anotasi	array	Anotasi untuk pesan, jika berlaku, seperti saat menggunakan alat pencarian web.	Tidak.
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	objek	Properti tambahan, ditambahkan ke pesan respons penyelesaian obrolan, yang diproduksi oleh Azure OpenAI service saat menggunakan perilaku ekstensi. Ini termasuk informasi niat dan kutipan dari fitur On Your Data.	Tidak.
└─ semua_dokumen_yang_diambil	objek	Informasi ringkasan tentang dokumen yang diambil oleh operasi pengambilan data.	Tidak.
└─ chunk_id	string	ID gugus untuk kutipan.	Tidak.
└─ konten	string	Isi kutipan.	Tidak.
└─ indeks_sumber_data	bilangan bulat	Indeks sumber data yang digunakan untuk pengambilan.	Tidak.
└─ jalur file	string	Jalur berkas untuk kutipan.	Tidak.
└─ alasan_penyaringan	enum	Jika berlaku, indikasi mengapa dokumen difilter. Nilai yang mungkin: score, rerank	Tidak.
"└─ skor_pencarian_original"	nomor/angka	Skor pencarian asli untuk pengambilan.	Tidak.
└─ peringkat_ulang_skoring	nomor/angka	Nilai pengurutan ulang untuk pengambilan kembali.	Tidak.
└─ permintaan_pencarian	array	Permintaan pencarian dilakukan untuk mengambil dokumen.	Tidak.
└─ judul	string	Judul dari kutipan.	Tidak.
└─ url	string	URL dari kutipan.	Tidak.
└─ kutipan	array	Kutipan yang dihasilkan oleh pengambilan data.	Tidak.
└─ niat	string	Niat yang terdeteksi dari riwayat obrolan, yang digunakan untuk menyatukan konteks percakapan antar interaksi	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		Tidak.
└─ nama	string		Tidak.
reasoning_content	string	Properti ekstensi khusus Azure yang berisi konten penalaran yang dihasilkan dari model yang didukung.	Tidak.
refusal	string	Pesan penolakan yang dihasilkan oleh model.	Yes
peran	enum	Peran penulis pesan ini. Nilai yang mungkin: assistant	Yes
tool_calls	ChatCompletionMessageToolCallsItem	Panggilan alat yang dihasilkan oleh model, seperti panggilan fungsi.	Tidak.

AzureChatCompletionStreamResponseDelta

Model respons yang diperluas untuk pesan respons obrolan streaming di Azure OpenAI service. Model ini menambahkan dukungan untuk konteks pesan obrolan, yang digunakan oleh fitur "On Your Data" untuk niat, kutipan, dan informasi lain yang terkait dengan generasi yang ditingkatkan oleh pengambilan data.

Nama	Tipe	Deskripsi	Diperlukan	Default
audio	objek		Tidak.
└─ data	string		Tidak.
└─ berakhir_pada	bilangan bulat		Tidak.
└─ ID	string		Tidak.
└─ transkrip	string		Tidak.
isi	string	Isi pesan potongan.	Tidak.
context	objek	Properti tambahan, ditambahkan ke pesan respons penyelesaian obrolan, yang diproduksi oleh Azure OpenAI service saat menggunakan perilaku ekstensi. Ini termasuk informasi niat dan kutipan dari fitur On Your Data.	Tidak.
└─ semua_dokumen_yang_diambil	objek	Informasi ringkasan tentang dokumen yang diambil oleh operasi pengambilan data.	Tidak.
└─ chunk_id	string	ID gugus untuk kutipan.	Tidak.
└─ konten	string	Isi kutipan.	Tidak.
└─ indeks_sumber_data	bilangan bulat	Indeks sumber data yang digunakan untuk pengambilan.	Tidak.
└─ jalur file	string	Jalur berkas untuk kutipan.	Tidak.
└─ alasan_penyaringan	enum	Jika berlaku, indikasi mengapa dokumen difilter. Nilai yang mungkin: score, rerank	Tidak.
"└─ skor_pencarian_original"	nomor/angka	Skor pencarian asli untuk pengambilan.	Tidak.
└─ peringkat_ulang_skoring	nomor/angka	Nilai pengurutan ulang untuk pengambilan kembali.	Tidak.
└─ permintaan_pencarian	array	Permintaan pencarian dilakukan untuk mengambil dokumen.	Tidak.
└─ judul	string	Judul dari kutipan.	Tidak.
└─ url	string	URL dari kutipan.	Tidak.
└─ kutipan	array	Kutipan yang dihasilkan oleh pengambilan data.	Tidak.
└─ niat	string	Niat yang terdeteksi dari riwayat obrolan, yang digunakan untuk menyatukan konteks percakapan antar interaksi	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		Tidak.
└─ nama	string		Tidak.
reasoning_content	string	Properti ekstensi khusus Azure yang berisi konten penalaran yang dihasilkan dari model yang didukung.	Tidak.
refusal	string	Pesan penolakan yang dihasilkan oleh model.	Tidak.
peran	objek	Peran penulis pesan	Tidak.
tool_calls	array		Tidak.

AzureChatDataSource

Representasi data konfigurasi untuk satu Azure sumber data obrolan 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.

Diskriminator pada AzureChatDataSource

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
azure_search	AzureSearchChatDataSource
azure_cosmos_db	AzureCosmosDBChatDataSource
elasticsearch	ElasticsearchChatDataSource
pinecone	PineconeChatDataSource
mongo_db	MongoDBChatDataSource

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	objek		Yes

AzureChatDataSourceAccessTokenAuthenticationOptions

Nama	Tipe	Deskripsi	Diperlukan	Default
access_token	string		Yes
jenis	enum	Nilai yang mungkin: access_token	Yes

AzureChatDataSourceApiKeyAuthenticationOptions

Nama	Tipe	Deskripsi	Diperlukan	Default
kunci	string		Yes
jenis	enum	Nilai yang mungkin: api_key	Yes

AzureChatDataSourceAuthenticationOptions

Diskriminator untuk AzureChatDataSourceAuthenticationOptions

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
system_assigned_managed_identity	AzureChatDataSourceSystemAssignedManagedIdentityAuthenticationOptions
user_assigned_managed_identity	AzureChatDataSourceUserAssignedManagedIdentityAuthenticationOptions
access_token	AzureChatDataSourceAccessTokenAuthenticationOptions
connection_string	AzureChatDataSourceConnectionStringAuthenticationOptions
key_and_key_id	AzureChatDataSourceKeyAndKeyIdAuthenticationOptions
encoded_api_key	AzureChatDataSourceEncodedApiKeyAuthenticationOptions
username_and_password	AzureChatDataSourceUsernameAndPasswordAuthenticationOptions

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	AzureChatDataSourceAuthenticationOptionsType		Yes

AzureChatDataSourceAuthenticationOptionsType

Harta benda	Nilai
Jenis	string
Nilai	api_key username_and_password connection_string key_and_key_id encoded_api_key access_token system_assigned_managed_identity user_assigned_managed_identity

AzureChatDataSourceConnectionStringAuthenticationOptions

Nama	Tipe	Deskripsi	Diperlukan	Default
connection_string	string		Yes
jenis	enum	Nilai yang mungkin: connection_string	Yes

AzureChatDataSourceDeploymentNameVectorizationSource

Mewakili sumber vektorisasi yang melakukan panggilan layanan internal terhadap penyebaran model penyematan OpenAI Azure. Berbeda dengan sumber vektorisasi berbasis titik akhir, sumber vektorisasi berbasis nama penyebaran harus menjadi bagian dari sumber daya OpenAI Azure yang sama tetapi dapat digunakan bahkan di jaringan privat.

Nama	Tipe	Deskripsi	Diperlukan	Default
nama_penerapan	string	Model penyematan yang diterapkan untuk digunakan dalam vektorisasi. Penyebaran ini harus ada dalam sumber daya OpenAI Azure yang sama dengan penyebaran model yang digunakan untuk penyelesaian obrolan.	Yes
dimensions	bilangan bulat	Jumlah dimensi yang diminta pada penyematan. Hanya didukung dalam 'text-embedding-3' dan model yang lebih baru.	Tidak.
jenis	enum	Pengidentifikasi jenis, selalu 'deployment_name' untuk jenis sumber vektorisasi ini. Nilai yang mungkin: deployment_name	Yes

AzureChatDataSourceEncodedApiKeyAuthenticationOptions

Nama	Tipe	Deskripsi	Diperlukan	Default
encoded_api_key	string		Yes
jenis	enum	Nilai yang mungkin: encoded_api_key	Yes

AzureChatDataSourceEndpointVectorizationSource

Mewakili sumber vektorisasi yang melakukan panggilan layanan publik terhadap penyebaran model penyematan OpenAI Azure.

Nama	Tipe	Deskripsi	Diperlukan	Default
autentikasi	objek		Yes
└─ akses_token	string		Tidak.
└─ kunci	string		Tidak.
└─ jenis	enum	Nilai yang mungkin: access_token	Tidak.
dimensions	bilangan bulat	Jumlah dimensi yang diminta pada penyematan. Hanya didukung dalam 'text-embedding-3' dan model 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.	Yes
jenis	enum	Pengidentifikasi jenis, selalu 'titik akhir' untuk jenis sumber vektorisasi ini. Nilai yang mungkin: endpoint	Yes

AzureChatDataSourceIntegratedVectorizationSource

Mewakili sumber vektorisasi terintegrasi seperti yang didefinisikan dalam sumber daya pencarian pendukung.

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	enum	Pengidentifikasi jenis, selalu 'terintegrasi' untuk jenis sumber vektorisasi ini. Nilai yang mungkin: integrated	Yes

AzureChatDataSourceKeyAndKeyIdAuthenticationOptions

Nama	Tipe	Deskripsi	Diperlukan	Default
kunci	string		Yes
key_id	string		Yes
jenis	enum	Nilai yang mungkin: key_and_key_id	Yes

AzureChatDataSourceModelIdVectorizationSource

Mewakili sumber vektorisasi yang melakukan panggilan layanan berdasarkan ID model search service. Jenis sumber ini saat ini hanya didukung oleh Elasticsearch.

Nama	Tipe	Deskripsi	Diperlukan	Default
model_id	string	ID model penyematan untuk digunakan dalam vektorisasi.	Yes
jenis	enum	Pengidentifikasi jenis, selalu 'model_id' untuk jenis sumber vektorisasi ini. Nilai yang mungkin: model_id	Yes

AzureChatDataSourceSystemAssignedManagedIdentityAuthenticationOptions

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	enum	Nilai yang mungkin: system_assigned_managed_identity	Yes

AzureChatDataSourceType

Harta benda	Nilai
Jenis	string
Nilai	azure_search azure_cosmos_db elasticsearch pinecone mongo_db

AzureChatDataSourceUserAssignedManagedIdentityAuthenticationOptions

Nama	Tipe	Deskripsi	Diperlukan	Default
managed_identity_resource_id	string		Yes
jenis	enum	Nilai yang mungkin: user_assigned_managed_identity	Yes

AzureChatDataSourceUsernameAndPasswordAuthenticationOptions

Nama	Tipe	Deskripsi	Diperlukan	Default
kata sandi	string		Yes
jenis	enum	Nilai yang mungkin: username_and_password	Yes
nama pengguna	string		Yes

AzureChatDataSourceVectorizationSource

Representasi sumber vektorisasi data yang dapat digunakan sebagai resource embedding pada sumber data.

Diskriminator untuk AzureChatDataSourceVectorizationSource

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
deployment_name	AzureChatDataSourceDeploymentNameVectorizationSource
integrated	AzureChatDataSourceIntegratedVectorizationSource
model_id	AzureChatDataSourceModelIdVectorizationSource

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	objek		Yes

AzureChatDataSourceVectorizationSourceType

Harta benda	Nilai
Jenis	string
Nilai	endpoint deployment_name model_id integrated

AzureChatMessageContext

Properti tambahan, ditambahkan ke pesan respons penyelesaian obrolan, yang diproduksi oleh Azure OpenAI service saat menggunakan perilaku ekstensi. Ini termasuk informasi niat dan kutipan dari fitur On Your Data.

Nama	Tipe	Deskripsi	Diperlukan	Default
all_retrieved_documents	objek	Informasi ringkasan tentang dokumen yang diambil oleh operasi pengambilan data.	Tidak.
└─ chunk_id	string	ID gugus untuk kutipan.	Tidak.
└─ konten	string	Isi kutipan.	Tidak.
└─ indeks_sumber_data	bilangan bulat	Indeks sumber data yang digunakan untuk pengambilan.	Tidak.
└─ jalur file	string	Jalur berkas untuk kutipan.	Tidak.
└─ alasan_penyaringan	enum	Jika berlaku, indikasi mengapa dokumen difilter. Nilai yang mungkin: score, rerank	Tidak.
"└─ skor_pencarian_original"	nomor/angka	Skor pencarian asli untuk pengambilan.	Tidak.
└─ peringkat_ulang_skoring	nomor/angka	Nilai pengurutan ulang untuk pengambilan kembali.	Tidak.
└─ permintaan_pencarian	array	Permintaan pencarian dilakukan untuk mengambil dokumen.	Tidak.
└─ judul	string	Judul dari kutipan.	Tidak.
└─ url	string	URL dari kutipan.	Tidak.
citations	array	Kutipan yang dihasilkan oleh pengambilan data.	Tidak.
niat	string	Niat yang terdeteksi dari riwayat obrolan, yang digunakan untuk menyatukan konteks percakapan antar interaksi	Tidak.

AzureContentFilterBlocklistResult

Kumpulan hasil pemfilteran true/false untuk daftar blokir kustom yang dikonfigurasi.

Nama	Tipe	Deskripsi	Diperlukan	Default
details	array	Pasangan ID daftar blokir individual dan apakah ID tersebut berhasil menghasilkan tindakan pemfilteran.	Tidak.
filtered	Boolean	Nilai yang menunjukkan apakah salah satu daftar blokir terperinci menghasilkan tindakan pemfilteran.	Yes

AzureContentFilterCompletionTextSpan

Representasi rentang teks penyelesaian seperti yang digunakan oleh Azure hasil filter konten OpenAI.

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

AzureContentFilterCompletionTextSpanDetectionResult

Nama	Tipe	Deskripsi	Diperlukan	Default
details	array	Informasi terperinci tentang rentang teks penyelesaian yang terdeteksi.	Yes
detected	Boolean	Apakah kategori konten berlabel terdeteksi dalam konten.	Yes
filtered	Boolean	Apakah deteksi konten menghasilkan tindakan pemfilteran konten.	Yes

AzureContentFilterCustomTopicResult

Kumpulan hasil pemfilteran true/false untuk topik kustom yang dikonfigurasi.

Nama	Tipe	Deskripsi	Diperlukan	Default
details	array	Pasangan ID topik individual dan apakah id tersebut terdeteksi.	Tidak.
filtered	Boolean	Nilai yang menunjukkan apakah salah satu topik terperinci menghasilkan tindakan pemfilteran.	Yes

AzureContentFilterDetectionResult

Item hasil filter konten berlabel yang menunjukkan apakah konten terdeteksi dan apakah konten difilter.

Nama	Tipe	Deskripsi	Diperlukan	Default
detected	Boolean	Apakah kategori konten berlabel terdeteksi dalam konten.	Yes
filtered	Boolean	Apakah deteksi konten menghasilkan tindakan pemfilteran konten.	Yes

AzureContentFilterImagePromptResults

Hasil filter konten untuk konten permintaan input operasi pembuatan gambar.

Nama	Tipe	Deskripsi	Diperlukan	Default
custom_blocklists	objek	Kumpulan hasil pemfilteran true/false untuk daftar blokir kustom yang dikonfigurasi.	Tidak.
└─ detail	array	Pasangan ID daftar blokir individual dan apakah ID tersebut berhasil menghasilkan tindakan pemfilteran.	Tidak.
└─ difilter	Boolean	Nilai yang menunjukkan apakah salah satu daftar blokir terperinci menghasilkan tindakan pemfilteran.	Tidak.
custom_topics	objek	Kumpulan hasil pemfilteran true/false untuk topik kustom yang dikonfigurasi.	Tidak.
└─ detail	array	Pasangan ID topik individual dan apakah id tersebut terdeteksi.	Tidak.
└─ difilter	Boolean	Nilai yang menunjukkan apakah salah satu topik terperinci menghasilkan tindakan pemfilteran.	Tidak.
jailbreak	objek	Item hasil filter konten berlabel yang menunjukkan apakah konten terdeteksi dan apakah konten difilter.	Yes
└─ terdeteksi	Boolean	Apakah kategori konten berlabel terdeteksi dalam konten.	Tidak.
└─ difilter	Boolean	Apakah deteksi konten menghasilkan tindakan pemfilteran konten.	Tidak.
profanity	objek	Item hasil filter konten berlabel yang menunjukkan apakah konten terdeteksi dan apakah konten difilter.	Tidak.
└─ terdeteksi	Boolean	Apakah kategori konten berlabel terdeteksi dalam konten.	Tidak.
└─ difilter	Boolean	Apakah deteksi konten menghasilkan tindakan pemfilteran konten.	Tidak.

AzureContentFilterImageResponseResults

Hasil filter konten untuk konten respons output operasi pembuatan gambar.

Nama	Tipe	Deskripsi	Diperlukan	Default
hate	objek	Item hasil filter konten berlabel yang menunjukkan apakah konten tersebut telah difilter dan tingkat keparahan kualitatif dari konten tersebut, seperti yang dievaluasi berdasarkan konfigurasi filter konten untuk kategori.	Tidak.
└─ difilter	Boolean	Apakah tingkat keparahan konten menghasilkan tindakan pemfilteran konten.	Tidak.
└─ tingkat keparahan	enum	Tingkat keparahan konten berlabel. Nilai yang mungkin: safe, low, medium, high	Tidak.
self_harm	objek	Item hasil filter konten berlabel yang menunjukkan apakah konten tersebut telah difilter dan tingkat keparahan kualitatif dari konten tersebut, seperti yang dievaluasi berdasarkan konfigurasi filter konten untuk kategori.	Tidak.
└─ difilter	Boolean	Apakah tingkat keparahan konten menghasilkan tindakan pemfilteran konten.	Tidak.
└─ tingkat keparahan	enum	Tingkat keparahan konten berlabel. Nilai yang mungkin: safe, low, medium, high	Tidak.
sexual	objek	Item hasil filter konten berlabel yang menunjukkan apakah konten tersebut telah difilter dan tingkat keparahan kualitatif dari konten tersebut, seperti yang dievaluasi berdasarkan konfigurasi filter konten untuk kategori.	Tidak.
└─ difilter	Boolean	Apakah tingkat keparahan konten menghasilkan tindakan pemfilteran konten.	Tidak.
└─ tingkat keparahan	enum	Tingkat keparahan konten berlabel. Nilai yang mungkin: safe, low, medium, high	Tidak.
violence	objek	Item hasil filter konten berlabel yang menunjukkan apakah konten tersebut telah difilter dan tingkat keparahan kualitatif dari konten tersebut, seperti yang dievaluasi berdasarkan konfigurasi filter konten untuk kategori.	Tidak.
└─ difilter	Boolean	Apakah tingkat keparahan konten menghasilkan tindakan pemfilteran konten.	Tidak.
└─ tingkat keparahan	enum	Tingkat keparahan konten berlabel. Nilai yang mungkin: safe, low, medium, high	Tidak.

AzureContentFilterResultForChoice

Hasil filter konten untuk satu item respons yang dihasilkan oleh sistem AI generatif.

Nama	Tipe	Deskripsi	Diperlukan	Default
custom_blocklists	objek	Kumpulan hasil pemfilteran true/false untuk daftar blokir kustom yang dikonfigurasi.	Tidak.
└─ detail	array	Pasangan ID daftar blokir individual dan apakah ID tersebut berhasil menghasilkan tindakan pemfilteran.	Tidak.
└─ difilter	Boolean	Nilai yang menunjukkan apakah salah satu daftar blokir terperinci menghasilkan tindakan pemfilteran.	Tidak.
custom_topics	objek	Kumpulan hasil pemfilteran true/false untuk topik kustom yang dikonfigurasi.	Tidak.
└─ detail	array	Pasangan ID topik individual dan apakah id tersebut terdeteksi.	Tidak.
└─ difilter	Boolean	Nilai yang menunjukkan apakah salah satu topik terperinci menghasilkan tindakan pemfilteran.	Tidak.
galat	objek	Jika ada, detail tentang kesalahan yang mencegah pemfilteran konten menyelesaikan evaluasinya.	Tidak.
└─ kode	bilangan bulat	Kode unik yang dapat dibaca mesin dan terkait dengan kesalahan.	Tidak.
└─ pesan	string	Pesan yang mudah dipahami manusia yang terkait dengan kesalahan.	Tidak.
hate	objek	Item hasil filter konten berlabel yang menunjukkan apakah konten tersebut telah difilter dan tingkat keparahan kualitatif dari konten tersebut, seperti yang dievaluasi berdasarkan konfigurasi filter konten untuk kategori.	Tidak.
└─ difilter	Boolean	Apakah tingkat keparahan konten menghasilkan tindakan pemfilteran konten.	Tidak.
└─ tingkat keparahan	enum	Tingkat keparahan konten berlabel. Nilai yang mungkin: safe, low, medium, high	Tidak.
profanity	objek	Item hasil filter konten berlabel yang menunjukkan apakah konten terdeteksi dan apakah konten difilter.	Tidak.
└─ terdeteksi	Boolean	Apakah kategori konten berlabel terdeteksi dalam konten.	Tidak.
└─ difilter	Boolean	Apakah deteksi konten menghasilkan tindakan pemfilteran konten.	Tidak.
protected_material_code	objek	Hasil deteksi yang menjelaskan kecocokan terhadap kode berlisensi atau materi sumber lain yang dilindungi.	Tidak.
└─ kutipan	objek	Jika tersedia, detail kutipan yang menjelaskan lisensi terkait dan lokasinya.	Tidak.
└─ URL	string	URL yang terkait dengan lisensi.	Tidak.
└─ Lisensi	string	Nama atau pengidentifikasi lisensi yang terkait dengan deteksi.	Tidak.
└─ terdeteksi	Boolean	Apakah kategori konten berlabel terdeteksi dalam konten.	Tidak.
└─ difilter	Boolean	Apakah deteksi konten menghasilkan tindakan pemfilteran konten.	Tidak.
protected_material_text	objek	Item hasil filter konten berlabel yang menunjukkan apakah konten terdeteksi dan apakah konten difilter.	Tidak.
└─ terdeteksi	Boolean	Apakah kategori konten berlabel terdeteksi dalam konten.	Tidak.
└─ difilter	Boolean	Apakah deteksi konten menghasilkan tindakan pemfilteran konten.	Tidak.
self_harm	objek	Item hasil filter konten berlabel yang menunjukkan apakah konten tersebut telah difilter dan tingkat keparahan kualitatif dari konten tersebut, seperti yang dievaluasi berdasarkan konfigurasi filter konten untuk kategori.	Tidak.
└─ difilter	Boolean	Apakah tingkat keparahan konten menghasilkan tindakan pemfilteran konten.	Tidak.
└─ tingkat keparahan	enum	Tingkat keparahan konten berlabel. Nilai yang mungkin: safe, low, medium, high	Tidak.
sexual	objek	Item hasil filter konten berlabel yang menunjukkan apakah konten tersebut telah difilter dan tingkat keparahan kualitatif dari konten tersebut, seperti yang dievaluasi berdasarkan konfigurasi filter konten untuk kategori.	Tidak.
└─ difilter	Boolean	Apakah tingkat keparahan konten menghasilkan tindakan pemfilteran konten.	Tidak.
└─ tingkat keparahan	enum	Tingkat keparahan konten berlabel. Nilai yang mungkin: safe, low, medium, high	Tidak.
ungrounded_material	AzureContentFilterCompletionTextSpanDetectionResult		Tidak.
violence	objek	Item hasil filter konten berlabel yang menunjukkan apakah konten tersebut telah difilter dan tingkat keparahan kualitatif dari konten tersebut, seperti yang dievaluasi berdasarkan konfigurasi filter konten untuk kategori.	Tidak.
└─ difilter	Boolean	Apakah tingkat keparahan konten menghasilkan tindakan pemfilteran konten.	Tidak.
└─ tingkat keparahan	enum	Tingkat keparahan konten berlabel. Nilai yang mungkin: safe, low, medium, high	Tidak.

AzureContentFilterResultForPrompt

Hasil filter konten yang terkait dengan satu item perintah input ke dalam sistem AI generatif.

Nama	Tipe	Deskripsi	Diperlukan	Default
content_filter_results	objek	Detail kategori filter konten untuk hasilnya.	Tidak.
└─ daftar blokir kustom	objek	Kumpulan hasil pemfilteran true/false untuk daftar blokir kustom yang dikonfigurasi.	Tidak.
└─ detail	array	Pasangan ID daftar blokir individual dan apakah ID tersebut berhasil menghasilkan tindakan pemfilteran.	Tidak.
└─ difilter	Boolean	Nilai yang menunjukkan apakah salah satu daftar blokir terperinci menghasilkan tindakan pemfilteran.	Tidak.
topik_kustom	objek	Kumpulan hasil pemfilteran true/false untuk topik kustom yang dikonfigurasi.	Tidak.
└─ detail	array	Pasangan ID topik individual dan apakah id tersebut terdeteksi.	Tidak.
└─ difilter	Boolean	Nilai yang menunjukkan apakah salah satu topik terperinci menghasilkan tindakan pemfilteran.	Tidak.
└─ kesalahan	objek	Jika ada, detail tentang kesalahan yang mencegah pemfilteran konten menyelesaikan evaluasinya.	Tidak.
└─ kode	bilangan bulat	Kode unik yang dapat dibaca mesin dan terkait dengan kesalahan.	Tidak.
└─ pesan	string	Pesan yang mudah dipahami manusia yang terkait dengan kesalahan.	Tidak.
└─ benci	objek	Item hasil filter konten berlabel yang menunjukkan apakah konten tersebut telah difilter dan tingkat keparahan kualitatif dari konten tersebut, seperti yang dievaluasi berdasarkan konfigurasi filter konten untuk kategori.	Tidak.
└─ difilter	Boolean	Apakah tingkat keparahan konten menghasilkan tindakan pemfilteran konten.	Tidak.
└─ tingkat keparahan	enum	Tingkat keparahan konten berlabel. Nilai yang mungkin: safe, low, medium, high	Tidak.
└─ serangan tidak langsung	objek	Item hasil filter konten berlabel yang menunjukkan apakah konten terdeteksi dan apakah konten difilter.	Tidak.
└─ terdeteksi	Boolean	Apakah kategori konten berlabel terdeteksi dalam konten.	Tidak.
└─ difilter	Boolean	Apakah deteksi konten menghasilkan tindakan pemfilteran konten.	Tidak.
└─ jailbreak (pembebasan batasan perangkat)	objek	Item hasil filter konten berlabel yang menunjukkan apakah konten terdeteksi dan apakah konten difilter.	Tidak.
└─ terdeteksi	Boolean	Apakah kategori konten berlabel terdeteksi dalam konten.	Tidak.
└─ difilter	Boolean	Apakah deteksi konten menghasilkan tindakan pemfilteran konten.	Tidak.
└─ kata-kata kotor	objek	Item hasil filter konten berlabel yang menunjukkan apakah konten terdeteksi dan apakah konten difilter.	Tidak.
└─ terdeteksi	Boolean	Apakah kategori konten berlabel terdeteksi dalam konten.	Tidak.
└─ difilter	Boolean	Apakah deteksi konten menghasilkan tindakan pemfilteran konten.	Tidak.
└─ melukai diri sendiri	objek	Item hasil filter konten berlabel yang menunjukkan apakah konten tersebut telah difilter dan tingkat keparahan kualitatif dari konten tersebut, seperti yang dievaluasi berdasarkan konfigurasi filter konten untuk kategori.	Tidak.
└─ difilter	Boolean	Apakah tingkat keparahan konten menghasilkan tindakan pemfilteran konten.	Tidak.
└─ tingkat keparahan	enum	Tingkat keparahan konten berlabel. Nilai yang mungkin: safe, low, medium, high	Tidak.
└─ seksual	objek	Item hasil filter konten berlabel yang menunjukkan apakah konten tersebut telah difilter dan tingkat keparahan kualitatif dari konten tersebut, seperti yang dievaluasi berdasarkan konfigurasi filter konten untuk kategori.	Tidak.
└─ difilter	Boolean	Apakah tingkat keparahan konten menghasilkan tindakan pemfilteran konten.	Tidak.
└─ tingkat keparahan	enum	Tingkat keparahan konten berlabel. Nilai yang mungkin: safe, low, medium, high	Tidak.
└─ kekerasan	objek	Item hasil filter konten berlabel yang menunjukkan apakah konten tersebut telah difilter dan tingkat keparahan kualitatif dari konten tersebut, seperti yang dievaluasi berdasarkan konfigurasi filter konten untuk kategori.	Tidak.
└─ difilter	Boolean	Apakah tingkat keparahan konten menghasilkan tindakan pemfilteran konten.	Tidak.
└─ tingkat keparahan	enum	Tingkat keparahan konten berlabel. Nilai yang mungkin: safe, low, medium, high	Tidak.
prompt_index	bilangan bulat	Indeks permintaan input yang terkait dengan kategori hasil filter konten yang menyertainya.	Tidak.

AzureContentFilterSeverityResult

Item hasil filter konten berlabel yang menunjukkan apakah konten tersebut telah difilter dan tingkat keparahan kualitatif dari konten tersebut, seperti yang dievaluasi berdasarkan konfigurasi filter konten untuk kategori.

Nama	Tipe	Deskripsi	Diperlukan	Default
filtered	Boolean	Apakah tingkat keparahan konten menghasilkan tindakan pemfilteran konten.	Yes
severity	enum	Tingkat keparahan konten berlabel. Nilai yang mungkin: safe, low, medium, high	Yes

AzureCosmosDBChatDataSource

Mewakili konfigurasi sumber data yang akan menggunakan sumber daya cosmosDB Azure.

Nama	Tipe	Deskripsi	Diperlukan	Default
parameter	objek	Informasi parameter untuk mengontrol penggunaan sumber data Azure CosmosDB.	Yes
└─ izinkan_hasil_parsial	Boolean	Jika diatur ke true, sistem akan mengizinkan hasil pencarian parsial digunakan dan permintaan akan gagal jika semua kueri parsial gagal. Jika tidak ditentukan atau ditentukan sebagai false, permintaan akan gagal jika ada kueri pencarian yang gagal.	Tidak.	False
└─ autentikasi	AzureChatDataSourceConnectionStringAuthenticationOptions		Tidak.
└─ nama_kontainer	string		Tidak.
└─ database_name	string		Tidak.
└─ ketergantungan_embedding	AzureChatDataSourceVectorizationSource	Representasi sumber vektorisasi data yang dapat digunakan sebagai resource embedding pada sumber data.	Tidak.
└─ pemetaan_bidang	objek		Tidak.
└─ kolom_konten	array		Tidak.
└─ pemisah_bidang_konten	string		Tidak.
└─ filepath_field	string		Tidak.
└─ bidang_judul	string		Tidak.
└─ url_field	string		Tidak.
└─ bidang_vektor	array		Tidak.
└─ in_scope	Boolean	Apakah kueri harus dibatasi untuk menggunakan data terindeks.	Tidak.
└─ sertakan_konteks	array	Properti konteks output untuk disertakan pada respons. Secara default, kutipan dan niat akan diminta.	Tidak.	['kutipan', 'tujuan']
└─ nama_indeks	string		Tidak.
└─ kueri_pencarian_maksimum	bilangan bulat	Jumlah maksimum kueri yang ditulis ulang yang harus dikirim ke penyedia pencarian untuk satu pesan pengguna. Secara default, sistem akan membuat penentuan otomatis.	Tidak.
└─ keketatan	bilangan bulat	Ketatnya pemfilteran relevansi pencarian yang dikonfigurasi. Ketegasan yang lebih tinggi akan meningkatkan presisi tetapi pengenalan jawaban yang lebih rendah.	Tidak.
└─ top_n_documents	bilangan bulat	Jumlah dokumen yang dikonfigurasi untuk ditampilkan dalam kueri.	Tidak.
jenis	enum	Pengidentifikasi tipe terdiskriminasi, yang selalu 'azure_cosmos_db'. Nilai yang mungkin: azure_cosmos_db	Yes

AzureCreateChatCompletionRequest

Model permintaan yang diperluas untuk penyelesaian obrolan terhadap Azure OpenAI service. Ini menambahkan kemampuan untuk menyediakan sumber data untuk fitur On Your Data.

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, , aacmp3, flac, opus,pcm16	Tidak.
└─ suara	objek		Tidak.
data_sources	array	Sumber data yang digunakan untuk fitur On Your Data, eksklusif untuk 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	enum	Menentukan fungsi tertentu melalui {"name": "my_function"} memaksa model untuk memanggil fungsi tersebut. Nilai yang mungkin: none, auto	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 akan bervariasi per model, tetapi nilai antara -1 dan 1 harus mengurangi atau meningkatkan kemungkinan pilihan; nilai seperti -100 atau 100 harus menghasilkan larangan atau pilihan eksklusif dari token yang relevan.	Tidak.	Tidak ada
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. Nilai ini dapat digunakan untuk mengontrol biaya teks yang dihasilkan melalui API. Nilai ini sekarang dihapuskan sebagai pengganti max_completion_tokens, dan tidak kompatibel dengan model seri o1.	Tidak.
messages	array	Daftar pesan yang terdiri dari percakapan sejauh ini. Bergantung pada model yang Anda gunakan, berbagai jenis pesan (modalitas) didukung, seperti teks, gambar, dan audio.	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, dan mengkueri objek melalui API atau dasbor. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter.	Tidak.
Modalitas	objek	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.
model	string	Pengidentifikasi penyebaran model yang akan digunakan untuk permintaan kompletasi obrolan.	Yes
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	objek	Apakah akan mengaktifkan panggilan fungsi paralel selama penggunaan alat.	Tidak.
prediksi	objek	Representasi dasar output yang diprediksi dari model.	Tidak.
└─ jenis	OpenAI.ChatOutputPredictionType		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	objek	model seri o 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.	Tidak.
response_format	objek		Tidak.
└─ jenis	enum	Nilai yang mungkin: text, json_object, json_schema	Tidak.
seed	bilangan bulat	Fitur ini ada di Beta. Jika ditentukan, sistem kami akan melakukan upaya terbaik untuk sampel secara deterministik, sehingga permintaan berulang dengan yang sama seed dan parameter harus mengembalikan hasil yang sama. Determinisme tidak dijamin, dan Anda harus merujuk ke system_fingerprint parameter respons untuk memantau perubahan di backend.	Tidak.
stop	objek	Tidak didukung dengan model penalaran yang terbaru o3 dan o4-mini. Hingga 4 urutan di mana API akan berhenti menghasilkan token lebih lanjut. Teks yang dikembalikan tidak akan berisi urutan berhenti.	Tidak.
simpan	Boolean	Apakah menyimpan output permintaan penyelesaian obrolan ini untuk digunakan dalam distilasi model atau produk evaluasi atau tidak.	Tidak.	False
aliran	Boolean	Jika diatur ke true, data respons model akan dialirkan ke klien saat sedang dihasilkan menggunakan peristiwa yang dikirim oleh server.	Tidak.	False
stream_options	objek	Opsi untuk respons streaming. Hanya atur ini saat Anda mengatur stream: true.	Tidak.
└─ sertakan_penggunaan	Boolean	Jika diatur, bagian tambahan akan dialirkan sebelum pesan data: [DONE]. Bidang usage pada gugus ini menunjukkan statistik penggunaan token untuk seluruh permintaan, dan choices bidang akan selalu menjadi array kosong. Semua bagian lainnya juga akan menyertakan usage bidang, tetapi dengan nilai null. NOTA: Jika aliran terganggu, Anda mungkin tidak menerima gugus penggunaan akhir yang berisi total penggunaan token untuk permintaan tersebut.	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
tool_choice	OpenAI.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.	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	AzureUserSecurityContext	Konteks keamanan pengguna berisi beberapa parameter yang menjelaskan aplikasi itu sendiri, dan pengguna akhir yang berinteraksi dengan aplikasi. 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.

AzureCreateChatCompletionResponse

Model respons penyelesaian obrolan tingkat atas yang diperluas untuk Azure OpenAI service. Model ini menambahkan anotasi filter konten AI yang Bertanggung Jawab untuk input perintah.

Nama	Tipe	Deskripsi	Diperlukan	Default
choices	array		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	array	Anotasi filter konten AI yang bertanggung jawab yang terkait dengan input perintah ke dalam penyelesaian obrolan.	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	OpenAI.CompletionUsage	Statistik penggunaan untuk permintaan penyelesaian tugas.	Tidak.

AzureCreateChatCompletionStreamResponse

Nama	Tipe	Deskripsi	Diperlukan	Default
choices	array	Daftar pilihan penyelesaian obrolan. Dapat berisi lebih dari satu elemen jika n lebih besar dari 1. Juga dapat kosong untuk potongan terakhir jika Anda mengatur stream_options: {"include_usage": true}.	Yes
content_filter_results	AzureContentFilterResultForChoice	Hasil filter konten untuk satu item respons yang dihasilkan oleh sistem AI generatif.	Tidak.
Dibuat	bilangan bulat	Tanda waktu Unix (dalam detik) saat penyelesaian obrolan dibuat. Setiap gugus memiliki tanda waktu yang sama.	Yes
delta	AzureChatCompletionStreamResponseDelta	Model respons yang diperluas untuk pesan respons obrolan streaming di Azure OpenAI service. Model ini menambahkan dukungan untuk konteks pesan obrolan, yang digunakan oleh fitur "On Your Data" untuk niat, kutipan, dan informasi lain yang terkait dengan generasi yang ditingkatkan oleh pengambilan data.	Tidak.
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.
usage	objek	Statistik penggunaan untuk permintaan penyelesaian tugas.	Tidak.
└─ token_penyelesaian	bilangan bulat	Jumlah token dalam penyelesaian yang dihasilkan.	Tidak.	0
└─ rincian_token_penyelesaian	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.	0
└─ audio_tokens	bilangan bulat	Token input audio yang dihasilkan oleh model.	Tidak.	0
└─ token_penalaran	bilangan bulat	Token yang dihasilkan oleh model untuk penalaran.	Tidak.	0
└─ 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.	0
└─ token pemicu	bilangan bulat	Jumlah token dalam prompt.	Tidak.	0
└─ detil_token_perintah	objek	Perincian token yang digunakan dalam perintah.	Tidak.
└─ audio_tokens	bilangan bulat	Token input audio ada di prompt.	Tidak.	0
└─ token_yang_di-cache	bilangan bulat	Token yang di-cache ada di prompt.	Tidak.	0
└─ jumlah_token	bilangan bulat	Jumlah total token yang digunakan dalam permintaan (prompt + penyelesaian).	Tidak.	0

AzureCreateEmbeddingRequest

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	enum	Format untuk mengembalikan penggabungan dalam. Dapat berupa float atau base64. Nilai yang mungkin: float, base64	Tidak.
Masukan	string atau array		Yes
model	string	Model yang digunakan untuk permintaan penyematan.	Yes
pengguna	string	Pengidentifikasi unik yang mewakili pengguna akhir Anda, yang dapat membantu OpenAI memantau dan mendeteksi penyalahgunaan.	Tidak.

AzureCreateFileRequestMultiPart

Nama	Tipe	Deskripsi	Diperlukan	Default
kedaluwarsa_setelah	objek		Yes
└─ jangkar	AzureFileExpiryAnchor		Tidak.
└─ detik	bilangan bulat		Tidak.
berkas	string		Yes
purpose	enum	Tujuan yang dimaksudkan dari file yang diunggah. Salah satu dari: - assistants: Digunakan dalam Assistants API - batch: Digunakan dalam API Batch - fine-tune: Digunakan untuk penyempurnaan - evals: Digunakan untuk evaluasi himpunan data. Nilai yang mungkin: assistants, batch, fine-tune, evals	Yes

AzureCreateImageEditRequestMultiPart

Nama	Tipe	Deskripsi	Diperlukan	Default
latar belakang	enum	Memungkinkan untuk mengatur transparansi untuk latar belakang gambar yang dihasilkan. Parameter ini hanya didukung untuk gpt-image-1model seri. Harus salah satu dari transparent, opaque atau auto (nilai default). Ketika auto digunakan, model akan secara otomatis menentukan latar belakang terbaik untuk gambar. Jika transparent, format output perlu mendukung transparansi, sehingga harus diatur ke png (nilai default) atau webp. Nilai yang mungkin: transparent, opaque, auto	Tidak.
citra	string atau array		Yes
masker	string		Tidak.
model	string	Penyebaran model yang digunakan untuk operasi pengeditan gambar.	Yes
n	bilangan bulat	Jumlah gambar yang akan dihasilkan. Harus antara 1 dan 10.	Tidak.	1
kompresi keluaran	bilangan bulat	Tingkat kompresi (0-100%) untuk gambar yang dihasilkan. Parameter ini hanya didukung untuk model-model seri gpt-image-1 dengan format output webp atau jpeg, dan nilai defaultnya adalah 100.	Tidak.	100
format keluaran	enum	Format di mana gambar yang dihasilkan dikembalikan. Parameter ini hanya didukung untuk gpt-image-1model seri. Harus salah satu dari png, , jpegatau webp. Nilai defaultnya adalah png. Nilai yang mungkin: png, jpeg, webp	Tidak.
minta	string	Deskripsi teks gambar yang diinginkan. Panjang maksimum adalah 1000 karakter untuk dall-e-2, dan 32000 karakter untuk gpt-image-1model seri.	Yes
kualitas	enum	Kualitas gambar yang akan dihasilkan. high, medium dan low hanya didukung untuk gpt-image-1model seri. dall-e-2 hanya mendukung kualitas standard. Secara default menjadi auto. Nilai yang mungkin: standard, , lowmedium, high,auto	Tidak.
response_format	enum	Format di mana gambar yang dihasilkan dikembalikan. Harus salah satu dari url atau b64_json. URL hanya berlaku selama 60 menit setelah gambar dibuat. Parameter ini hanya didukung untuk dall-e-2, karena gpt-image-1model seri akan selalu mengembalikan gambar yang dikodekan base64. Nilai yang mungkin: url, b64_json	Tidak.
ukuran	enum	Ukuran gambar yang dihasilkan. Harus salah satu dari 1024x1024, 1536x1024 (lanskap), 1024x1536 (potret), atau auto (nilai default) untuk model seri gpt-image-1, dan salah satu dari 256x256, 512x512, atau 1024x1024 untuk dall-e-2. Nilai yang mungkin: 256x256, , 512x5121024x1024, 1536x1024, 1024x1536,auto	Tidak.
pengguna	string	Pengidentifikasi unik yang mewakili pengguna akhir Anda, yang dapat membantu OpenAI memantau dan mendeteksi penyalahgunaan.	Tidak.

AzureCreateImageRequest

Nama	Tipe	Deskripsi	Diperlukan	Default
latar belakang	enum	Memungkinkan untuk mengatur transparansi untuk latar belakang gambar yang dihasilkan. Parameter ini hanya didukung untuk gpt-image-1model seri. Harus salah satu dari transparent, opaque atau auto (nilai default). Ketika auto digunakan, model akan secara otomatis menentukan latar belakang terbaik untuk gambar. Jika transparent, format output perlu mendukung transparansi, sehingga harus diatur ke png (nilai default) atau webp. Nilai yang mungkin: transparent, opaque, auto	Tidak.
model	string	Penyebaran model yang digunakan untuk pembuatan gambar.	Yes
moderation	enum	Kontrol tingkat moderasi konten untuk gambar yang dihasilkan oleh gpt-image-1model seri. Harus berupa low untuk pemfilteran yang kurang ketat atau auto (nilai default). Nilai yang mungkin: low, auto	Tidak.
n	bilangan bulat	Jumlah gambar yang akan dihasilkan. Harus antara 1 dan 10. Untuk dall-e-3, hanya n=1 didukung.	Tidak.	1
kompresi keluaran	bilangan bulat	Tingkat kompresi (0-100%) untuk gambar yang dihasilkan. Parameter ini hanya didukung untuk model-model seri gpt-image-1 dengan format output webp atau jpeg, dan nilai defaultnya adalah 100.	Tidak.	100
format keluaran	enum	Format di mana gambar yang dihasilkan dikembalikan. Parameter ini hanya didukung untuk gpt-image-1model seri. Harus salah satu dari png, , jpegatau webp. Nilai yang mungkin: png, jpeg, webp	Tidak.
minta	string	Deskripsi teks gambar yang diinginkan.	Yes
kualitas	enum	Kualitas gambar yang akan dihasilkan. - auto (nilai default) akan secara otomatis memilih kualitas terbaik untuk model yang diberikan. - high, medium dan low didukung untuk seri gpt-image-1. - hd dan standard didukung untuk dall-e-3. - standard adalah satu-satunya opsi untuk dall-e-2. Nilai yang mungkin: standard, , hdlow, medium, high,auto	Tidak.
response_format	enum	Format di mana gambar yang dihasilkan dengan dall-e-2 dan dall-e-3 dikembalikan. Harus salah satu dari url atau b64_json. URL hanya berlaku selama 60 menit setelah gambar dibuat. Parameter ini tidak didukung untuk gpt-image-1model seri yang akan selalu mengembalikan gambar yang dikodekan base64. Nilai yang mungkin: url, b64_json	Tidak.
ukuran	enum	Ukuran gambar yang dihasilkan. Harus salah satu dari 1024x1024, 1536x1024 (lanskap), 1024x1536 (potret), atau auto (nilai default) untuk model seri gpt-image-1, salah satu dari 256x256, 512x512, atau 1024x1024 untuk dall-e-2, dan salah satu dari 1024x1024, 1792x1024, atau 1024x1792 untuk dall-e-3. Nilai yang mungkin: auto, , 1024x10241536x1024, 1024x1536, 256x256, 512x512, , 1792x10241024x1792	Tidak.
gaya	enum	Gaya gambar yang dihasilkan. Parameter ini hanya didukung untuk dall-e-3. Harus salah satu dari vivid atau natural. Vivid menyebabkan model cenderung untuk menghasilkan citra hiper-realistis dan dramatis. Alami menyebabkan model menghasilkan gambar yang terlihat lebih alami dan kurang hiper-realistis. Nilai yang mungkin: vivid, natural	Tidak.
pengguna	string	Pengidentifikasi unik yang mewakili pengguna akhir Anda, yang dapat membantu OpenAI memantau dan mendeteksi penyalahgunaan.	Tidak.

AzureCreateResponse

Nama	Tipe	Deskripsi	Diperlukan	Default
latar belakang	Boolean	Apakah akan menjalankan respons model di latar belakang.	Tidak.	False
termasuk	array	Tentukan data output tambahan untuk disertakan dalam respons model. Nilai yang saat ini didukung adalah: - code_interpreter_call.outputs: Menyertakan output eksekusi kode python dalam item panggilan alat penerjemah kode. - computer_call_output.output.image_url: Sertakan url gambar dari output panggilan komputer. - file_search_call.results: Sertakan hasil pencarian dari alat pencari file. - message.input_image.image_url: Sertakan url gambar dari pesan input. - message.output_text.logprobs: Sertakan logprobs dengan pesan asisten. - reasoning.encrypted_content: Menyertakan versi terenkripsi dari token penalaran dalam output item penalaran. Ini memungkinkan item penalaran digunakan dalam percakapan berkelanjutan saat menggunakan API Respons tanpa status (seperti ketika parameter store diatur ke false, atau ketika organisasi terdaftar dalam program tanpa retensi data).	Tidak.
Masukan	string atau array		Tidak.
instructions	string	Pesan sistem (atau pengembang) dimasukkan ke 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 yang terlihat dan token penalaran	Tidak.
max_tool_calls	bilangan bulat	Jumlah maksimum total panggilan ke alat bawaan yang dapat diproses dalam respons. Jumlah maksimum ini berlaku di semua panggilan alat bawaan, bukan per alat individual. Setiap upaya lebih lanjut untuk memanggil alat oleh model akan diabaikan.	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, 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	Penyebaran model yang digunakan untuk pembuatan respons ini.	Yes
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.
minta	objek	Referensi ke templat perintah dan variabelnya.	Tidak.
└─ ID	string	Pengidentifikasi unik templat perintah yang akan digunakan.	Tidak.
└─ variabel	OpenAI.ResponsePromptVariables	Peta nilai opsional untuk mengganti variabel dalam perintah Anda. Nilai substitusi dapat berupa string, atau jenis input Respons lainnya seperti gambar atau file.	Tidak.
└─ versi	string	Versi opsional templat prompt.	Tidak.
reasoning	objek	model seri o saja Opsi konfigurasi untuk model penalaran.	Tidak.
└─ usaha	OpenAI.ReasoningEffort	model seri o 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.	Tidak.
└─ menghasilkan_ringkasan	enum	Tidak digunakan lagi: gunakan summary sebagai gantinya. Ringkasan penalaran yang dilakukan oleh model. Ini dapat berguna untuk men-debug dan memahami proses penalaran model. Salah satu dari auto, concise, atau detailed. Nilai yang mungkin: auto, concise, detailed	Tidak.
└─ ringkasan	enum	Ringkasan penalaran yang dilakukan oleh model. Ini dapat berguna untuk men-debug dan memahami proses penalaran model. Salah satu dari auto, concise, atau detailed. Nilai yang mungkin: auto, concise, detailed	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
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
kirim pesan teks	objek	Opsi konfigurasi untuk respons teks dari model. Dapat berupa teks biasa atau data JSON terstruktur.	Tidak.
└─ bentuk	OpenAI.ResponseTextFormatConfiguration		Tidak.
tool_choice	objek	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.	Tidak.
└─ jenis	OpenAI.ToolChoiceObjectType	Menunjukkan bahwa model harus menggunakan alat bawaan untuk menghasilkan respons.	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, seperti pencarian file. - Panggilan fungsi (alat kustom): Fungsi yang ditentukan oleh Anda, memungkinkan model untuk memanggil kode Anda sendiri.	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.	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
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.
pengguna	string	Pengidentifikasi unik yang mewakili pengguna akhir Anda, yang dapat membantu OpenAI memantau dan mendeteksi penyalahgunaan.	Tidak.

AzureCreateSpeechRequestMultiPart

Representasi opsi permintaan yang mengendalikan perilaku operasi konversi teks ke suara.

Nama	Tipe	Deskripsi	Diperlukan	Default
Masukan	string	Teks yang akan dihasilkan audionya. Panjang maksimum adalah 4096 karakter.	Yes
instructions	string	Kontrol suara audio yang Anda hasilkan dengan instruksi tambahan. Tidak berfungsi dengan tts-1 atau tts-1-hd.	Tidak.
model	string	Model yang digunakan untuk permintaan konversi teks ke suara ini.	Yes
response_format	objek	Format output audio yang didukung untuk teks ke ucapan.	Tidak.
speed	nomor/angka	Kecepatan ucapan untuk audio yang dihasilkan. Nilai valid berada dalam rentang dari 0,25 hingga 4,0, dengan 1,0 sebagai nilai default dan nilai yang lebih tinggi menghasilkan ucapan yang lebih cepat.	Tidak.	1
stream_format	enum	Format untuk mengalirkan audio. Format yang didukung adalah sse dan audio. sse tidak didukung untuk tts-1 atau tts-1-hd. Nilai yang mungkin: sse, audio	Tidak.
voice	objek		Yes

AzureCreateTranscriptionRequestMultiPart

Informasi konfigurasi untuk permintaan transkripsi audio.

Nama	Tipe	Deskripsi	Diperlukan	Default
chunking_strategy	objek		Tidak.
└─ prefix_padding_ms (isian_awalan_dalam_milidetik)	bilangan bulat	Jumlah audio yang akan disertakan sebelum ucapan yang terdeteksi oleh VAD (dalam milidetik).	Tidak.	300
└─ durasi_keheningan_dalam_milidetik (silence_duration_ms)	bilangan bulat	Durasi keheningan untuk mendeteksi pemberhentian ucapan (dalam milidetik). Dengan nilai yang lebih pendek, model akan merespons lebih cepat, tetapi mungkin melompat pada jeda singkat dari pengguna.	Tidak.	200
└─ ambang batas	nomor/angka	Ambang sensitivitas (0,0 hingga 1,0) untuk deteksi aktivitas suara. 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.	0,5
└─ jenis	enum	Harus diatur ke server_vad untuk mengaktifkan penggugusan manual menggunakan VAD sisi server. Nilai yang mungkin: server_vad	Tidak.
berkas	string		Yes
filename	string	Nama file atau pengidentifikasi deskriptif opsional untuk mengaitkannya dengan data audio.	Tidak.
include[]	array	Informasi tambahan untuk disertakan dalam respons transkripsi. logprobs akan mengembalikan probabilitas log token dalam respons untuk memahami keyakinan model dalam transkripsi. logprobs hanya berfungsi dengan response_format diatur ke json dan hanya dengan model gpt-4o-transcribe, gpt-4o-transcribe-diarize, gpt-4o-mini-transcribe, dan gpt-4o-mini-transcribe-2025-12-15.	Tidak.
bahasa	string	Bahasa audio input. Menyediakan bahasa input dalam format ISO-639-1 (misalnya en) akan meningkatkan akurasi dan latensi.	Tidak.
model	string	Model yang digunakan untuk permintaan transkripsi ini.	Tidak.
minta	string	Teks opsional untuk memandu gaya model atau melanjutkan segmen audio sebelumnya. Perintah harus cocok dengan bahasa audio.	Tidak.
response_format	objek		Tidak.
aliran	Boolean	Jika diatur ke true, data respons model akan dialirkan ke klien saat dibuat menggunakan peristiwa yang dikirim server. Catatan: Streaming tidak didukung untuk whisper-1 model dan akan diabaikan.	Tidak.	False
suhu	nomor/angka	Suhu pengambilan sampel, antara 0 dan 1. Nilai yang lebih tinggi seperti 0,8 akan membuat output lebih acak, sementara nilai yang lebih rendah seperti 0,2 akan membuatnya lebih fokus dan deterministik. Jika diatur ke 0, model akan menggunakan probabilitas log untuk secara otomatis meningkatkan suhu hingga ambang batas tertentu terpukul.	Tidak.	0
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']

AzureCreateTranslationRequestMultiPart

Informasi konfigurasi untuk permintaan transkripsi audio.

Nama	Tipe	Deskripsi	Diperlukan	Default
berkas	string		Yes
filename	string	Nama file opsional atau pengidentifikasi deskriptif untuk dikaitkan dengan data audio	Tidak.
model	string	Model yang digunakan untuk permintaan terjemahan ini.	Tidak.
minta	string	Teks opsional untuk memandu gaya model atau melanjutkan segmen audio sebelumnya. Prompt harus dalam bahasa Inggris.	Tidak.
response_format	objek		Tidak.
suhu	nomor/angka	Suhu pengambilan sampel, antara 0 dan 1. Nilai yang lebih tinggi seperti 0,8 akan membuat output lebih acak, sementara nilai yang lebih rendah seperti 0,2 akan membuatnya lebih fokus dan deterministik. Jika diatur ke 0, model akan menggunakan probabilitas log untuk secara otomatis meningkatkan suhu hingga ambang batas tertentu terpukul.	Tidak.	0

AzureErrorResponse

Nama	Tipe	Deskripsi	Diperlukan	Default
galat	objek	Detail kesalahan.	Tidak.
└─ kode	string	Pengidentifikasi unik yang digenerasikan oleh mesin untuk kesalahan tersebut.	Tidak.
└─ kesalahan_dalam			Tidak.
└─ pesan	string	Pesan yang mudah dipahami manusia yang terkait dengan kesalahan.	Tidak.
└─ param	string	Jika relevan, parameter input permintaan yang terkait dengan kesalahan	Tidak.
└─ jenis	enum	Jenis objeknya, selalu adalah 'error'. Nilai yang mungkin: error	Tidak.

AzureEvalAPICompletionsSamplingParams

Nama	Tipe	Deskripsi	Diperlukan	Default
pemanggilan_alat_paralel	Boolean		Tidak.
response_format	OpenAI.ResponseTextFormatConfiguration		Tidak.
perangkat	array		Tidak.

AzureEvalAPIModelSamplingParams

Nama	Tipe	Deskripsi	Diperlukan	Default
maksimum token	bilangan bulat	Jumlah maksimum token dalam output yang dihasilkan.	Tidak.
upaya penalaran	enum	Mengontrol tingkat upaya penalaran yang diterapkan selama pembuatan. Nilai yang mungkin: low, medium, high	Tidak.
seed	bilangan bulat	Nilai awal untuk menginisialisasi keacakan selama pengambilan sampel.	Tidak.
suhu	nomor/angka	Suhu yang lebih tinggi meningkatkan keacakan dalam output.	Tidak.
top_p	nomor/angka	Alternatif terhadap suhu dalam pengambilan sampel inti; 1.0 mencakup semua token.	Tidak.

AzureEvalAPIResponseSamplingParams

Nama	Tipe	Deskripsi	Diperlukan	Default
pemanggilan_alat_paralel	Boolean		Tidak.
response_format	OpenAI.ResponseTextFormatConfiguration		Tidak.
perangkat	array		Tidak.

AzureFileExpiryAnchor

Harta benda	Nilai
Jenis	string
Nilai	created_at

AzureFineTuneReinforcementMethod

Nama	Tipe	Deskripsi	Diperlukan	Default
Grader	objek	Objek StringCheckGrader yang melakukan perbandingan string antara input dan referensi menggunakan operasi tertentu.	Yes
└─ calculate_output (menghitung_output)	string	Rumus untuk menghitung output berdasarkan hasil grader.	Tidak.
└─ metrik_penilaian	enum	Metrik evaluasi yang akan digunakan. Salah satu dari fuzzy_match, , bleugleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5, atau rouge_l. Nilai yang mungkin: fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5, rouge_l	Tidak.
└─ siswa kelas	objek		Tidak.
└─ masukan	array	Teks input. Ini mungkin termasuk string templat.	Tidak.
└─ model	string	Model yang digunakan untuk evaluasi.	Tidak.
└─ nama	string	Nama penilai.	Tidak.
└─ operasi	enum	Operasi pemeriksaan string yang perlu dilakukan. Salah satu dari eq, ne, like, atau ilike. Nilai yang mungkin: eq, ne, like, ilike	Tidak.
└─ rentang	array	Rentang skor. Secara default menjadi [0, 1].	Tidak.
└─ referensi	string	Teks yang sedang dinilai.	Tidak.
└─ parameter_pengambilan_sampel		Parameter pengambilan sampel untuk model.	Tidak.
└─ jenis	enum	Tipe objek, yang selalu multi. Nilai yang mungkin: multi	Tidak.
hyperparameter	OpenAI.FineTuneReinforcementHyperparameters	Hyperparameter yang digunakan untuk pekerjaan penyempurnaan penguatan.	Tidak.
response_format	objek		Tidak.
└─ json_schema	objek	Skema JSON untuk format respons	Tidak.
└─ jenis	enum	Jenis format respons. Nilai yang mungkin: json_schema	Tidak.

AzureImage

Nama	Tipe	Deskripsi	Diperlukan	Default
b64_json	string	JSON yang dikodekan base64 dari gambar yang dihasilkan. Nilai default untuk model seri gpt-image-1, dan hanya tersedia jika response_format disetel ke b64_json untuk dall-e-2 dan dall-e-3.	Tidak.
content_filter_results	AzureContentFilterImageResponseResults	Hasil filter konten untuk konten respons output operasi pembuatan gambar.	Yes
prompt_filter_results	AzureContentFilterImagePromptResults	Hasil filter konten untuk konten permintaan input operasi pembuatan gambar.	Yes
petunjuk_direvisi	string	Hanya dall-e-3 , perintah yang direvisi yang digunakan untuk menghasilkan gambar.	Tidak.
URL	string	Saat menggunakan dall-e-2 atau dall-e-3, URL gambar yang dihasilkan jika response_format diatur ke url (nilai default). Tidak didukung untuk seri gpt-image-1.	Tidak.

AzureImagesResponse

Nama	Tipe	Deskripsi	Diperlukan	Default
latar belakang	enum	Parameter latar belakang yang digunakan untuk pembuatan gambar. Entah transparent atau opaque. Nilai yang mungkin: transparent, opaque	Tidak.
Dibuat	bilangan bulat	Tanda waktu Unix (dalam detik) saat gambar dibuat.	Yes
data	array		Tidak.
format keluaran	enum	Format output pembuatan gambar. Baik png, webp, maupun jpeg. Nilai yang mungkin: png, webp, jpeg	Tidak.
kualitas	enum	Kualitas gambar yang dihasilkan. Baik low, medium, maupun high. Nilai yang mungkin: low, medium, high	Tidak.
ukuran	enum	Ukuran gambar yang dihasilkan. Baik 1024x1024, 1024x1536, maupun 1536x1024. Nilai yang mungkin: 1024x1024, 1024x1536, 1536x1024	Tidak.
usage	objek	Hanya untuk model seri gpt-image-1, informasi penggunaan token untuk pembuatan gambar.	Tidak.
└─ token_masukan	bilangan bulat	Jumlah token (gambar dan teks) dalam prompt input.	Tidak.
└─ detil_token_masukan	objek	Token input memberikan informasi terperinci untuk proses pembuatan gambar.	Tidak.
└─ token_gambar	bilangan bulat	Jumlah token gambar dalam prompt input.	Tidak.
└─ text_tokens	bilangan bulat	Jumlah token teks dalam prompt input.	Tidak.
└─ output_tokens	bilangan bulat	Jumlah token gambar dalam gambar output.	Tidak.
└─ jumlah_token	bilangan bulat	Jumlah total token (gambar dan teks) yang digunakan untuk pembuatan gambar.	Tidak.

AzureListFilesResponse

Nama	Tipe	Deskripsi	Diperlukan	Default
data	array		Yes
first_id	string		Yes
ada_lagi	Boolean		Yes
ID terakhir	string		Yes
objek	enum	Nilai yang mungkin: list	Yes

AzureOpenAIFile

Nama	Tipe	Deskripsi	Diperlukan	Default
Byte	bilangan bulat	Ukuran file, dalam byte.	Yes
dibuat_pada	bilangan bulat	Tanda waktu Unix (dalam detik) saat file dibuat.	Yes
kedaluwarsa_pada	bilangan bulat	Tanda waktu Unix (dalam detik) untuk kapan file akan kedaluwarsa.	Tidak.
filename	string	Nama berkas tersebut.	Yes
id	string	Pengidentifikasi file, yang dapat dirujuk di titik akhir API.	Yes
objek	enum	Tipe objek, yang selalu file. Nilai yang mungkin: file	Yes
purpose	enum	Tujuan file yang dimaksudkan. Nilai yang didukung adalah assistants, , assistants_outputbatch, batch_output, fine-tune dan fine-tune-results. Nilai yang mungkin: assistants, , assistants_outputbatch, batch_output, fine-tune, , fine-tune-resultsevals	Yes
status	enum	Nilai yang mungkin: uploaded, , pendingrunning, processed, error, , deletingdeleted	Yes
status_details	string	Deprecated. Untuk detail tentang mengapa file pelatihan penyempurnaan gagal validasi, lihat error bidang di fine_tuning.job.	Tidak.

AzureOpenAIVideoGenerationErrorResponse

Nama	Tipe	Deskripsi	Diperlukan	Default
kode	string	Pengidentifikasi unik yang digenerasikan oleh mesin untuk kesalahan tersebut.	Tidak.
inner_error	objek	Jika berlaku, kesalahan hulu yang menyebabkan kesalahan ini.	Tidak.
└─ kode	enum	Kode terkait dengan kesalahan internal. Nilai yang mungkin: ResponsibleAIPolicyViolation	Tidak.
└─ rincian_kesalahan		Detail hasil filter konten yang terkait dengan kesalahan dalam.	Tidak.
└─ prompt_yang_direvisi	string	Jika berlaku, instruksi yang dimodifikasi digunakan untuk pembuatan.	Tidak.
pesan	string	Pesan yang mudah dipahami manusia yang terkait dengan kesalahan.	Tidak.
param	string	Jika relevan, parameter input permintaan yang terkait dengan kesalahan	Tidak.
jenis	string	Jika ada, nomor baris input yang dimaksud terkait dengan kesalahan.	Tidak.

AzureResponse

Nama	Tipe	Deskripsi	Diperlukan	Default
latar belakang	Boolean	Apakah akan menjalankan respons model di latar belakang.	Tidak.	False
dibuat_pada	bilangan bulat	Tanda waktu Unix (dalam detik) saat Respons ini dibuat.	Yes
galat	objek	Objek kesalahan dikembalikan saat model gagal menghasilkan Respons.	Yes
└─ kode	OpenAI.ResponseErrorCode	Kode kesalahan untuk respons.	Tidak.
└─ pesan	string	Deskripsi kesalahan yang dapat dibaca manusia.	Tidak.
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 atau array		Yes
max_output_tokens	bilangan bulat	Batas atas untuk jumlah token yang dapat dihasilkan untuk respons, termasuk token output yang terlihat dan token penalaran	Tidak.
max_tool_calls	bilangan bulat	Jumlah maksimum total panggilan ke alat bawaan yang dapat diproses dalam respons. Jumlah maksimum ini berlaku di semua panggilan alat bawaan, bukan per alat individual. Setiap upaya lebih lanjut untuk memanggil alat oleh model akan diabaikan.	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, 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 ini.	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.
minta	objek	Referensi ke templat perintah dan variabelnya.	Tidak.
└─ ID	string	Pengidentifikasi unik templat perintah yang akan digunakan.	Tidak.
└─ variabel	OpenAI.ResponsePromptVariables	Peta nilai opsional untuk mengganti variabel dalam perintah Anda. Nilai substitusi dapat berupa string, atau jenis input Respons lainnya seperti gambar atau file.	Tidak.
└─ versi	string	Versi opsional templat prompt.	Tidak.
reasoning	objek	model seri o saja Opsi konfigurasi untuk model penalaran.	Tidak.
└─ usaha	OpenAI.ReasoningEffort	model seri o 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.	Tidak.
└─ menghasilkan_ringkasan	enum	Tidak digunakan lagi: gunakan summary sebagai gantinya. Ringkasan penalaran yang dilakukan oleh model. Ini dapat berguna untuk men-debug dan memahami proses penalaran model. Salah satu dari auto, concise, atau detailed. Nilai yang mungkin: auto, concise, detailed	Tidak.
└─ ringkasan	enum	Ringkasan penalaran yang dilakukan oleh model. Ini dapat berguna untuk men-debug dan memahami proses penalaran model. Salah satu dari auto, concise, atau detailed. Nilai yang mungkin: auto, concise, detailed	Tidak.
status	enum	Status generasi respons. Salah satu dari completed, , failedin_progress, cancelled, queued, atau incomplete. Nilai yang mungkin: completed, , failedin_progress, cancelled, queued,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
kirim pesan teks	objek	Opsi konfigurasi untuk respons teks dari model. Dapat berupa teks biasa atau data JSON terstruktur.	Tidak.
└─ bentuk	OpenAI.ResponseTextFormatConfiguration		Tidak.
tool_choice	objek	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.	Tidak.
└─ jenis	OpenAI.ToolChoiceObjectType	Menunjukkan bahwa model harus menggunakan alat bawaan untuk menghasilkan respons.	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.
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.	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.	Yes
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	OpenAI.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.	Yes

AzureSearchChatDataSource

Mewakili konfigurasi sumber data yang akan menggunakan sumber daya Pencarian Azure.

Nama	Tipe	Deskripsi	Diperlukan	Default
parameter	objek	Informasi parameter untuk mengontrol penggunaan sumber data pencarian Azure.	Yes
└─ izinkan_hasil_parsial	Boolean	Jika diatur ke true, sistem akan mengizinkan hasil pencarian parsial digunakan dan permintaan akan gagal jika semua kueri parsial gagal. Jika tidak ditentukan atau ditentukan sebagai false, permintaan akan gagal jika ada kueri pencarian yang gagal.	Tidak.	False
└─ autentikasi	objek		Tidak.
└─ akses_token	string		Tidak.
└─ kunci	string		Tidak.
└─ id_sumber_daya_identitas_dikelola	string		Tidak.
└─ jenis	enum	Nilai yang mungkin: access_token	Tidak.
└─ ketergantungan_embedding	objek	Mewakili sumber vektorisasi yang melakukan panggilan layanan publik terhadap penyebaran model penyematan OpenAI Azure.	Tidak.
└─ autentikasi	AzureChatDataSourceApiKeyAuthenticationOptions atau AzureChatDataSourceAccessTokenAuthenticationOptions	Mekanisme autentikasi untuk digunakan dengan sumber vektorisasi berbasis titik akhir. Autentikasi titik akhir mendukung kunci API dan mekanisme token access.	Tidak.
└─ "deployment_name"	string	Model penyematan yang diterapkan untuk digunakan dalam vektorisasi. Penyebaran ini harus ada dalam sumber daya OpenAI Azure yang sama dengan penyebaran model yang digunakan untuk penyelesaian obrolan.	Tidak.
└─ dimensi	bilangan bulat	Jumlah dimensi yang diminta pada penyematan. Hanya didukung dalam 'text-embedding-3' dan model 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	enum	Pengidentifikasi jenis, selalu 'terintegrasi' untuk jenis sumber vektorisasi ini. Nilai yang mungkin: integrated	Tidak.
└─ titik akhir	string	Jalur titik akhir absolut untuk sumber daya pencarian Azure digunakan.	Tidak.
└─ pemetaan_bidang	objek	Pemetaan bidang yang akan digunakan dengan sumber daya pencarian Azure.	Tidak.
└─ kolom_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_vektor_gambar	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.
└─ bidang_vektor	array	Nama bidang yang mewakili data vektor.	Tidak.
└─ filter	string	Filter yang diterapkan pada pencarian.	Tidak.
└─ in_scope	Boolean	Apakah kueri harus dibatasi untuk menggunakan data terindeks.	Tidak.
└─ sertakan_konteks	array	Properti konteks output untuk disertakan pada respons. Secara default, kutipan dan niat akan diminta.	Tidak.	['kutipan', 'tujuan']
└─ nama_indeks	string	Nama indeks yang akan digunakan, seperti yang ditentukan dalam sumber daya pencarian Azure.	Tidak.
└─ kueri_pencarian_maksimum	bilangan bulat	Jumlah maksimum kueri yang ditulis ulang yang harus dikirim ke penyedia pencarian untuk satu pesan pengguna. Secara default, sistem akan membuat penentuan otomatis.	Tidak.
└─ jenis_permintaan	enum	Jenis kueri untuk sumber daya Pencarian Azure yang akan digunakan. Nilai yang mungkin: simple, , semanticvector, vector_simple_hybrid,vector_semantic_hybrid	Tidak.
└─ konfigurasi_semantik	string	Konfigurasi semantik tambahan untuk kueri.	Tidak.
└─ keketatan	bilangan bulat	Ketatnya pemfilteran relevansi pencarian yang dikonfigurasi. Ketegasan yang lebih tinggi akan meningkatkan presisi tetapi pengenalan jawaban yang lebih rendah.	Tidak.
└─ top_n_documents	bilangan bulat	Jumlah dokumen yang dikonfigurasi untuk ditampilkan dalam kueri.	Tidak.
jenis	enum	Pengidentifikasi jenis yang didiskriminasi, yang selalu 'azure_search'. Nilai yang mungkin: azure_search	Yes

AzureUserSecurityContext

Konteks keamanan pengguna berisi beberapa parameter yang menjelaskan aplikasi itu sendiri, dan pengguna akhir yang berinteraksi dengan aplikasi. 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 berbasis pengguna ganda.	Tidak.
source_ip	string	Mengambil alamat IP klien asli.	Tidak.

ChatCompletionMessageToolCallsItem

Panggilan alat yang dihasilkan oleh model, seperti panggilan fungsi.

Array dari: OpenAI.ChatCompletionMessageToolCall

CreateVideoGenerationRequest

Nama	Tipe	Deskripsi	Diperlukan	Default
height	bilangan bulat	Tinggi video. Dimensi berikut didukung: 480x480, 854x480, 720x720, 1280x720, 1080x1080 dan 1920x1080 dalam orientasi lanskap dan potret.	Yes
model	string	Nama penyebaran yang akan digunakan untuk permintaan ini.	Yes
n_seconds	bilangan bulat	Durasi pekerjaan pembuatan video. Harus antara 1 dan 20 detik.	Tidak.	5
n_variants	bilangan bulat	Jumlah video yang akan dibuat sebagai varian untuk pekerjaan ini. Harus antara 1 dan 5. Dimensi yang lebih kecil memungkinkan lebih banyak varian.	Tidak.	1
minta	string	Arahan untuk pekerjaan pembuatan video ini.	Yes
width	bilangan bulat	Lebar dari video. Dimensi berikut didukung: 480x480, 854x480, 720x720, 1280x720, 1080x1080 dan 1920x1080 dalam orientasi lanskap dan potret.	Yes

CreateVideoGenerationWithMediaRequestMultiPart

Properti permintaan pekerjaan pembuatan video dengan file media.

Nama	Tipe	Deskripsi	Diperlukan	Default
files	array		Yes
height	bilangan bulat	Tinggi video. Dimensi berikut didukung: 480x480, 854x480, 720x720, 1280x720, 1080x1080 dan 1920x1080 dalam orientasi lanskap dan potret.	Yes
inpaint_items	array	Item inpainting opsional untuk pekerjaan pembuatan video ini.	Tidak.
model	string	Nama penyebaran yang akan digunakan untuk permintaan ini.	Yes
n_seconds	bilangan bulat	Durasi pekerjaan pembuatan video. Harus antara 1 dan 20 detik.	Tidak.	5
n_variants	bilangan bulat	Jumlah video yang akan dibuat sebagai varian untuk pekerjaan ini. Harus antara 1 dan 5. Dimensi yang lebih kecil memungkinkan lebih banyak varian.	Tidak.	1
minta	string	Arahan untuk pekerjaan pembuatan video ini.	Yes
width	bilangan bulat	Lebar dari video. Dimensi berikut didukung: 480x480, 854x480, 720x720, 1280x720, 1080x1080 dan 1920x1080 dalam orientasi lanskap dan potret.	Yes

Batas Pemangkasan

Pemangkasan terikat untuk item yang dipainting. Ini menentukan area item media yang harus digunakan untuk pemakaian.

Nama	Tipe	Deskripsi	Diperlukan	Default
bottom_fraction	nomor/angka	Batas bawah kotak potong ditentukan sebagai pecahan tinggi item media asli. Harus antara 0,0 dan 1,0. Gunakan misalnya 0,5 untuk setengah tinggi item media asli.	Tidak.	1
left_fraction	nomor/angka	Batas kiri kotak potong ditentukan sebagai pecahan lebar item media asli. Harus antara 0,0 dan 1,0. Gunakan misalnya 0,5 untuk setengah lebar item media asli.	Tidak.	0
right_fraction	nomor/angka	Batas kanan kotak potong yang ditentukan sebagai pecahan lebar item media asli. Harus antara 0,0 dan 1,0. Gunakan misalnya 0,5 untuk setengah lebar item media asli.	Tidak.	1
top_fraction	nomor/angka	Batas atas kotak pemangkasan ditentukan sebagai pecahan dari tinggi item media asli. Harus antara 0,0 dan 1,0. Gunakan misalnya 0,5 untuk setengah tinggi item media asli.	Tidak.	0

ElasticsearchChatDataSource

Nama	Tipe	Deskripsi	Diperlukan	Default
parameter	objek	Informasi parameter untuk mengontrol penggunaan sumber data Elasticsearch.	Yes
└─ izinkan_hasil_parsial	Boolean	Jika diatur ke true, sistem akan mengizinkan hasil pencarian parsial digunakan dan permintaan akan gagal jika semua kueri parsial gagal. Jika tidak ditentukan atau ditentukan sebagai false, permintaan akan gagal jika ada kueri pencarian yang gagal.	Tidak.	False
└─ autentikasi	objek		Tidak.
└─ kunci_api_terenkripsi	string		Tidak.
└─ kunci	string		Tidak.
└─ key_id	string		Tidak.
└─ jenis	enum	Nilai yang mungkin: encoded_api_key	Tidak.
└─ ketergantungan_embedding	AzureChatDataSourceVectorizationSource	Representasi sumber vektorisasi data yang dapat digunakan sebagai resource embedding pada sumber data.	Tidak.
└─ titik akhir	string		Tidak.
└─ pemetaan_bidang	objek		Tidak.
└─ kolom_konten	array		Tidak.
└─ pemisah_bidang_konten	string		Tidak.
└─ filepath_field	string		Tidak.
└─ bidang_judul	string		Tidak.
└─ url_field	string		Tidak.
└─ bidang_vektor	array		Tidak.
└─ in_scope	Boolean	Apakah kueri harus dibatasi untuk menggunakan data terindeks.	Tidak.
└─ sertakan_konteks	array	Properti konteks output untuk disertakan pada respons. Secara default, kutipan dan niat akan diminta.	Tidak.	['kutipan', 'tujuan']
└─ nama_indeks	string		Tidak.
└─ kueri_pencarian_maksimum	bilangan bulat	Jumlah maksimum kueri yang ditulis ulang yang harus dikirim ke penyedia pencarian untuk satu pesan pengguna. Secara default, sistem akan membuat penentuan otomatis.	Tidak.
└─ jenis_permintaan	enum	Nilai yang mungkin: simple, vector	Tidak.
└─ keketatan	bilangan bulat	Ketatnya pemfilteran relevansi pencarian yang dikonfigurasi. Ketegasan yang lebih tinggi akan meningkatkan presisi tetapi pengenalan jawaban yang lebih rendah.	Tidak.
└─ top_n_documents	bilangan bulat	Jumlah dokumen yang dikonfigurasi untuk ditampilkan dalam kueri.	Tidak.
jenis	enum	Pengidentifikasi tipe yang dibedakan, yang selalu 'elasticsearch'. Nilai yang mungkin: elasticsearch	Yes

InpaintItem

Item inpainting untuk pekerjaan pembuatan video. Ini menentukan item media yang harus digunakan untuk pemasuan dalam pembuatan video.

Nama	Tipe	Deskripsi	Diperlukan	Default
crop_bounds	objek	Pemangkasan terikat untuk item yang dipainting. Ini menentukan area item media yang harus digunakan untuk pemakaian.	Tidak.
└─ pecahan_bagian_bawah	nomor/angka	Batas bawah kotak potong ditentukan sebagai pecahan tinggi item media asli. Harus antara 0,0 dan 1,0. Gunakan misalnya 0,5 untuk setengah tinggi item media asli.	Tidak.	1
└─ pecahan_kiri	nomor/angka	Batas kiri kotak potong ditentukan sebagai pecahan lebar item media asli. Harus antara 0,0 dan 1,0. Gunakan misalnya 0,5 untuk setengah lebar item media asli.	Tidak.	0
└─ pecahan_kanan	nomor/angka	Batas kanan kotak potong yang ditentukan sebagai pecahan lebar item media asli. Harus antara 0,0 dan 1,0. Gunakan misalnya 0,5 untuk setengah lebar item media asli.	Tidak.	1
└─ top_fraction	nomor/angka	Batas atas kotak pemangkasan ditentukan sebagai pecahan dari tinggi item media asli. Harus antara 0,0 dan 1,0. Gunakan misalnya 0,5 untuk setengah tinggi item media asli.	Tidak.	0
file_name	string	Nama file item media. Ini harus cocok dengan nama file lampiran file dalam permintaan ini.	Yes
frame_index	bilangan bulat	Indeks bingkai untuk item media ini. Ini menentukan bingkai awal dalam video yang dihasilkan yang dihasilkan untuk item inpainting ini.	Yes	0
jenis	objek	Jenis item inpainting.	Yes

JobStatus

Status pekerjaan pembuatan video.

Harta benda	Nilai
Deskripsi	Status pekerjaan pembuatan video.
Jenis	string
Nilai	preprocessing queued running processing cancelled succeeded failed

MediaItemType

Jenis item inpainting.

Harta benda	Nilai
Deskripsi	Jenis item inpainting.
Jenis	string
Nilai	image

MongoDBChatDataSource

Nama	Tipe	Deskripsi	Diperlukan	Default
parameter	objek	Informasi parameter untuk mengontrol penggunaan sumber data MongoDB.	Yes
└─ izinkan_hasil_parsial	Boolean	Jika diatur ke true, sistem akan mengizinkan hasil pencarian parsial digunakan dan permintaan akan gagal jika semua kueri parsial gagal. Jika tidak ditentukan atau ditentukan sebagai false, permintaan akan gagal jika ada kueri pencarian yang gagal.	Tidak.	False
└─ nama_aplikasi	string	Nama aplikasi MongoDB.	Tidak.
└─ autentikasi	objek		Tidak.
└─ kata sandi	string		Tidak.
└─ jenis	enum	Nilai yang mungkin: username_and_password	Tidak.
└─ nama pengguna	string		Tidak.
└─ nama_koleksi	string	Nama koleksi MongoDB.	Tidak.
└─ database_name	string	Nama database MongoDB.	Tidak.
└─ ketergantungan_embedding	objek	Mewakili sumber vektorisasi yang melakukan panggilan layanan publik terhadap penyebaran model penyematan OpenAI Azure.	Tidak.
└─ autentikasi	AzureChatDataSourceApiKeyAuthenticationOptions atau AzureChatDataSourceAccessTokenAuthenticationOptions	Mekanisme autentikasi untuk digunakan dengan sumber vektorisasi berbasis titik akhir. Autentikasi titik akhir mendukung kunci API dan mekanisme token access.	Tidak.
└─ "deployment_name"	string	Model penyematan yang diterapkan untuk digunakan dalam vektorisasi. Penyebaran ini harus ada dalam sumber daya OpenAI Azure yang sama dengan penyebaran model yang digunakan untuk penyelesaian obrolan.	Tidak.
└─ dimensi	bilangan bulat	Jumlah dimensi yang diminta pada penyematan. Hanya didukung dalam 'text-embedding-3' dan model 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	enum	Pengidentifikasi jenis, selalu 'deployment_name' untuk jenis sumber vektorisasi ini. Nilai yang mungkin: deployment_name	Tidak.
└─ titik akhir	string	Nama titik akhir kluster MongoDB.	Tidak.
└─ pemetaan_bidang	objek	Pemetaan bidang untuk diterapkan ke data yang digunakan oleh sumber data MongoDB. Perhatikan bahwa pemetaan bidang konten dan vektor diperlukan untuk MongoDB.	Tidak.
└─ kolom_konten	array		Tidak.
└─ pemisah_bidang_konten	string		Tidak.
└─ filepath_field	string		Tidak.
└─ bidang_judul	string		Tidak.
└─ url_field	string		Tidak.
└─ bidang_vektor	array		Tidak.
└─ in_scope	Boolean	Apakah kueri harus dibatasi untuk menggunakan data terindeks.	Tidak.
└─ sertakan_konteks	array	Properti konteks output untuk disertakan pada respons. Secara default, kutipan dan niat akan diminta.	Tidak.	['kutipan', 'tujuan']
└─ nama_indeks	string	Nama indeks MongoDB.	Tidak.
└─ kueri_pencarian_maksimum	bilangan bulat	Jumlah maksimum kueri yang ditulis ulang yang harus dikirim ke penyedia pencarian untuk satu pesan pengguna. Secara default, sistem akan membuat penentuan otomatis.	Tidak.
└─ keketatan	bilangan bulat	Ketatnya pemfilteran relevansi pencarian yang dikonfigurasi. Ketegasan yang lebih tinggi akan meningkatkan presisi tetapi pengenalan jawaban yang lebih rendah.	Tidak.
└─ top_n_documents	bilangan bulat	Jumlah dokumen yang dikonfigurasi untuk ditampilkan dalam kueri.	Tidak.
jenis	enum	Pengidentifikasi jenis yang dibedakan, yang selalu 'mongo_db'. Nilai yang mungkin: mongo_db	Yes

OpenAI.Annotation

Diskriminator untuk OpenAI.Anotasi

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
file_citation	OpenAI.AnnotationFileCitation
url_citation	OpenAI.AnnotationUrlCitation
file_path	OpenAI.AnnotationFilePath

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	OpenAI.AnnotationType		Yes

OpenAI.AnnotationFileCitation

Kutipan ke file.

Nama	Tipe	Deskripsi	Diperlukan	Default
file_id	string	ID file.	Yes
filename	string	Nama file file yang dikutip.	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

OpenAI.AnnotationFilePath

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

OpenAI.AnnotationType

Harta benda	Nilai
Jenis	string
Nilai	file_citation url_citation file_path container_file_citation

OpenAI.AnnotationUrlCitation

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

OpenAI.ApproximateLocation

Nama	Tipe	Deskripsi	Diperlukan	Default
kota	string		Tidak.
country	string		Tidak.
region	string		Tidak.
zona waktu	string		Tidak.
jenis	enum	Nilai yang mungkin: approximate	Yes

OpenAI.AudioResponseFormat

Format output, dalam salah satu opsi ini: json, , text, srtverbose_json, atau vtt. Untuk gpt-4o-transcribe, gpt-4o-transcribe-diarize, gpt-4o-mini-transcribe, dan gpt-4o-mini-transcribe-2025-12-15. Satu-satunya format yang didukung adalah json.

Harta benda	Nilai
Deskripsi	Format output, dalam salah satu opsi ini: json, , text, srtverbose_json, atau vtt. Untuk gpt-4o-transcribe, gpt-4o-transcribe-diarize, gpt-4o-mini-transcribe, dan gpt-4o-mini-transcribe-2025-12-15. Satu-satunya format yang didukung adalah json.
Jenis	string
Nilai	json text srt verbose_json vtt

OpenAI.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

OpenAI.ChatCompletionFunctionCallOption

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

OpenAI.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		Parameter yang diterima fungsi, dijelaskan sebagai objek Skema JSON. Lihat referensi Skema JSON untuk dokumentasi tentang format. Menghilangkan parameters mendefinisikan fungsi dengan daftar parameter kosong.	Tidak.

OpenAI.ChatCompletionMessageAudioChunk

Nama	Tipe	Deskripsi	Diperlukan	Default
data	string		Tidak.
kedaluwarsa_pada	bilangan bulat		Tidak.
id	string		Tidak.
transkrip	string		Tidak.

OpenAI.ChatCompletionMessageToolCall

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	enum	Jenis alat. Saat ini, hanya function didukung. Nilai yang mungkin: function	Yes

OpenAI.ChatCompletionMessageToolCallChunk

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.

OpenAI.ChatCompletionNamedToolChoice

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

OpenAI.ChatCompletionRequestAssistantMessage

Pesan yang dikirim oleh model sebagai respons terhadap pesan pengguna.

Nama	Tipe	Deskripsi	Diperlukan	Default
audio	objek	Data tentang respons audio sebelumnya dari model.	Tidak.
└─ ID	string	Pengidentifikasi unik untuk respons audio sebelumnya dari model.	Tidak.
isi	string atau array		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		Tidak.
└─ nama	string		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	ChatCompletionMessageToolCallsItem	Panggilan alat yang dihasilkan oleh model, seperti panggilan fungsi.	Tidak.

OpenAI.ChatCompletionRequestAssistantMessageContentPart

Nama	Tipe	Deskripsi	Diperlukan	Default
refusal	string	Pesan penolakan yang dihasilkan oleh model.	Yes
kirim pesan teks	string	Isi teks.	Yes
jenis	enum	Jenis bagian konten. Nilai yang mungkin: refusal	Yes

OpenAI.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		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

OpenAI.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

OpenAI.ChatCompletionRequestMessage

Diskriminator untuk OpenAI.ChatCompletionRequestMessage

Komponen ini menggunakan properti role untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
system	OpenAI.ChatCompletionRequestSystemMessage
developer	OpenAI.ChatCompletionRequestDeveloperMessage
user	OpenAI.ChatCompletionRequestUserMessage
assistant	OpenAI.ChatCompletionRequestAssistantMessage
tool	OpenAI.ChatCompletionRequestToolMessage
function	OpenAI.ChatCompletionRequestFunctionMessage

Nama	Tipe	Deskripsi	Diperlukan	Default
isi	string atau array		Tidak.
peran	objek	Peran penulis pesan	Yes

OpenAI.ChatCompletionRequestMessageContentPart

Diskriminator/Pemilah untuk OpenAI.ChatCompletionRequestMessageContentPart

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
text	OpenAI.ChatCompletionRequestMessageContentPartText
image_url	OpenAI.ChatCompletionRequestMessageContentPartImage
refusal	OpenAI.ChatCompletionRequestMessageContentPartRefusal
file	OpenAI.ChatCompletionRequestMessageContentPartFile
input_audio	OpenAI.ChatCompletionRequestMessageContentPartAudio

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	OpenAI.ChatCompletionRequestMessageContentPartType		Yes

OpenAI.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

OpenAI.ChatCompletionRequestMessageContentPartFile

Nama	Tipe	Deskripsi	Diperlukan	Default
berkas	objek		Yes
└─ file_data	string	Data file yang dikodekan base64, digunakan saat meneruskan file ke model sebagai string.	Tidak.
└─ file_id	string	ID file yang diunggah untuk digunakan sebagai input.	Tidak.
└─ nama file	string	Nama file, digunakan saat meneruskan file ke model sebagai string.	Tidak.
jenis	enum	Jenis bagian konten. Selalu file. Nilai yang mungkin: file	Yes

OpenAI.ChatCompletionRequestMessageContentPartImage

Nama	Tipe	Deskripsi	Diperlukan	Default
image_url	objek		Yes
└─ rinci	enum	Menentukan tingkat detail gambar. 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

OpenAI.ChatCompletionRequestMessageContentPartRefusal

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

OpenAI.ChatCompletionRequestMessageContentPartText

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

OpenAI.ChatCompletionRequestMessageContentPartType

Harta benda	Nilai
Jenis	string
Nilai	text file input_audio image_url refusal

OpenAI.ChatCompletionRequestSystemMessage

Instruksi yang disediakan pengembang yang harus diikuti model, terlepas dari pesan yang dikirim oleh pengguna. Dengan model o1 dan yang lebih baru, gunakan pesan developer sebagai gantinya untuk tujuan ini.

Nama	Tipe	Deskripsi	Diperlukan	Default
isi	string atau array		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

OpenAI.ChatCompletionRequestSystemMessageContentPart

Referensi: OpenAI.ChatCompletionRequestMessageContentPartText

OpenAI.ChatCompletionRequestToolMessage

Nama	Tipe	Deskripsi	Diperlukan	Default
isi	string atau array		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

OpenAI.ChatCompletionRequestToolMessageContentPart

Referensi: OpenAI.ChatCompletionRequestMessageContentPartText

OpenAI.ChatCompletionRequestUserMessage

Pesan yang dikirim oleh pengguna akhir, berisi perintah atau informasi konteks tambahan.

Nama	Tipe	Deskripsi	Diperlukan	Default
isi	string atau array		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

OpenAI.ChatCompletionRequestUserMessageContentPart

Nama	Tipe	Deskripsi	Diperlukan	Default
berkas	objek		Yes
└─ file_data	string	Data file yang dikodekan base64, digunakan saat meneruskan file ke model sebagai string.	Tidak.
└─ file_id	string	ID file yang diunggah untuk digunakan sebagai input.	Tidak.
└─ nama file	string	Nama file, digunakan saat meneruskan file ke model sebagai string.	Tidak.
image_url	objek		Yes
└─ rinci	enum	Menentukan tingkat detail gambar. Nilai yang mungkin: auto, low, high	Tidak.
└─ url	string	Baik URL gambar atau data gambar yang telah dikodekan dalam base64.	Tidak.
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.
kirim pesan teks	string	Isi teks.	Yes
jenis	enum	Jenis bagian konten. Selalu file. Nilai yang mungkin: file	Yes

OpenAI.ChatCompletionRole

Peran penulis pesan

Harta benda	Nilai
Deskripsi	Peran penulis pesan
Jenis	string
Nilai	system developer user assistant tool function

OpenAI.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. NOTA: Jika aliran terganggu, Anda mungkin tidak menerima gugus penggunaan akhir yang berisi total penggunaan token untuk permintaan tersebut.	Tidak.

OpenAI.ChatCompletionStreamResponseDelta

Delta penyelesaian obrolan yang dihasilkan oleh respons model yang dialirkan.

Nama	Tipe	Deskripsi	Diperlukan	Default
audio	objek		Tidak.
└─ data	string		Tidak.
└─ berakhir_pada	bilangan bulat		Tidak.
└─ ID	string		Tidak.
└─ transkrip	string		Tidak.
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		Tidak.
└─ nama	string		Tidak.
refusal	string	Pesan penolakan yang dihasilkan oleh model.	Tidak.
peran	objek	Peran penulis pesan	Tidak.
tool_calls	array		Tidak.

OpenAI.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, jika berada dalam 20 token teratas yang paling mungkin. Jika tidak, nilai -9999.0 digunakan untuk menandakan bahwa token sangat tidak mungkin.	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

OpenAI.ChatCompletionTool

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

OpenAI.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.

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

OpenAI.ChatOutputPrediction

Representasi dasar output yang diprediksi dari model.

Diskriminator untuk OpenAI.ChatOutputPrediction

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
content	OpenAI.ChatOutputPredictionContent

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	OpenAI.ChatOutputPredictionType		Yes

OpenAI.ChatOutputPredictionContent

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

Nama	Tipe	Deskripsi	Diperlukan	Default
isi	string atau array		Yes
jenis	enum	Jenis konten yang diprediksi yang ingin Anda sediakan. Jenis ini saat ini selalu content. Nilai yang mungkin: content	Yes

OpenAI.ChatOutputPredictionType

Harta benda	Nilai
Jenis	string
Nilai	content

OpenAI.ChunkingStrategyRequestParam

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

Diskriminator untuk OpenAI.ChunkingStrategyRequestParam

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
static	OpenAI.StaticChunkingStrategyRequestParam

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	enum	Jenis strategi potongan. Nilai yang mungkin: auto, static	Yes

OpenAI.ChunkingStrategyResponseParam

Diskriminator untuk OpenAI.ChunkingStrategyResponseParam

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
other	OpenAI.OtherChunkingStrategyResponseParam
static	OpenAI.StaticChunkingStrategyResponseParam

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	enum	Nilai yang mungkin: static, other	Yes

OpenAI.CodeInterpreterOutput

Diskriminator untuk OpenAI.CodeInterpreterOutput

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
image	OpenAI.CodeInterpreterOutputImage
logs	OpenAI.CodeInterpreterOutputLogs

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	OpenAI.CodeInterpreterOutputType		Yes

OpenAI.CodeInterpreterOutputImage

Output gambar dari penerjemah kode.

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	enum	Jenis output. Selalu 'gambar'. Nilai yang mungkin: image	Yes
URL	string	URL output gambar dari penerjemah kode.	Yes

OpenAI.CodeInterpreterOutputLogs

Output log dari penerjemah kode.

Nama	Tipe	Deskripsi	Diperlukan	Default
logs	string	Output log dari penerjemah kode.	Yes
jenis	enum	Jenis output. Selalu 'log'. Nilai yang mungkin: logs	Yes

OpenAI.CodeInterpreterOutputType

Harta benda	Nilai
Jenis	string
Nilai	logs image

OpenAI.CodeInterpreterTool

Alat yang menjalankan kode Python untuk membantu menghasilkan respons terhadap perintah.

Nama	Tipe	Deskripsi	Diperlukan	Default
container	objek	Konfigurasi untuk kontainer penerjemah kode. Secara opsional tentukan ID file untuk menjalankan kode.	Yes
└─ file_ids	array	Daftar opsional file yang diunggah untuk tersedia untuk kode Anda.	Tidak.
└─ jenis	enum	Selalu auto. Nilai yang mungkin: auto	Tidak.
jenis	enum	Jenis alat penerjemah kode. Selalu code_interpreter. Nilai yang mungkin: code_interpreter	Yes

OpenAI.CodeInterpreterToolAuto

Konfigurasi untuk kontainer penerjemah kode. Secara opsional tentukan ID file untuk menjalankan kode.

Nama	Tipe	Deskripsi	Diperlukan	Default
file_ids	array	Daftar opsional file yang diunggah untuk tersedia untuk kode Anda.	Tidak.
jenis	enum	Selalu auto. Nilai yang mungkin: auto	Yes

OpenAI.CodeInterpreterToolCallItemParam

Panggilan alat untuk menjalankan kode.

Nama	Tipe	Deskripsi	Diperlukan	Default
kode	string	Kode yang akan dijalankan, atau null jika tidak tersedia.	Yes
container_id	string	ID kontainer yang digunakan untuk menjalankan kode.	Yes
Keluaran	array	Output yang dihasilkan oleh penerjemah kode, seperti log atau gambar. Bisa null jika tidak ada output yang tersedia.	Yes
jenis	enum	Nilai yang mungkin: code_interpreter_call	Yes

OpenAI.CodeInterpreterToolCallItemResource

Panggilan alat untuk menjalankan kode.

Nama	Tipe	Deskripsi	Diperlukan	Default
kode	string	Kode yang akan dijalankan, atau null jika tidak tersedia.	Yes
container_id	string	ID kontainer yang digunakan untuk menjalankan kode.	Yes
Keluaran	array	Output yang dihasilkan oleh penerjemah kode, seperti log atau gambar. Bisa null jika tidak ada output yang tersedia.	Yes
status	enum	Nilai yang mungkin: in_progress, , completedincomplete, interpreting,failed	Yes
jenis	enum	Nilai yang mungkin: code_interpreter_call	Yes

OpenAI.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		Yes

OpenAI.CompletionUsage

Statistik penggunaan untuk permintaan penyelesaian tugas.

Nama	Tipe	Deskripsi	Diperlukan	Default
completion_tokens	bilangan bulat	Jumlah token dalam penyelesaian yang dihasilkan.	Yes	0
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.	0
└─ audio_tokens	bilangan bulat	Token input audio yang dihasilkan oleh model.	Tidak.	0
└─ token_penalaran	bilangan bulat	Token yang dihasilkan oleh model untuk penalaran.	Tidak.	0
└─ 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.	0
prompt_tokens	bilangan bulat	Jumlah token dalam prompt.	Yes	0
prompt_tokens_details	objek	Perincian token yang digunakan dalam perintah.	Tidak.
└─ audio_tokens	bilangan bulat	Token input audio ada di prompt.	Tidak.	0
└─ token_yang_di-cache	bilangan bulat	Token yang di-cache ada di prompt.	Tidak.	0
total_tokens	bilangan bulat	Jumlah total token yang digunakan dalam permintaan (prompt + penyelesaian).	Yes	0

OpenAI.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

OpenAI.ComputerAction

Diskriminator untuk ComputerAction dari OpenAI

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
click	OpenAI.ComputerActionClick
double_click	OpenAI.ComputerActionDoubleClick
drag	OpenAI.ComputerActionDrag
move	OpenAI.ComputerActionMove
screenshot	OpenAI.ComputerActionScreenshot
scroll	OpenAI.ComputerActionScroll
type	OpenAI.ComputerActionTypeKeys
wait	OpenAI.ComputerActionWait
keypress	OpenAI.ComputerActionKeyPress

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	OpenAI.ComputerActionType		Yes

OpenAI.ComputerActionClick

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

OpenAI.ComputerActionDoubleClick

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

OpenAI.ComputerActionDrag

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

OpenAI.ComputerActionKeyPress

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

OpenAI.ComputerActionMove

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

OpenAI.ComputerActionScreenshot

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

OpenAI.ComputerActionScroll

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

OpenAI.ComputerActionType

Harta benda	Nilai
Jenis	string
Nilai	screenshot click double_click scroll type wait keypress drag move

OpenAI.ComputerActionTypeKeys

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

OpenAI.ComputerActionWait

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

OpenAI.ComputerToolCallItemParam

Panggilan alat ke alat penggunaan komputer.

Nama	Tipe	Deskripsi	Diperlukan	Default
tindakan	OpenAI.ComputerAction		Yes
call_id	string	Identifikasi yang digunakan ketika merespon panggilan alat dengan output.	Yes
pending_safety_checks	array	Pemeriksaan keamanan tertunda untuk panggilan komputer.	Yes
jenis	enum	Nilai yang mungkin: computer_call	Yes

OpenAI.ComputerToolCallItemResource

Panggilan alat ke alat penggunaan komputer.

Nama	Tipe	Deskripsi	Diperlukan	Default
tindakan	OpenAI.ComputerAction		Yes
call_id	string	Identifikasi yang digunakan ketika merespon panggilan alat dengan output.	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	Nilai yang mungkin: computer_call	Yes

OpenAI.ComputerToolCallOutputItemOutput

Diskriminator untuk OpenAI.ComputerToolCallOutputItemOutput

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
computer_screenshot	OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	OpenAI.ComputerToolCallOutputItemOutputType	Gambar cuplikan layar komputer yang digunakan dengan alat untuk penggunaan komputer.	Yes

OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot

Nama	Tipe	Deskripsi	Diperlukan	Default
file_id	string		Tidak.
image_url	string		Tidak.
jenis	enum	Nilai yang mungkin: computer_screenshot	Yes

OpenAI.ComputerToolCallOutputItemOutputType

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

Harta benda	Nilai
Deskripsi	Gambar cuplikan layar komputer yang digunakan dengan alat untuk penggunaan komputer.
Jenis	string
Nilai	computer_screenshot

OpenAI.ComputerToolCallOutputItemParam

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
output	OpenAI.ComputerToolCallOutputItemOutput		Yes
jenis	enum	Nilai yang mungkin: computer_call_output	Yes

OpenAI.ComputerToolCallOutputItemResource

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
output	OpenAI.ComputerToolCallOutputItemOutput		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	Nilai yang mungkin: computer_call_output	Yes

OpenAI.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

OpenAI.AlatPratinjauPenggunaanKomputer

Alat yang mengontrol komputer virtual.

Nama	Tipe	Deskripsi	Diperlukan	Default
tinggi_tampilan	bilangan bulat	Tinggi layar komputer.	Yes
lebar_tampilan	bilangan bulat	Lebar tampilan komputer.	Yes
environment	enum	Jenis lingkungan komputer yang akan dikontrol. Nilai yang mungkin: windows, , maclinux, ubuntu,browser	Yes
jenis	enum	Jenis alat penggunaan komputer. Selalu computer_use_preview. Nilai yang mungkin: computer_use_preview	Yes

OpenAI.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

OpenAI.CreateEmbeddingResponse

Nama	Tipe	Deskripsi	Diperlukan	Default
data	array	Daftar penyematan yang dihasilkan oleh model.	Yes
model	string	Nama model yang digunakan untuk menghasilkan penyematan.	Yes
objek	enum	Jenis objek, yang selalu "daftar". Nilai yang mungkin: list	Yes
usage	objek	Informasi penggunaan untuk permintaan tersebut.	Yes
└─ token pemicu	bilangan bulat	Jumlah token yang digunakan oleh prompt.	Tidak.
└─ jumlah_token	bilangan bulat	Jumlah total token yang digunakan oleh permintaan.	Tidak.

OpenAI.CreateEvalItem

Pesan obrolan yang menjadi petunjuk atau konteks. Dapat mencakup referensi variabel ke item namespace, yaitu {{item.name}}.

Nama	Tipe	Deskripsi	Diperlukan	Default
isi	string atau OpenAI.EvalItemContent	Input teks ke model - dapat berisi string templat.	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.

OpenAI.CreateEvalRunRequest

Nama	Tipe	Deskripsi	Diperlukan	Default
sumber data	objek		Yes
└─ jenis	OpenAI.EvalRunDataSourceType		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, dan mengkueri objek melalui API atau dasbor. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter.	Tidak.
Nama	string	Nama eksekusi.	Tidak.

OpenAI.CreateFineTuningJobRequest

Model yang valid:

babbage-002
davinci-002
gpt-3.5-turbo
gpt-4o-mini

Nama	Tipe	Deskripsi	Diperlukan	Default
hyperparameter	objek	Hyperparameter yang digunakan untuk pekerjaan penyempurnaan. Nilai ini sekarang tidak digunakan lagi demi method, dan harus diteruskan di bawah method parameter .	Tidak.
└─ batch_size	enum	Nilai yang mungkin: auto	Tidak.
└─ pengali_kecepatan_pembelajaran	enum	Nilai yang mungkin: auto	Tidak.
└─ n_epochs	enum	Nilai yang mungkin: auto	Tidak.
integrasi	array	Daftar integrasi yang akan diaktifkan untuk pekerjaan penyempurnaan Anda.	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, dan mengkueri objek melalui API atau dasbor. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter.	Tidak.
metode	OpenAI.FineTuneMethod	Metode yang digunakan untuk penyempurnaan.	Tidak.
model	string (lihat model yang valid di bawah)	Nama model untuk menyempurnakan.	Yes
seed	bilangan bulat	Seed mengendalikan reproduksibilitas tugas. Menggunakan seed dan parameter pekerjaan yang sama seharusnya menghasilkan hasil yang sama, tetapi mungkin berbeda dalam kasus yang jarang terjadi. Jika benih tidak ditentukan, satu akan dihasilkan untuk Anda.	Tidak.
Akhiran	string	String hingga 64 karakter yang akan ditambahkan ke nama model yang disempurnakan. Misalnya, suffix "custom-model-name" akan menghasilkan nama model seperti ft:gpt-4o-mini:openai:custom-model-name:7p4lURel.	Tidak.	Tidak ada
file_pelatihan	string	ID file yang diunggah yang berisi data pelatihan. Himpunan data Anda harus diformat sebagai file JSONL. Selain itu, Anda harus mengunggah file Anda dengan tujuan fine-tune. Konten file harus berbeda tergantung pada apakah model menggunakan format obrolan, penyelesaian, atau jika metode penyempurnaan menggunakan format preferensi.	Yes
validation_file	string	ID file yang diunggah yang berisi data validasi. Jika Anda menyediakan file ini, data digunakan untuk menghasilkan metrik validasi secara berkala selama penyempurnaan. Metrik ini dapat dilihat dalam file hasil penyempurnaan. Data yang sama tidak boleh ada dalam file pelatihan dan validasi. Himpunan data Anda harus diformat sebagai file JSONL. Anda harus mengunggah file Anda dengan tujuan fine-tune.	Tidak.

OpenAI.CreateFineTuningJobRequestIntegration

Diskriminator untuk OpenAI.CreateFineTuningJobRequestIntegration

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
wandb	OpenAI.CreateFineTuningJobRequestWandbIntegration

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	string (lihat model yang valid di bawah)		Yes

OpenAI.CreateFineTuningJobRequestWandbIntegration

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	enum	Nilai yang mungkin: wandb	Yes
wandb	objek		Yes
└─ entitas	string		Tidak.
└─ nama	string		Tidak.
└─ proyek	string		Tidak.
└─ tag	array		Tidak.

OpenAI.CreateVectorStoreFileBatchRequest

Nama	Tipe	Deskripsi	Diperlukan	Default
attributes	objek	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.
chunking_strategy	OpenAI.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

OpenAI.CreateVectorStoreFileRequest

Nama	Tipe	Deskripsi	Diperlukan	Default
attributes	objek	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.
chunking_strategy	OpenAI.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

OpenAI.CreateVectorStoreRequest

Nama	Tipe	Deskripsi	Diperlukan	Default
chunking_strategy	objek	Strategi default. Strategi ini saat ini menggunakan max_chunk_size_tokens dari 800 dan chunk_overlap_tokens dari 400.	Tidak.
└─ statis	OpenAI.StaticChunkingStrategy		Tidak.
└─ jenis	enum	Selalu static. Nilai yang mungkin: static	Tidak.
kedaluwarsa_setelah	OpenAI.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, dan mengkueri objek melalui API atau dasbor. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter.	Tidak.
Nama	string	Nama toko vektor.	Tidak.

OpenAI.DeleteFileResponse

Nama	Tipe	Deskripsi	Diperlukan	Default
dihapus	Boolean		Yes
id	string		Yes
objek	enum	Nilai yang mungkin: file	Yes

OpenAI.DeleteVectorStoreFileResponse

Nama	Tipe	Deskripsi	Diperlukan	Default
dihapus	Boolean		Yes
id	string		Yes
objek	enum	Nilai yang mungkin: vector_store.file.deleted	Yes

OpenAI.DeleteVectorStoreResponse

Nama	Tipe	Deskripsi	Diperlukan	Default
dihapus	Boolean		Yes
id	string		Yes
objek	enum	Nilai yang mungkin: vector_store.deleted	Yes

OpenAI.Embedding

Mewakili vektor penyematan yang dikembalikan dengan menyematkan titik akhir.

Nama	Tipe	Deskripsi	Diperlukan	Default
embedding	array atau string		Yes
indeks	bilangan bulat	Indeks penyematan dalam daftar penyematan.	Yes
objek	enum	Jenis objek, yang selalu "menyematkan". Nilai yang mungkin: embedding	Yes

OpenAI.Eval

Objek Evaluasi dengan konfigurasi sumber data dan kriteria pengujian. Evaluasi mewakili tugas yang harus dilakukan untuk integrasi LLM Anda. Suka:

• Meningkatkan kualitas chatbot saya
• Lihat seberapa baik chatbot saya menangani dukungan pelanggan
• Periksa apakah o4-mini lebih baik di usecase saya daripada gpt-4o

Nama	Tipe	Deskripsi	Diperlukan	Default
dibuat_pada	bilangan bulat	Tanda waktu Unix (dalam detik) saat evaluasi dibuat.	Yes
konfigurasi_sumber_data	objek		Yes
└─ jenis	OpenAI.EvalDataSourceConfigType		Tidak.
id	string	Pengidentifikasi unik untuk evaluasi.	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, dan mengkueri objek melalui API atau dasbor. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter.	Yes
Nama	string	Nama evaluasi.	Yes
objek	enum	Jenis objek. Nilai yang mungkin: eval	Yes
kriteria_pengujian	array	Daftar kriteria pengujian.	Yes	Tidak ada

OpenAI.EvalApiError

Objek yang mewakili respons kesalahan dari EVAL API.

Nama	Tipe	Deskripsi	Diperlukan	Default
kode	string	Kode kesalahan.	Yes
pesan	string	Pesan kesalahan.	Yes

OpenAI.EvalCompletionsRunDataSourceParams

Objek CompletionsRunDataSource yang menjelaskan konfigurasi pengambilan sampel model.

Nama	Tipe	Deskripsi	Diperlukan	Default
pesan_masuk	objek		Tidak.
└─ referensi_item	string	Referensi ke variabel di item namespace. Yaitu, "item.input_trajectory"	Tidak.
└─ templat	array	Daftar pesan obrolan yang membentuk petunjuk atau konteks. Dapat mencakup referensi variabel ke item namespace, yaitu {{item.name}}.	Tidak.
└─ jenis	enum	Jenis pesan input. Selalu item_reference. Nilai yang mungkin: item_reference	Tidak.
model	string	Nama model yang digunakan untuk menghasilkan penyelesaian (misalnya "o3-mini").	Tidak.
sampling_params	AzureEvalAPICompletionsSamplingParams		Tidak.
sumber	objek		Yes
└─ konten	array	Isi file JSONL.	Tidak.
└─ dibuat_setelah	bilangan bulat	Tanda waktu Unix opsional untuk memfilter item yang dibuat setelah waktu ini.	Tidak.
└─ dibuat_sebelum	bilangan bulat	Tanda waktu Unix opsional untuk memfilter item yang dibuat sebelum waktu ini.	Tidak.
└─ ID	string	Pengidentifikasi file.	Tidak.
└─ batas	bilangan bulat	Jumlah maksimum opsional item yang akan dikembalikan.	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, 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 opsional untuk difilter menurut (misalnya, 'gpt-4o').	Tidak.
└─ jenis	enum	Jenis sumber. Selalu stored_completions. Nilai yang mungkin: stored_completions	Tidak.
jenis	enum	Jenis sumber data eksekusi. Selalu completions. Nilai yang mungkin: completions	Yes

OpenAI.EvalCustomDataSourceConfigParams

Objek CustomDataSourceConfig yang menentukan skema untuk sumber data yang digunakan untuk eksekusi evaluasi. Skema ini digunakan untuk menentukan bentuk data yang akan menjadi:

• Digunakan untuk menentukan kriteria pengujian Anda dan
• Data apa yang diperlukan saat membuat eksekusi

Nama	Tipe	Deskripsi	Diperlukan	Default
sertakan_skema_contoh	Boolean	Apakah evaluasi akan mengharapkan Anda mengisi namespace sampel (yaitu, dengan menghasilkan respons dari sumber data Anda)	Tidak.	False
item_schema	objek	Skema json untuk setiap baris di sumber data.	Yes
jenis	enum	Jenis sumber data. Selalu custom. Nilai yang mungkin: custom	Yes

OpenAI.EvalCustomDataSourceConfigResource

CustomDataSourceConfig yang menentukan skema dari item dan opsional namespace sample. Skema respons menentukan bentuk data yang akan menjadi:

• Digunakan untuk menentukan kriteria pengujian Anda dan
• Data apa yang diperlukan saat membuat eksekusi

Nama	Tipe	Deskripsi	Diperlukan	Default
skema	objek	Skema json untuk item sumber data yang dijalankan. Pelajari cara membuat skema JSON di sini.	Yes
jenis	enum	Jenis sumber data. Selalu custom. Nilai yang mungkin: custom	Yes

OpenAI.EvalDataSourceConfigParams

Diskriminator untuk OpenAI.EvalDataSourceConfigParams

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
custom	OpenAI.EvalCustomDataSourceConfigParams
logs	OpenAI.EvalLogsDataSourceConfigParams
stored_completions	OpenAI.EvalStoredCompletionsDataSourceConfigParams

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	OpenAI.EvalDataSourceConfigType		Yes

OpenAI.EvalDataSourceConfigResource

Diskriminator untuk OpenAI.EvalDataSourceConfigResource

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
custom	OpenAI.EvalCustomDataSourceConfigResource
stored_completions	OpenAI.EvalStoredCompletionsDataSourceConfigResource
logs	OpenAI.EvalLogsDataSourceConfigResource

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	OpenAI.EvalDataSourceConfigType		Yes

OpenAI.EvalDataSourceConfigType

Harta benda	Nilai
Jenis	string
Nilai	custom logs stored_completions

OpenAI.EvalGraderLabelModelParams

Objek LabelModelGrader yang menggunakan model untuk menetapkan label ke setiap item dalam evaluasi.

Nama	Tipe	Deskripsi	Diperlukan	Default
Masukan	array	Daftar pesan obrolan yang membentuk petunjuk atau konteks. Dapat mencakup referensi variabel ke item namespace, yaitu {{item.name}}.	Yes
labels	array	Label untuk mengklasifikasikan setiap item dalam evaluasi.	Yes
model	string	Model yang digunakan untuk evaluasi. Harus mendukung output terstruktur.	Yes
Nama	string	Nama penilai.	Yes
passing_labels	array	Label yang menunjukkan hasil lulus. Harus merupakan himpunan bagian dari label.	Yes
jenis	enum	Tipe objek, yang selalu label_model. Nilai yang mungkin: label_model	Yes

OpenAI.EvalGraderLabelModelResource

Nama	Tipe	Deskripsi	Diperlukan	Default
Masukan	array		Yes
labels	array	Label yang akan ditetapkan ke setiap item dalam evaluasi.	Yes
model	string	Model yang digunakan untuk evaluasi. Harus mendukung output terstruktur.	Yes
Nama	string	Nama penilai.	Yes
passing_labels	array	Label yang menunjukkan hasil lulus. Harus merupakan himpunan bagian dari label.	Yes
jenis	enum	Tipe objek, yang selalu label_model. Nilai yang mungkin: label_model	Yes

OpenAI.EvalGraderParams

Diskriminator untuk OpenAI.EvalGraderParams

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
label_model	OpenAI.EvalGraderLabelModelParams
string_check	OpenAI.EvalGraderStringCheckParams
text_similarity	OpenAI.EvalGraderTextSimilarityParams
python	OpenAI.EvalGraderPythonParams
score_model	OpenAI.EvalGraderScoreModelParams

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	OpenAI.GraderType		Yes

OpenAI.EvalGraderPythonParams

Nama	Tipe	Deskripsi	Diperlukan	Default
image_tag	string	Tag gambar yang digunakan untuk skrip python.	Tidak.
Nama	string	Nama penilai.	Yes
ambang_lulus	nomor/angka	Ambang batas untuk skor.	Tidak.
sumber	string	Kode sumber skrip python.	Yes
jenis	enum	Tipe objek, yang selalu python. Nilai yang mungkin: python	Yes

OpenAI.EvalGraderPythonResource

Nama	Tipe	Deskripsi	Diperlukan	Default
image_tag	string	Tag gambar yang digunakan untuk skrip python.	Tidak.
Nama	string	Nama penilai.	Yes
ambang_lulus	nomor/angka	Ambang batas untuk skor.	Tidak.
sumber	string	Kode sumber skrip python.	Yes
jenis	enum	Tipe objek, yang selalu python. Nilai yang mungkin: python	Yes

OpenAI.EvalGraderResource

Diskriminator untuk OpenAI.EvalGraderResource

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
label_model	OpenAI.EvalGraderLabelModelResource
text_similarity	OpenAI.EvalGraderTextSimilarityResource
python	OpenAI.EvalGraderPythonResource
score_model	OpenAI.EvalGraderScoreModelResource

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	OpenAI.GraderType		Yes

OpenAI.EvalGraderScoreModelParams

Nama	Tipe	Deskripsi	Diperlukan	Default
Masukan	array	Teks input. Ini mungkin termasuk string templat.	Yes
model	string	Model yang digunakan untuk evaluasi.	Yes
Nama	string	Nama penilai.	Yes
ambang_lulus	nomor/angka	Ambang batas untuk skor.	Tidak.
rentang	array	Rentang skor. Secara default menjadi [0, 1].	Tidak.
sampling_params		Parameter pengambilan sampel untuk model.	Tidak.
jenis	enum	Tipe objek, yang selalu score_model. Nilai yang mungkin: score_model	Yes

OpenAI.EvalGraderScoreModelResource

Nama	Tipe	Deskripsi	Diperlukan	Default
Masukan	array	Teks input. Ini mungkin termasuk string templat.	Yes
model	string	Model yang digunakan untuk evaluasi.	Yes
Nama	string	Nama penilai.	Yes
ambang_lulus	nomor/angka	Ambang batas untuk skor.	Tidak.
rentang	array	Rentang skor. Secara default menjadi [0, 1].	Tidak.
sampling_params		Parameter pengambilan sampel untuk model.	Tidak.
jenis	enum	Tipe objek, yang selalu score_model. Nilai yang mungkin: score_model	Yes

OpenAI.EvalGraderStringCheckParams

Nama	Tipe	Deskripsi	Diperlukan	Default
Masukan	string	Teks input. Ini mungkin termasuk string templat.	Yes
Nama	string	Nama penilai.	Yes
operasi	enum	Operasi pemeriksaan string yang perlu dilakukan. Salah satu dari eq, ne, like, atau ilike. Nilai yang mungkin: eq, ne, like, ilike	Yes
referensi	string	Teks referensi. Ini mungkin termasuk string templat.	Yes
jenis	enum	Tipe objek, yang selalu string_check. Nilai yang mungkin: string_check	Yes

OpenAI.EvalGraderTextSimilarityParams

Nama	Tipe	Deskripsi	Diperlukan	Default
metrik evaluasi	enum	Metrik evaluasi yang akan digunakan. Salah satu dari fuzzy_match, , bleugleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5, atau rouge_l. Nilai yang mungkin: fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5, rouge_l	Yes
Masukan	string	Teks yang sedang dievaluasi.	Yes
Nama	string	Nama penilai.	Yes
ambang_lulus	nomor/angka	Ambang batas untuk skor.	Yes
referensi	string	Teks yang sedang dinilai.	Yes
jenis	enum	Jenis grader. Nilai yang mungkin: text_similarity	Yes

OpenAI.EvalGraderTextSimilarityResource

Nama	Tipe	Deskripsi	Diperlukan	Default
metrik evaluasi	enum	Metrik evaluasi yang akan digunakan. Salah satu dari fuzzy_match, , bleugleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5, atau rouge_l. Nilai yang mungkin: fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5, rouge_l	Yes
Masukan	string	Teks yang sedang dievaluasi.	Yes
Nama	string	Nama penilai.	Yes
ambang_lulus	nomor/angka	Ambang batas untuk skor.	Yes
referensi	string	Teks yang sedang dinilai.	Yes
jenis	enum	Jenis grader. Nilai yang mungkin: text_similarity	Yes

OpenAI.EvalItem

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	objek		Yes
└─ jenis	OpenAI.EvalItemContentType		Tidak.
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.

OpenAI.EvalItemContent

Diskriminator untuk OpenAI.EvalItemContent

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
input_text	OpenAI.EvalItemContentInputText
output_text	OpenAI.EvalItemContentOutputText

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	OpenAI.EvalItemContentType		Yes

OpenAI.EvalItemContentInputText

Nama	Tipe	Deskripsi	Diperlukan	Default
kirim pesan teks	string		Yes
jenis	enum	Nilai yang mungkin: input_text	Yes

OpenAI.EvalItemContentOutputText

Nama	Tipe	Deskripsi	Diperlukan	Default
kirim pesan teks	string		Yes
jenis	enum	Nilai yang mungkin: output_text	Yes

OpenAI.EvalItemContentType

Harta benda	Nilai
Jenis	string
Nilai	input_text output_text

OpenAI.EvalJsonlRunDataSourceParams

Objek JsonlRunDataSource yang menentukan file JSONL yang cocok dengan penilaian

Nama	Tipe	Deskripsi	Diperlukan	Default
sumber	objek		Yes
└─ konten	array	Isi file JSONL.	Tidak.
└─ ID	string	Pengidentifikasi file.	Tidak.
└─ jenis	enum	Jenis sumber jsonl. Selalu file_id. Nilai yang mungkin: file_id	Tidak.
jenis	enum	Jenis sumber data. Selalu jsonl. Nilai yang mungkin: jsonl	Yes

OpenAI.EvalList

Objek yang mewakili daftar evaluasi.

Nama	Tipe	Deskripsi	Diperlukan	Default
data	array	Sebuah array objek eval.	Yes
first_id	string	Pengidentifikasi evaluasi pertama dalam array data.	Yes
ada_lagi	Boolean	Menunjukkan apakah ada lebih banyak evaluasi yang tersedia.	Yes
ID terakhir	string	Pengidentifikasi evaluasi terakhir dalam array data.	Yes
objek	enum	Tipe objek ini. Ini selalu diatur ke "daftar". Nilai yang mungkin: list	Yes

OpenAI.EvalLogsDataSourceConfigParams

Konfigurasi sumber data yang menentukan properti metadata kueri log Anda. Ini biasanya metadata seperti usecase=chatbot atau prompt-version=v2, dll.

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, dan mengkueri objek melalui API atau dasbor. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter.	Tidak.
jenis	enum	Jenis sumber data. Selalu logs. Nilai yang mungkin: logs	Yes

OpenAI.EvalLogsDataSourceConfigResource

LogsDataSourceConfig yang menentukan properti metadata kueri log Anda. Ini biasanya metadata seperti usecase=chatbot atau prompt-version=v2, dll. Skema yang dikembalikan oleh konfigurasi sumber data ini digunakan untuk menentukan variabel apa yang tersedia dalam evaluasi Anda. item dan sample keduanya didefinisikan saat menggunakan konfigurasi sumber data ini.

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, dan mengkueri objek melalui API atau dasbor. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter.	Yes
skema	objek	Skema json untuk item sumber data yang dijalankan. Pelajari cara membuat skema JSON di sini.	Yes
jenis	enum	Jenis sumber data. Selalu logs. Nilai yang mungkin: logs	Yes

OpenAI.EvalResponsesRunDataSourceParams

Objek ResponsesRunDataSource yang menjelaskan konfigurasi pengambilan sampel model.

Nama	Tipe	Deskripsi	Diperlukan	Default
pesan_masuk	objek		Tidak.
└─ referensi_item	string	Referensi ke variabel di item namespace. Yaitu, "item.name"	Tidak.
└─ templat	array	Daftar pesan obrolan yang membentuk petunjuk atau konteks. Dapat mencakup referensi variabel ke item namespace, yaitu {{item.name}}.	Tidak.
└─ jenis	enum	Jenis pesan input. Selalu item_reference. Nilai yang mungkin: item_reference	Tidak.
model	string	Nama model yang digunakan untuk menghasilkan penyelesaian (misalnya "o3-mini").	Tidak.
sampling_params	AzureEvalAPIResponseSamplingParams		Tidak.
sumber	objek		Yes
└─ konten	array	Isi file JSONL.	Tidak.
└─ dibuat_setelah	bilangan bulat	Hanya sertakan item yang dibuat setelah tanda waktu ini (inklusif). Ini adalah parameter kueri yang digunakan untuk memilih respons.	Tidak.
└─ dibuat_sebelum	bilangan bulat	Hanya sertakan item yang dibuat sebelum tanda waktu ini (inklusif). Ini adalah parameter kueri yang digunakan untuk memilih respons.	Tidak.
└─ ID	string	Pengidentifikasi file.	Tidak.
└─ instruksi_pencarian	string	String opsional untuk mencari bidang 'instruksi'. Ini adalah parameter kueri yang digunakan untuk memilih respons.	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, 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	Nama model untuk menemukan respons. Ini adalah parameter kueri yang digunakan untuk memilih respons.	Tidak.
└─ upaya_penalaran	OpenAI.ReasoningEffort	Parameter upaya penalaran opsional. Ini adalah parameter kueri yang digunakan untuk memilih respons.	Tidak.
└─ suhu	nomor/angka	Suhu pengambilan sampel. Ini adalah parameter kueri yang digunakan untuk memilih respons.	Tidak.
└─ peralatan	array	Daftar nama alat. Ini adalah parameter kueri yang digunakan untuk memilih respons.	Tidak.
└─ top_p	nomor/angka	Parameter pengambilan sampel nukleus. Ini adalah parameter kueri yang digunakan untuk memilih respons.	Tidak.
└─ jenis	enum	Jenis sumber data eksekusi. Selalu responses. Nilai yang mungkin: responses	Tidak.
└─ pengguna	array	Daftar pengidentifikasi pengguna. Ini adalah parameter kueri yang digunakan untuk memilih respons.	Tidak.
jenis	enum	Jenis sumber data eksekusi. Selalu responses. Nilai yang mungkin: responses	Yes

OpenAI.EvalRun

Skema yang mewakili pelaksanaan evaluasi.

Nama	Tipe	Deskripsi	Diperlukan	Default
dibuat_pada	bilangan bulat	Tanda waktu Unix (dalam detik) saat eksekusi evaluasi dibuat.	Yes
sumber data	objek		Yes
└─ jenis	OpenAI.EvalRunDataSourceType		Tidak.
galat	OpenAI.EvalApiError	Objek yang mewakili respons kesalahan dari EVAL API.	Yes
eval_id	string	Pengidentifikasi evaluasi terkait.	Yes
id	string	Pengidentifikasi unik untuk sesi evaluasi.	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, 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 dievaluasi, jika berlaku.	Yes
Nama	string	Nama pelaksanaan evaluasi.	Yes
objek	enum	Jenis objek. Selalu "eval.run". Nilai yang mungkin: eval.run	Yes
penggunaan_per_model	array	Statistik penggunaan untuk setiap model selama eksekusi evaluasi.	Yes
hasil_kriteria_pengujian	array	Hasil per kriteria pengujian yang diterapkan selama jalannya evaluasi.	Yes
report_url	string	URL ke laporan jalannya evaluasi yang dihasilkan di dasbor UI.	Yes
jumlah_hasil	objek	Mekanisme penghitung meringkas hasil evaluasi yang dijalankan.	Yes
└─ kesalahan	bilangan bulat	Jumlah item output yang mengakibatkan kesalahan.	Tidak.
└─ gagal	bilangan bulat	Jumlah item output yang gagal melewati evaluasi.	Tidak.
└─ berhasil	bilangan bulat	Jumlah item output yang lulus evaluasi.	Tidak.
└─ jumlah	bilangan bulat	Jumlah total item output yang dijalankan.	Tidak.
status	string	Status jalannya evaluasi.	Yes

OpenAI.EvalRunDataContentSource

Diskriminator untuk OpenAI.EvalRunDataContentSource

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
file_id	OpenAI.EvalRunFileIdDataContentSource
stored_completions	OpenAI.EvalRunStoredCompletionsDataContentSource
responses	OpenAI.EvalRunResponsesDataContentSource

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	OpenAI.EvalRunDataContentSourceType		Yes

OpenAI.EvalRunDataContentSourceType

Harta benda	Nilai
Jenis	string
Nilai	file_id file_content stored_completions responses

OpenAI.EvalRunDataSourceCompletionsResource

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	enum	Nilai yang mungkin: completions	Yes

OpenAI.EvalRunDataSourceJsonlResource

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	enum	Nilai yang mungkin: jsonl	Yes

OpenAI.EvalRunDataSourceParams

Diskriminator untuk OpenAI.EvalRunDataSourceParams

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
jsonl	OpenAI.EvalJsonlRunDataSourceParams
completions	OpenAI.EvalCompletionsRunDataSourceParams
responses	OpenAI.EvalResponsesRunDataSourceParams

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	OpenAI.EvalRunDataSourceType		Yes

OpenAI.EvalRunDataSourceResource

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	OpenAI.EvalRunDataSourceType		Yes

OpenAI.EvalRunDataSourceResponsesResource

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	enum	Nilai yang mungkin: responses	Yes

OpenAI.EvalRunDataSourceType

Harta benda	Nilai
Jenis	string
Nilai	jsonl completions responses

OpenAI.EvalRunFileContentDataContentSource

Nama	Tipe	Deskripsi	Diperlukan	Default
isi	array	Isi file JSONL.	Yes
jenis	enum	Jenis sumber jsonl. Selalu file_content. Nilai yang mungkin: file_content	Yes

OpenAI.EvalRunFileIdDataContentSource

Nama	Tipe	Deskripsi	Diperlukan	Default
id	string	Pengidentifikasi file.	Yes
jenis	enum	Jenis sumber jsonl. Selalu file_id. Nilai yang mungkin: file_id	Yes

OpenAI.EvalRunList

Objek yang mewakili daftar eksekusi untuk evaluasi.

Nama	Tipe	Deskripsi	Diperlukan	Default
data	array	Array objek evaluasi yang dijalankan.	Yes
first_id	string	Pengidentifikasi evaluasi pertama yang dijalankan dalam array data.	Yes
ada_lagi	Boolean	Menunjukkan apakah ada lebih banyak evaluasi yang tersedia.	Yes
ID terakhir	string	Pengidentifikasi evaluasi terakhir yang dijalankan dalam array data.	Yes
objek	enum	Tipe objek ini. Ini selalu diatur ke "daftar". Nilai yang mungkin: list	Yes

OpenAI.EvalRunOutputItem

Skema yang mewakili elemen hasil dari proses evaluasi.

Nama	Tipe	Deskripsi	Diperlukan	Default
dibuat_pada	bilangan bulat	Tanda waktu Unix (dalam detik) saat eksekusi evaluasi dibuat.	Yes
item_sumber_data	objek	Rincian elemen sumber data masukan.	Yes
id_item_sumberdata	bilangan bulat	Pengidentifikasi untuk item sumber data.	Yes
eval_id	string	Pengidentifikasi grup evaluasi.	Yes
id	string	Pengidentifikasi unik untuk item output dari proses evaluasi.	Yes
objek	enum	Jenis objek. Selalu "eval.run.output_item". Nilai yang mungkin: eval.run.output_item	Yes
results	array	Daftar hasil dari pelaksanaan evaluasi.	Yes
run_id	string	Pengidentifikasi jalannya evaluasi yang terkait dengan item output ini.	Yes
sampel	objek	Sampel yang berisi input dan output dari eksekusi evaluasi.	Yes
└─ kesalahan	OpenAI.EvalApiError	Objek yang mewakili respons kesalahan dari EVAL API.	Tidak.
└─ alasan_selesai	string	Alasan mengapa pembuatan sampel selesai.	Tidak.
└─ masukan	array	Sederetan pesan input.	Tidak.
└─ max_completion_tokens	bilangan bulat	Jumlah maksimum token yang diizinkan untuk penyelesaian.	Tidak.
└─ model	string	Model yang digunakan untuk menghasilkan sampel.	Tidak.
└─ keluaran	array	Deretan pesan keluaran.	Tidak.
└─ benih	bilangan bulat	Benih yang digunakan untuk menghasilkan sampel.	Tidak.
└─ suhu	nomor/angka	Suhu pengambilan sampel yang digunakan.	Tidak.
└─ top_p	nomor/angka	Nilai top_p digunakan untuk pengambilan sampel.	Tidak.
└─ penggunaan	objek	Detail penggunaan token untuk sampel.	Tidak.
└─ token_yang_di-cache	bilangan bulat	Jumlah token yang diambil dari cache.	Tidak.
└─ token_penyelesaian	bilangan bulat	Jumlah token penyelesaian yang dihasilkan.	Tidak.
└─ token pemicu	bilangan bulat	Jumlah token prompt yang digunakan.	Tidak.
└─ jumlah_token	bilangan bulat	Jumlah total token yang digunakan.	Tidak.
status	string	Status jalannya evaluasi.	Yes

OpenAI.EvalRunOutputItemList

Objek yang mewakili daftar item output untuk pelaksanaan evaluasi.

Nama	Tipe	Deskripsi	Diperlukan	Default
data	array	Deretan objek item keluaran dari eksekusi evaluasi.	Yes
first_id	string	Pengidentifikasi item output eksekusi evaluasi pertama dalam array data.	Yes
ada_lagi	Boolean	Menunjukkan apakah ada lebih banyak item output eksekusi evaluasi yang tersedia.	Yes
ID terakhir	string	Pengidentifikasi item output eksekusi evaluasi terakhir dalam array data.	Yes
objek	enum	Tipe objek ini. Ini selalu diatur ke "daftar". Nilai yang mungkin: list	Yes

OpenAI.EvalRunResponsesDataContentSource

Objek EvalResponsesSource yang menjelaskan konfigurasi sumber data eksekusi.

Nama	Tipe	Deskripsi	Diperlukan	Default
dibuat_setelah	bilangan bulat	Hanya sertakan item yang dibuat setelah tanda waktu ini (inklusif). Ini adalah parameter kueri yang digunakan untuk memilih respons.	Tidak.
dibuat_sebelum	bilangan bulat	Hanya sertakan item yang dibuat sebelum tanda waktu ini (inklusif). Ini adalah parameter kueri yang digunakan untuk memilih respons.	Tidak.
instructions_search	string	String opsional untuk mencari bidang 'instruksi'. Ini adalah parameter kueri yang digunakan untuk memilih respons.	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, 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	Nama model untuk menemukan respons. Ini adalah parameter kueri yang digunakan untuk memilih respons.	Tidak.
upaya penalaran	objek	model seri o 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.	Tidak.
suhu	nomor/angka	Suhu pengambilan sampel. Ini adalah parameter kueri yang digunakan untuk memilih respons.	Tidak.
perangkat	array	Daftar nama alat. Ini adalah parameter kueri yang digunakan untuk memilih respons.	Tidak.
top_p	nomor/angka	Parameter pengambilan sampel nukleus. Ini adalah parameter kueri yang digunakan untuk memilih respons.	Tidak.
jenis	enum	Jenis sumber data eksekusi. Selalu responses. Nilai yang mungkin: responses	Yes
users	array	Daftar pengidentifikasi pengguna. Ini adalah parameter kueri yang digunakan untuk memilih respons.	Tidak.

OpenAI.EvalRunStoredCompletionsDataContentSource

Konfigurasi StoredCompletionsRunDataSource yang menjelaskan serangkaian filter

Nama	Tipe	Deskripsi	Diperlukan	Default
dibuat_setelah	bilangan bulat	Tanda waktu Unix opsional untuk memfilter item yang dibuat setelah waktu ini.	Tidak.
dibuat_sebelum	bilangan bulat	Tanda waktu Unix opsional untuk memfilter item yang dibuat sebelum waktu ini.	Tidak.
limit	bilangan bulat	Jumlah maksimum opsional item yang akan dikembalikan.	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, 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 opsional untuk difilter menurut (misalnya, 'gpt-4o').	Tidak.
jenis	enum	Jenis sumber. Selalu stored_completions. Nilai yang mungkin: stored_completions	Yes

OpenAI.EvalStoredCompletionsDataSourceConfigParams

Tidak digunakan lagi demi LogsDataSourceConfig.

Nama	Tipe	Deskripsi	Diperlukan	Default
metadata	objek	Filter metadata untuk sumber data penyelesaian yang disimpan.	Tidak.
jenis	enum	Jenis sumber data. Selalu stored_completions. Nilai yang mungkin: stored_completions	Yes

OpenAI.EvalStoredCompletionsDataSourceConfigResource

Tidak digunakan lagi demi LogsDataSourceConfig.

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, dan mengkueri objek melalui API atau dasbor. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter.	Yes
skema	objek	Skema json untuk item sumber data yang dijalankan. Pelajari cara membuat skema JSON di sini.	Yes
jenis	enum	Jenis sumber data. Selalu stored_completions. Nilai yang mungkin: stored_completions	Yes

OpenAI.FileSearchTool

Alat yang mencari konten yang relevan dari file yang diunggah.

Nama	Tipe	Deskripsi	Diperlukan	Default
filters	objek		Tidak.
jumlah_maksimum_hasil	bilangan bulat	Jumlah maksimum hasil yang akan dikembalikan. Angka ini harus antara 1 dan 50 inklusif.	Tidak.
opsi_peringkat	objek		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.
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

OpenAI.FileSearchToolCallItemParam

Hasil panggilan alat pencarian file.

Nama	Tipe	Deskripsi	Diperlukan	Default
queries	array	Kueri yang digunakan untuk mencari file.	Yes
results	array	Hasil panggilan alat pencarian file.	Tidak.
jenis	enum	Nilai yang mungkin: file_search_call	Yes

OpenAI.FileSearchToolCallItemResource

Hasil panggilan alat pencarian file.

Nama	Tipe	Deskripsi	Diperlukan	Default
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	Nilai yang mungkin: file_search_call	Yes

OpenAI.Filters

Nama	Tipe	Deskripsi	Diperlukan	Default
filters	array	Kumpulan filter untuk digabungkan. Item dapat berupa ComparisonFilter atau CompoundFilter.	Yes
kunci	string	Kunci pembanding terhadap nilai.	Yes
jenis	enum	Jenis operasi: and atau or. Nilai yang mungkin: and, or	Yes
nilai	string atau angka atau boolean	Nilai untuk dibandingkan dengan kunci atribut; mendukung jenis string, angka, atau boolean.	Yes

OpenAI.FineTuneDPOHyperparameters

Hyperparameter yang digunakan untuk pekerjaan penyempurnaan DPO.

Nama	Tipe	Deskripsi	Diperlukan	Default
ukuran_paket	enum	Nilai yang mungkin: auto	Tidak.
beta	enum	Nilai yang mungkin: auto	Tidak.
pengganda tingkat pembelajaran	enum	Nilai yang mungkin: auto	Tidak.
n_epok	enum	Nilai yang mungkin: auto	Tidak.

OpenAI.FineTuneDPOMethod

Konfigurasi untuk metode penyempurnaan DPO.

Nama	Tipe	Deskripsi	Diperlukan	Default
hyperparameter	OpenAI.FineTuneDPOHyperparameters	Hyperparameter yang digunakan untuk pekerjaan penyempurnaan DPO.	Tidak.

OpenAI.FineTuneMethod

Metode yang digunakan untuk penyempurnaan.

Nama	Tipe	Deskripsi	Diperlukan	Default
dpo	OpenAI.FineTuneDPOMethod	Konfigurasi untuk metode penyempurnaan DPO.	Tidak.
Penguatan	AzureFineTuneReinforcementMethod		Tidak.
Diawasi	OpenAI.FineTuneSupervisedMethod	Konfigurasi untuk metode penyempurnaan yang diawasi.	Tidak.
jenis	enum	Jenis metode. supervisedApakah , , dpoatau reinforcement. Nilai yang mungkin: supervised, dpo, reinforcement	Yes

OpenAI.FineTuneReinforcementHyperparameters

Hyperparameter yang digunakan untuk pekerjaan penyempurnaan penguatan.

Nama	Tipe	Deskripsi	Diperlukan	Default
ukuran_paket	enum	Nilai yang mungkin: auto	Tidak.
compute_multiplier	enum	Nilai yang mungkin: auto	Tidak.
eval_interval	enum	Nilai yang mungkin: auto	Tidak.
eval_samples	enum	Nilai yang mungkin: auto	Tidak.
pengganda tingkat pembelajaran	enum	Nilai yang mungkin: auto	Tidak.
n_epok	enum	Nilai yang mungkin: auto	Tidak.
upaya penalaran	enum	Tingkat upaya penalaran. Nilai yang mungkin: default, low, medium, high	Tidak.

OpenAI.FineTuneSupervisedHyperparameters

Hyperparameter yang digunakan untuk pekerjaan penyempurnaan.

Nama	Tipe	Deskripsi	Diperlukan	Default
ukuran_paket	enum	Nilai yang mungkin: auto	Tidak.
pengganda tingkat pembelajaran	enum	Nilai yang mungkin: auto	Tidak.
n_epok	enum	Nilai yang mungkin: auto	Tidak.

OpenAI.FineTuneSupervisedMethod

Konfigurasi untuk metode penyempurnaan yang diawasi.

Nama	Tipe	Deskripsi	Diperlukan	Default
hyperparameter	OpenAI.FineTuneSupervisedHyperparameters	Hyperparameter yang digunakan untuk pekerjaan penyempurnaan.	Tidak.

OpenAI.FineTuningIntegration

Diskriminator untuk OpenAI.FineTuningIntegration

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
wandb	OpenAI.FineTuningIntegrationWandb

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	string (lihat model yang valid di bawah)		Yes

OpenAI.FineTuningIntegrationWandb

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	enum	Jenis integrasi yang diaktifkan untuk pekerjaan penyempurnaan. Nilai yang mungkin: wandb	Yes
wandb	objek	Pengaturan untuk integrasi Anda dengan Bobot dan Bias. Payload ini menentukan project metrik yang akan dikirim. Secara opsional, Anda dapat mengatur nama tampilan eksplisit untuk eksekusi Anda, menambahkan tag ke eksekusi Anda, dan mengatur entitas default (tim, nama pengguna, dll) agar dikaitkan dengan eksekusi Anda.	Yes
└─ entitas	string	Entitas yang digunakan untuk eksekusi. Ini memungkinkan Anda untuk mengatur tim atau nama pengguna pengguna WandB yang ingin Anda kaitkan dengan eksekusi. Jika tidak diatur, entitas default untuk kunci API WandB terdaftar digunakan.	Tidak.
└─ nama	string	Nama tampilan yang akan diatur untuk eksekusi. Jika tidak diatur, kita akan menggunakan ID Pekerjaan sebagai nama.	Tidak.
└─ proyek	string	Nama project tempat eksekusi baru akan dibuat.	Tidak.
└─ tag	array	Daftar tag yang akan dilampirkan ke eksekusi yang baru dibuat. Tag ini diteruskan langsung ke WandB. Beberapa tag default dihasilkan oleh OpenAI: "openai/finetune", "openai/{base-model}", "openai/{ftjob-abcdef}".	Tidak.

OpenAI.FineTuningJob

Objek fine_tuning.job mewakili pekerjaan penyempurnaan yang telah dibuat melalui API.

Nama	Tipe	Deskripsi	Diperlukan	Default
dibuat_pada	bilangan bulat	Tanda waktu Unix (dalam detik) saat pekerjaan penyempurnaan dibuat.	Yes
galat	objek	Untuk pekerjaan penyempurnaan yang memiliki failed, ini akan berisi informasi lebih lanjut tentang penyebab kegagalan.	Yes
└─ kode	string	Kode kesalahan yang dapat dibaca mesin.	Tidak.
└─ pesan	string	Pesan kesalahan yang dapat dibaca manusia.	Tidak.
└─ param	string	Parameter yang tidak valid, biasanya training_file atau validation_file. Bidang ini akan null jika kegagalan tidak spesifik parameter.	Tidak.
perkiraan selesai	bilangan bulat	Tanda waktu Unix (dalam detik) ketika pekerjaan penyempurnaan diperkirakan selesai. Nilai akan null jika pekerjaan penyempurnaan tidak berjalan.	Tidak.
fine_tuned_model	string	Nama model yang disempurnakan yang sedang dibuat. Nilai akan null jika pekerjaan penyempurnaan masih berjalan.	Yes
selesai_pada	bilangan bulat	Tanda waktu Unix (dalam detik) ketika pekerjaan penyempurnaan selesai. Nilai akan null jika pekerjaan penyempurnaan masih berjalan.	Yes
hyperparameter	objek	Hyperparameter yang digunakan untuk pekerjaan penyempurnaan. Nilai ini hanya akan dikembalikan saat menjalankan supervised pekerjaan.	Yes
└─ batch_size	enum	Nilai yang mungkin: auto	Tidak.
└─ pengali_kecepatan_pembelajaran	enum	Nilai yang mungkin: auto	Tidak.
└─ n_epochs	enum	Nilai yang mungkin: auto	Tidak.
id	string	Pengidentifikasi objek, yang dapat dirujuk di titik akhir API.	Yes
integrasi	array	Daftar integrasi yang akan diaktifkan untuk pekerjaan penyempurnaan ini.	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, dan mengkueri objek melalui API atau dasbor. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter.	Yes
metode	OpenAI.FineTuneMethod	Metode yang digunakan untuk penyempurnaan.	Tidak.
model	string	Model dasar yang sedang disempurnakan.	Yes
objek	enum	Jenis objek, yang selalu "fine_tuning.job". Nilai yang mungkin: fine_tuning.job	Yes
organization_id	string	Organisasi yang memiliki pekerjaan penyempurnaan.	Yes
file hasil	array	ID file hasil yang dikompilasi untuk pekerjaan penyempurnaan. Anda dapat mengambil hasilnya dengan Files API.	Yes
seed	bilangan bulat	Benih yang digunakan untuk pekerjaan penyempurnaan.	Yes
status	enum	Status pekerjaan penyempurnaan saat ini, yang dapat berupa validating_files, , queued, runningsucceeded, failed, atau cancelled. Nilai yang mungkin: validating_files, , queuedrunning, succeeded, failed,cancelled	Yes
token_terlatih	bilangan bulat	Jumlah total token yang dapat ditagih yang diproses oleh pekerjaan penyempurnaan ini. Nilai akan null jika pekerjaan penyempurnaan masih berjalan.	Yes
file_pelatihan	string	ID file yang digunakan untuk pelatihan. Anda dapat mengambil data pelatihan dengan Files API.	Yes
user_provided_suffix	string	Akhiran deskriptif diterapkan ke pekerjaan, seperti yang ditentukan dalam permintaan pembuatan pekerjaan.	Tidak.
validation_file	string	ID file yang digunakan untuk validasi. Anda dapat mengambil hasil validasi dengan Files API.	Yes

OpenAI.FineTuningJobCheckpoint

Objek fine_tuning.job.checkpoint mewakili titik pemeriksaan model untuk pekerjaan penyempurnaan yang siap digunakan.

Nama	Tipe	Deskripsi	Diperlukan	Default
dibuat_pada	bilangan bulat	Tanda waktu Unix (dalam detik) saat titik pemeriksaan dibuat.	Yes
titik_pemeriksaan_model_terlatih_dengan_baik	string	Nama model titik pemeriksaan yang disempurnakan yang dibuat.	Yes
ID_pekerjaan_penyesuaian	string	Nama pekerjaan penyempurnaan tempat titik pemeriksaan ini dibuat.	Yes
id	string	Pengidentifikasi titik pemeriksaan, yang dapat dirujuk di titik akhir API.	Yes
metrik	objek	Metrik pada nomor langkah selama pekerjaan penyempurnaan.	Yes
└─ kehilangan_valid_penuh	nomor/angka		Tidak.
└─ akurasi_rata-rata_token_valid_lengkap	nomor/angka		Tidak.
└─ langkah	nomor/angka		Tidak.
└─ kehilangan_latihan	nomor/angka		Tidak.
└─ train_mean_token_accuracy (akurasi_rata-rata_token_latihan)	nomor/angka		Tidak.
└─ kerugian_valid	nomor/angka		Tidak.
└─ akurasi rata-rata token valid	nomor/angka		Tidak.
objek	enum	Jenis objek, yang selalu "fine_tuning.job.checkpoint". Nilai yang mungkin: fine_tuning.job.checkpoint	Yes
langkah_nomor	bilangan bulat	Nomor langkah tempat titik pemeriksaan dibuat.	Yes

OpenAI.FineTuningJobEvent

Menyempurnakan objek peristiwa pekerjaan

Nama	Tipe	Deskripsi	Diperlukan	Default
dibuat_pada	bilangan bulat	Tanda waktu Unix (dalam detik) saat pekerjaan penyempurnaan dibuat.	Yes
data		Data yang terkait dengan peristiwa.	Tidak.
id	string	Pengidentifikasi objek.	Yes
level	enum	Tingkat log peristiwa. Nilai yang mungkin: info, warn, error	Yes
pesan	string	Pesan peristiwa.	Yes
objek	enum	Jenis objek, yang selalu "fine_tuning.job.event". Nilai yang mungkin: fine_tuning.job.event	Yes
jenis	enum	Jenis peristiwa. Nilai yang mungkin: message, metrics	Tidak.

OpenAI.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		Parameter yang diterima fungsi, dijelaskan sebagai objek Skema JSON.	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

OpenAI.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 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

OpenAI.FunctionToolCallItemParam

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
Nama	string	Nama fungsi yang akan dijalankan.	Yes
jenis	enum	Nilai yang mungkin: function_call	Yes

OpenAI.FunctionToolCallItemResource

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
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	Yes
jenis	enum	Nilai yang mungkin: function_call	Yes

OpenAI.FunctionToolCallOutputItemParam

Output dari pemanggilan fungsi alat.

Nama	Tipe	Deskripsi	Diperlukan	Default
call_id	string	ID unik dari panggilan alat fungsional yang dihasilkan oleh model.	Yes
output	string	String JSON dari output pemanggilan fungsi alat.	Yes
jenis	enum	Nilai yang mungkin: function_call_output	Yes

OpenAI.FunctionToolCallOutputItemResource

Output dari pemanggilan fungsi alat.

Nama	Tipe	Deskripsi	Diperlukan	Default
call_id	string	ID unik dari panggilan alat fungsional yang dihasilkan oleh model.	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	Yes
jenis	enum	Nilai yang mungkin: function_call_output	Yes

OpenAI.Grader

Diskriminator untuk OpenAI.Grader

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
label_model	OpenAI.GraderLabelModel
text_similarity	OpenAI.GraderTextSimilarity
python	OpenAI.GraderPython
score_model	OpenAI.GraderScoreModel
multi	OpenAI.GraderMulti

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	OpenAI.GraderType		Yes

OpenAI.GraderLabelModel

Objek LabelModelGrader yang menggunakan model untuk menetapkan label ke setiap item dalam evaluasi.

Nama	Tipe	Deskripsi	Diperlukan	Default
Masukan	array		Yes
labels	array	Label yang akan ditetapkan ke setiap item dalam evaluasi.	Yes
model	string	Model yang digunakan untuk evaluasi. Harus mendukung output terstruktur.	Yes
Nama	string	Nama penilai.	Yes
passing_labels	array	Label yang menunjukkan hasil lulus. Harus merupakan himpunan bagian dari label.	Yes
jenis	enum	Tipe objek, yang selalu label_model. Nilai yang mungkin: label_model	Yes

OpenAI.GraderMulti

Objek MultiGrader menggabungkan output beberapa grader untuk menghasilkan satu skor.

Nama	Tipe	Deskripsi	Diperlukan	Default
calculate_output	string	Rumus untuk menghitung output berdasarkan hasil grader.	Yes
grader	objek		Yes
Nama	string	Nama penilai.	Yes
jenis	enum	Tipe objek, yang selalu multi. Nilai yang mungkin: multi	Yes

OpenAI.GraderPython

Objek PythonGrader yang menjalankan skrip python pada input.

Nama	Tipe	Deskripsi	Diperlukan	Default
image_tag	string	Tag gambar yang digunakan untuk skrip python.	Tidak.
Nama	string	Nama penilai.	Yes
sumber	string	Kode sumber skrip python.	Yes
jenis	enum	Tipe objek, yang selalu python. Nilai yang mungkin: python	Yes

OpenAI.GraderScoreModel

Objek ScoreModelGrader yang menggunakan model untuk menetapkan skor ke input.

Nama	Tipe	Deskripsi	Diperlukan	Default
Masukan	array	Teks input. Ini mungkin termasuk string templat.	Yes
model	string	Model yang digunakan untuk evaluasi.	Yes
Nama	string	Nama penilai.	Yes
rentang	array	Rentang skor. Secara default menjadi [0, 1].	Tidak.
sampling_params		Parameter pengambilan sampel untuk model.	Tidak.
jenis	enum	Tipe objek, yang selalu score_model. Nilai yang mungkin: score_model	Yes

OpenAI.GraderStringCheck

Objek StringCheckGrader yang melakukan perbandingan string antara input dan referensi menggunakan operasi tertentu.

Nama	Tipe	Deskripsi	Diperlukan	Default
Masukan	string	Teks input. Ini mungkin termasuk string templat.	Yes
Nama	string	Nama penilai.	Yes
operasi	enum	Operasi pemeriksaan string yang perlu dilakukan. Salah satu dari eq, ne, like, atau ilike. Nilai yang mungkin: eq, ne, like, ilike	Yes
referensi	string	Teks referensi. Ini mungkin termasuk string templat.	Yes
jenis	enum	Tipe objek, yang selalu string_check. Nilai yang mungkin: string_check	Yes

OpenAI.GraderTextSimilarity

Objek TextSimilarityGrader yang menilai teks berdasarkan metrik kesamaan.

Nama	Tipe	Deskripsi	Diperlukan	Default
metrik evaluasi	enum	Metrik evaluasi yang akan digunakan. Salah satu dari fuzzy_match, , bleugleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5, atau rouge_l. Nilai yang mungkin: fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5, rouge_l	Yes
Masukan	string	Teks yang sedang dievaluasi.	Yes
Nama	string	Nama penilai.	Yes
referensi	string	Teks yang sedang dinilai.	Yes
jenis	enum	Jenis grader. Nilai yang mungkin: text_similarity	Yes

OpenAI.GraderType

Harta benda	Nilai
Jenis	string
Nilai	string_check text_similarity score_model label_model python multi

OpenAI.ImageGenTool

Alat yang menghasilkan gambar menggunakan model seperti gpt-image-1.5.

Nama	Tipe	Deskripsi	Diperlukan	Default
latar belakang	enum	Jenis latar belakang untuk gambar yang dihasilkan. Salah satu dari transparent, opaque, atau auto. Standar: auto. Nilai yang mungkin: transparent, opaque, auto	Tidak.
masukan_topeng_gambar	objek	Masker opsional untuk pengisian ulang gambar. Berisi image_url (string, opsional) dan file_id (string, opsional).	Tidak.
└─ file_id	string	ID file untuk gambar topeng.	Tidak.
└─ alamat_gambar	string	Gambar masker yang dikodekan Base64.	Tidak.
model	enum	Model pembuatan gambar yang akan digunakan. Standar: gpt-image-1. Nilai yang mungkin: gpt-image-1, gpt-image-1.5, gpt-image-2	Tidak.
moderation	enum	Tingkat moderasi untuk gambar yang dihasilkan. Standar: auto. Nilai yang mungkin: auto, low	Tidak.
kompresi keluaran	bilangan bulat	Tingkat kompresi untuk gambar output. Bawaan: 100.	Tidak.	100
format keluaran	enum	Format output gambar yang dihasilkan. Salah satu dari png, webp, atau jpeg. Standar: png. Nilai yang mungkin: png, webp, jpeg	Tidak.
gambar sebagian	bilangan bulat	Jumlah gambar parsial yang dihasilkan dalam mode streaming, dari 0 (nilai default) hingga 3.	Tidak.	0
kualitas	enum	Kualitas gambar yang dihasilkan. Salah satu dari low, medium, high, atau auto. Standar: auto. Nilai yang mungkin: low, medium, high, auto	Tidak.
ukuran	enum	Ukuran gambar yang dihasilkan. Salah satu dari 1024x1024, 1024x1536, 1536x1024, atau auto. Standar: auto. Nilai yang mungkin: 1024x1024, 1024x1536, 1536x1024, auto	Tidak.
jenis	enum	Jenis alat pembuatan gambar. Selalu image_generation. Nilai yang mungkin: image_generation	Yes

OpenAI.ImageGenToolCallItemParam

Permintaan pembuatan gambar yang dibuat oleh model.

Nama	Tipe	Deskripsi	Diperlukan	Default
hasil	string	Gambar yang dihasilkan dikodekan dalam base64.	Yes
jenis	enum	Nilai yang mungkin: image_generation_call	Yes

OpenAI.ImageGenToolCallItemResource

Permintaan pembuatan gambar yang dibuat oleh model.

Nama	Tipe	Deskripsi	Diperlukan	Default
hasil	string	Gambar yang dihasilkan dikodekan dalam base64.	Yes
status	enum	Nilai yang mungkin: in_progress, completed, generating, failed	Yes
jenis	enum	Nilai yang mungkin: image_generation_call	Yes

OpenAI.ImplicitUserMessage

Nama	Tipe	Deskripsi	Diperlukan	Default
isi	string atau array		Yes

OpenAI.Includable

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

• code_interpreter_call.outputs: Menyertakan output eksekusi kode python dalam item panggilan alat penerjemah kode.
• computer_call_output.output.image_url: Sertakan url gambar dari output panggilan komputer.
• file_search_call.results: Sertakan hasil pencarian panggilan alat pencarian file.
• message.input_image.image_url: Sertakan url gambar dari pesan input.
• message.output_text.logprobs: Sertakan logprobs dengan pesan asisten.
• reasoning.encrypted_content: Menyertakan versi terenkripsi dari token penalaran dalam hasil item penalaran. Ini memungkinkan item penalaran digunakan dalam percakapan berkelanjutan saat menggunakan API Respons tanpa status (seperti ketika parameter store diatur ke false, atau ketika organisasi terdaftar dalam program tanpa retensi data).

Harta benda	Nilai
Deskripsi	Tentukan data output tambahan untuk disertakan dalam respons model. Nilai yang saat ini didukung adalah: - code_interpreter_call.outputs: Menyertakan output eksekusi kode python dalam item panggilan alat penerjemah kode. - computer_call_output.output.image_url: Sertakan url gambar dari output panggilan komputer. - file_search_call.results: Sertakan hasil pencarian dari alat pencari file. - message.input_image.image_url: Sertakan url gambar dari pesan input. - message.output_text.logprobs: Sertakan logprobs dengan pesan asisten. - reasoning.encrypted_content: Menyertakan versi terenkripsi dari token penalaran dalam output item penalaran. Ini memungkinkan item penalaran digunakan dalam percakapan berkelanjutan saat menggunakan API Respons tanpa status (seperti ketika parameter store diatur ke false, atau ketika organisasi terdaftar dalam program tanpa retensi data).
Jenis	string
Nilai	code_interpreter_call.outputs computer_call_output.output.image_url file_search_call.results message.input_image.image_url message.output_text.logprobs reasoning.encrypted_content

OpenAI.ItemContent

Diskriminator untuk OpenAI.ItemContent

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
input_audio	OpenAI.ItemContentInputAudio
output_audio	OpenAI.ItemContentOutputAudio
refusal	OpenAI.ItemContentRefusal
input_text	OpenAI.ItemContentInputText
input_image	OpenAI.ItemContentInputImage
input_file	OpenAI.ItemContentInputFile
output_text	OpenAI.ItemContentOutputText

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	OpenAI.ItemContentType	Konten multi-modal untuk input dan output.	Yes

OpenAI.ItemContentInputAudio

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

OpenAI.ItemContentInputFile

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

OpenAI.ItemContentInputImage

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: low, high, auto	Tidak.
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

OpenAI.ItemContentInputText

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

OpenAI.ItemContentOutputAudio

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

OpenAI.ItemContentOutputText

Teks output dari model.

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

OpenAI.ItemContentRefusal

Penolakan dari model.

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

OpenAI.ItemContentType

Konten multi-modal untuk input dan output.

Harta benda	Nilai
Deskripsi	Konten multi-modal untuk input dan output.
Jenis	string
Nilai	input_text input_audio input_image input_file output_text output_audio refusal

OpenAI.ItemParam

Item konten yang digunakan untuk menghasilkan respons.

Diskriminator untuk OpenAI.ItemParam

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
file_search_call	OpenAI.FileSearchToolCallItemParam
computer_call	OpenAI.ComputerToolCallItemParam
computer_call_output	OpenAI.ComputerToolCallOutputItemParam
web_search_call	OpenAI.WebSearchToolCallItemParam
function_call	OpenAI.FunctionToolCallItemParam
function_call_output	OpenAI.FunctionToolCallOutputItemParam
reasoning	OpenAI.ReasoningItemParam
item_reference	OpenAI.ItemReferenceItemParam
image_generation_call	OpenAI.ImageGenToolCallItemParam
code_interpreter_call	OpenAI.CodeInterpreterToolCallItemParam
local_shell_call	OpenAI.LocalShellToolCallItemParam
local_shell_call_output	OpenAI.LocalShellToolCallOutputItemParam
mcp_list_tools	OpenAI.MCPListToolsItemParam
mcp_approval_request	OpenAI.MCPApprovalRequestItemParam
mcp_approval_response	OpenAI.MCPApprovalResponseItemParam
mcp_call	OpenAI.MCPCallItemParam
message	OpenAI.ResponsesMessageItemParam

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	OpenAI.ItemType		Yes

OpenAI.ItemReferenceItemParam

Pengidentifikasi internal untuk item yang akan dirujuk.

Nama	Tipe	Deskripsi	Diperlukan	Default
id	string	ID asal layanan dari item respons yang dihasilkan sebelumnya yang dirujuk.	Yes
jenis	enum	Nilai yang mungkin: item_reference	Yes

OpenAI.ItemResource

Item konten yang digunakan untuk menghasilkan respons.

Diskriminator untuk OpenAI.ItemResource

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
file_search_call	OpenAI.FileSearchToolCallItemResource
computer_call	OpenAI.ComputerToolCallItemResource
computer_call_output	OpenAI.ComputerToolCallOutputItemResource
web_search_call	OpenAI.WebSearchToolCallItemResource
function_call	OpenAI.FunctionToolCallItemResource
function_call_output	OpenAI.FunctionToolCallOutputItemResource
reasoning	OpenAI.ReasoningItemResource
image_generation_call	OpenAI.ImageGenToolCallItemResource
code_interpreter_call	OpenAI.CodeInterpreterToolCallItemResource
local_shell_call	OpenAI.LocalShellToolCallItemResource
local_shell_call_output	OpenAI.LocalShellToolCallOutputItemResource
mcp_list_tools	OpenAI.MCPListToolsItemResource
mcp_approval_request	OpenAI.MCPApprovalRequestItemResource
mcp_approval_response	OpenAI.MCPApprovalResponseItemResource
mcp_call	OpenAI.MCPCallItemResource
message	OpenAI.ResponsesMessageItemResource

Nama	Tipe	Deskripsi	Diperlukan	Default
id	string		Yes
jenis	OpenAI.ItemType		Yes

OpenAI.ItemType

Harta benda	Nilai
Jenis	string
Nilai	message file_search_call function_call function_call_output computer_call computer_call_output web_search_call reasoning item_reference image_generation_call code_interpreter_call local_shell_call local_shell_call_output mcp_list_tools mcp_approval_request mcp_approval_response mcp_call

OpenAI.ListFineTuningJobCheckpointsResponse

Nama	Tipe	Deskripsi	Diperlukan	Default
data	array		Yes
first_id	string		Tidak.
ada_lagi	Boolean		Yes
ID terakhir	string		Tidak.
objek	enum	Nilai yang mungkin: list	Yes

OpenAI.ListFineTuningJobEventsResponse

Nama	Tipe	Deskripsi	Diperlukan	Default
data	array		Yes
ada_lagi	Boolean		Yes
objek	enum	Nilai yang mungkin: list	Yes

OpenAI.ListModelsResponse

Nama	Tipe	Deskripsi	Diperlukan	Default
data	array		Yes
objek	enum	Nilai yang mungkin: list	Yes

OpenAI.ListPaginatedFineTuningJobsResponse

Nama	Tipe	Deskripsi	Diperlukan	Default
data	array		Yes
ada_lagi	Boolean		Yes
objek	enum	Nilai yang mungkin: list	Yes

OpenAI.ListVectorStoreFilesFilter

Harta benda	Nilai
Jenis	string
Nilai	in_progress completed failed cancelled

OpenAI.ListVectorStoreFilesResponse

Nama	Tipe	Deskripsi	Diperlukan	Default
data	array		Yes
first_id	string		Yes
ada_lagi	Boolean		Yes
ID terakhir	string		Yes
objek	enum	Nilai yang mungkin: list	Yes

OpenAI.ListVectorStoresResponse

Nama	Tipe	Deskripsi	Diperlukan	Default
data	array		Yes
first_id	string		Yes
ada_lagi	Boolean		Yes
ID terakhir	string		Yes
objek	enum	Nilai yang mungkin: list	Yes

OpenAI.LocalShellExecAction

Jalankan perintah shell di server.

Nama	Tipe	Deskripsi	Diperlukan	Default
Perintah	array	Perintah yang akan dijalankan.	Yes
env	objek	Variabel lingkungan yang akan diatur untuk perintah .	Yes
batas_waktu_ms	bilangan bulat	Batas waktu opsional dalam milidetik untuk perintah .	Tidak.
jenis	enum	Jenis tindakan shell lokal. Selalu exec. Nilai yang mungkin: exec	Yes
pengguna	string	Pengguna opsional untuk menjalankan perintah sebagai.	Tidak.
working_directory	string	Direktori kerja opsional untuk menjalankan perintah.	Tidak.

OpenAI.LocalShellTool

Alat yang memungkinkan model menjalankan perintah shell di lingkungan lokal.

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	enum	Jenis alat shell lokal. Selalu local_shell. Nilai yang mungkin: local_shell	Yes

OpenAI.LocalShellToolCallItemParam

Panggilan alat untuk menjalankan perintah pada shell lokal.

Nama	Tipe	Deskripsi	Diperlukan	Default
tindakan	OpenAI.LocalShellExecAction	Jalankan perintah shell di server.	Yes
call_id	string	ID unik dari panggilan alat shell lokal yang dihasilkan oleh model.	Yes
jenis	enum	Nilai yang mungkin: local_shell_call	Yes

OpenAI.LocalShellToolCallItemResource

Panggilan alat untuk menjalankan perintah pada shell lokal.

Nama	Tipe	Deskripsi	Diperlukan	Default
tindakan	OpenAI.LocalShellExecAction	Jalankan perintah shell di server.	Yes
call_id	string	ID unik dari panggilan alat shell lokal yang dihasilkan oleh model.	Yes
status	enum	Nilai yang mungkin: in_progress, completed, incomplete	Yes
jenis	enum	Nilai yang mungkin: local_shell_call	Yes

OpenAI.LocalShellToolCallOutputItemParam

Output panggilan alat shell lokal.

Nama	Tipe	Deskripsi	Diperlukan	Default
output	string	String JSON dari output panggilan alat shell lokal.	Yes
jenis	enum	Nilai yang mungkin: local_shell_call_output	Yes

OpenAI.LocalShellToolCallOutputItemResource

Output panggilan alat shell lokal.

Nama	Tipe	Deskripsi	Diperlukan	Default
output	string	String JSON dari output panggilan alat shell lokal.	Yes
status	enum	Nilai yang mungkin: in_progress, completed, incomplete	Yes
jenis	enum	Nilai yang mungkin: local_shell_call_output	Yes

OpenAI.Location

Diskriminator untuk OpenAI.Location

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
approximate	OpenAI.ApproximateLocation

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	OpenAI.LocationType		Yes

OpenAI.LocationType

Harta benda	Nilai
Jenis	string
Nilai	approximate

OpenAI.LogProb

Probabilitas log token.

Nama	Tipe	Deskripsi	Diperlukan	Default
Byte	array		Yes
logprob	nomor/angka		Yes
token	string		Yes
top_logprobs	array		Yes

OpenAI.MCPApprovalRequestItemParam

Permintaan persetujuan dari manusia untuk penggunaan alat.

Nama	Tipe	Deskripsi	Diperlukan	Default
argumen	string	String argumen JSON untuk alat ini.	Yes
Nama	string	Nama alat yang akan dijalankan.	Yes
server_label	string	Label server MCP yang membuat permintaan.	Yes
jenis	enum	Nilai yang mungkin: mcp_approval_request	Yes

OpenAI.MCPApprovalRequestItemResource

Permintaan persetujuan dari manusia untuk penggunaan alat.

Nama	Tipe	Deskripsi	Diperlukan	Default
argumen	string	String argumen JSON untuk alat ini.	Yes
Nama	string	Nama alat yang akan dijalankan.	Yes
server_label	string	Label server MCP yang membuat permintaan.	Yes
jenis	enum	Nilai yang mungkin: mcp_approval_request	Yes

OpenAI.MCPApprovalResponseItemParam

Respons terhadap permintaan persetujuan MCP.

Nama	Tipe	Deskripsi	Diperlukan	Default
approval_request_id	string	ID permintaan persetujuan yang dijawab.	Yes
approve	Boolean	Apakah permintaan disetujui.	Yes
alasan	string	Alasan opsional untuk keputusan tersebut.	Tidak.
jenis	enum	Nilai yang mungkin: mcp_approval_response	Yes

OpenAI.MCPApprovalResponseItemResource

Respons terhadap permintaan persetujuan MCP.

Nama	Tipe	Deskripsi	Diperlukan	Default
approval_request_id	string	ID permintaan persetujuan yang dijawab.	Yes
approve	Boolean	Apakah permintaan disetujui.	Yes
alasan	string	Alasan opsional untuk keputusan tersebut.	Tidak.
jenis	enum	Nilai yang mungkin: mcp_approval_response	Yes

OpenAI.MCPCallItemParam

Pemanggilan alat di server MCP.

Nama	Tipe	Deskripsi	Diperlukan	Default
argumen	string	String JSON dari argumen yang dikirimkan ke alat.	Yes
galat	string	Kesalahan dari panggilan alat, jika ada.	Tidak.
Nama	string	Nama alat yang dijalankan.	Yes
output	string	Output dari pemanggilan alat.	Tidak.
server_label	string	Label server MCP yang menjalankan alat.	Yes
jenis	enum	Nilai yang mungkin: mcp_call	Yes

OpenAI.MCPCallItemResource

Pemanggilan alat di server MCP.

Nama	Tipe	Deskripsi	Diperlukan	Default
argumen	string	String JSON dari argumen yang dikirimkan ke alat.	Yes
galat	string	Kesalahan dari panggilan alat, jika ada.	Tidak.
Nama	string	Nama alat yang dijalankan.	Yes
output	string	Output dari pemanggilan alat.	Tidak.
server_label	string	Label server MCP yang menjalankan alat.	Yes
jenis	enum	Nilai yang mungkin: mcp_call	Yes

OpenAI.MCPListToolsItemParam

Daftar alat yang tersedia di server MCP.

Nama	Tipe	Deskripsi	Diperlukan	Default
galat	string	Pesan kesalahan jika server tidak dapat mencantumkan alat.	Tidak.
server_label	string	Label MCP server.	Yes
perangkat	array	Alat yang tersedia di server.	Yes
jenis	enum	Nilai yang mungkin: mcp_list_tools	Yes

OpenAI.MCPListToolsItemResource

Daftar alat yang tersedia di server MCP.

Nama	Tipe	Deskripsi	Diperlukan	Default
galat	string	Pesan kesalahan jika server tidak dapat mencantumkan alat.	Tidak.
server_label	string	Label MCP server.	Yes
perangkat	array	Alat yang tersedia di server.	Yes
jenis	enum	Nilai yang mungkin: mcp_list_tools	Yes

OpenAI.MCPListToolsTool

Alat yang tersedia di server MCP.

Nama	Tipe	Deskripsi	Diperlukan	Default
Anotasi		Anotasi tambahan tentang alat ini.	Tidak.
deskripsi	string	Penjabaran dari alat ini.	Tidak.
input_schema		Skema JSON yang menjelaskan input alat.	Yes
Nama	string	Nama alat.	Yes

OpenAI.MCPTool

Berikan model access ke alat tambahan melalui server Protokol Konteks Model jarak jauh (MCP).

Nama	Tipe	Deskripsi	Diperlukan	Default
alat_terizin	objek		Tidak.
└─ nama_alat	array	Daftar nama alat yang diizinkan.	Tidak.
headers	objek	Header HTTP opsional untuk dikirim ke server MCP. Gunakan untuk autentikasi atau tujuan lainnya.	Tidak.
memerlukan persetujuan	objek (lihat model yang valid di bawah)	Tentukan alat server MCP mana yang memerlukan persetujuan.	Tidak.
server_label	string	Label untuk server MCP ini, digunakan untuk mengidentifikasinya dalam panggilan alat.	Yes
server_url	string	URL untuk server MCP.	Yes
jenis	enum	Jenis alat MCP. Selalu mcp. Nilai yang mungkin: mcp	Yes

OpenAI.MetadataPropertyForRequest

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.

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, dan mengkueri objek melalui API atau dasbor. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter.	Tidak.

OpenAI.Model

Menjelaskan penawaran model OpenAI yang dapat digunakan dengan API.

Nama	Tipe	Deskripsi	Diperlukan	Default
Dibuat	bilangan bulat	Tanda waktu Unix (dalam detik) saat model dibuat.	Yes
id	string	Pengidentifikasi model, yang dapat dirujuk di titik akhir API.	Yes
objek	enum	Jenis objek, yang selalu "model". Nilai yang mungkin: model	Yes
owned_by	string	Organisasi yang memiliki model.	Yes

OpenAI.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	enum	Selalu other. Nilai yang mungkin: other	Yes

OpenAI.ParallelToolCalls

Apakah akan mengaktifkan panggilan fungsi paralel selama penggunaan alat.

Jenis: boolean

OpenAI.Prompt

Referensi ke templat perintah dan variabelnya.

Nama	Tipe	Deskripsi	Diperlukan	Default
id	string	Pengidentifikasi unik templat perintah yang akan digunakan.	Yes
variabel	objek	Peta nilai opsional untuk mengganti variabel dalam perintah Anda. Nilai substitusi dapat berupa string, atau jenis input Respons lainnya seperti gambar atau file.	Tidak.
versi	string	Versi opsional templat prompt.	Tidak.

OpenAI.RankingOptions

Nama	Tipe	Deskripsi	Diperlukan	Default
pemeringkat	enum	Ranker yang digunakan untuk pencarian file. Nilai yang mungkin: auto, default-2024-11-15	Tidak.
ambang_batas_skor	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.

OpenAI.Reasoning

model seri o saja

Nama	Tipe	Deskripsi	Diperlukan	Default
effort	objek	model seri o 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.	Tidak.
generate_summary	enum	Tidak digunakan lagi: gunakan summary sebagai gantinya. Ringkasan penalaran yang dilakukan oleh model. Ini dapat berguna untuk men-debug dan memahami proses penalaran model. Salah satu dari auto, concise, atau detailed. Nilai yang mungkin: auto, concise, detailed	Tidak.
summary	enum	Ringkasan penalaran yang dilakukan oleh model. Ini dapat berguna untuk men-debug dan memahami proses penalaran model. Salah satu dari auto, concise, atau detailed. Nilai yang mungkin: auto, concise, detailed	Tidak.

OpenAI.ReasoningEffort

model seri o 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.

Harta benda	Nilai
Deskripsi	model seri o 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.
Jenis	string
Nilai	low medium high

OpenAI.ReasoningItemParam

Deskripsi rantai pemikiran yang digunakan oleh model penalaran saat menghasilkan respons. Pastikan untuk menyertakan item-item ini dalam input ke API Respons untuk percakapan selanjutnya jika Anda mengelola konteks secara manual.

Nama	Tipe	Deskripsi	Diperlukan	Default
encrypted_content	string	Konten terenkripsi dari elemen penalaran - diisi saat respons dihasilkan dengan reasoning.encrypted_content dalam parameter include.	Tidak.
summary	array	Pemikiran mengenai isi teks	Yes
jenis	enum	Nilai yang mungkin: reasoning	Yes

OpenAI.ReasoningItemResource

Deskripsi rantai pemikiran yang digunakan oleh model penalaran saat menghasilkan respons. Pastikan untuk menyertakan item-item ini dalam input ke API Respons untuk percakapan selanjutnya jika Anda mengelola konteks secara manual.

Nama	Tipe	Deskripsi	Diperlukan	Default
encrypted_content	string	Konten terenkripsi dari elemen penalaran - diisi saat respons dihasilkan dengan reasoning.encrypted_content dalam parameter include.	Tidak.
summary	array	Pemikiran mengenai isi teks	Yes
jenis	enum	Nilai yang mungkin: reasoning	Yes

OpenAI.ReasoningItemSummaryPart

Diskriminator dari OpenAI.ReasoningItemSummaryPart

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
summary_text	OpenAI.ReasoningItemSummaryTextPart

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	OpenAI.ReasoningItemSummaryPartType		Yes

OpenAI.ReasoningItemSummaryPartType

Harta benda	Nilai
Jenis	string
Nilai	summary_text

OpenAI.ReasoningItemSummaryTextPart

Nama	Tipe	Deskripsi	Diperlukan	Default
kirim pesan teks	string		Yes
jenis	enum	Nilai yang mungkin: summary_text	Yes

OpenAI.Response

Nama	Tipe	Deskripsi	Diperlukan	Default
latar belakang	Boolean	Apakah akan menjalankan respons model di latar belakang.	Tidak.	False
dibuat_pada	bilangan bulat	Tanda waktu Unix (dalam detik) saat Respons ini dibuat.	Yes
galat	objek	Objek kesalahan dikembalikan saat model gagal menghasilkan Respons.	Yes
└─ kode	OpenAI.ResponseErrorCode	Kode kesalahan untuk respons.	Tidak.
└─ pesan	string	Deskripsi kesalahan yang dapat dibaca manusia.	Tidak.
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 atau array		Yes
max_output_tokens	bilangan bulat	Batas atas untuk jumlah token yang dapat dihasilkan untuk respons, termasuk token output yang terlihat dan token penalaran	Tidak.
max_tool_calls	bilangan bulat	Jumlah maksimum total panggilan ke alat bawaan yang dapat diproses dalam respons. Jumlah maksimum ini berlaku di semua panggilan alat bawaan, bukan per alat individual. Setiap upaya lebih lanjut untuk memanggil alat oleh model akan diabaikan.	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, dan mengkueri objek melalui API atau dasbor. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter.	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.
minta	objek	Referensi ke templat perintah dan variabelnya.	Tidak.
└─ ID	string	Pengidentifikasi unik templat perintah yang akan digunakan.	Tidak.
└─ variabel	OpenAI.ResponsePromptVariables	Peta nilai opsional untuk mengganti variabel dalam perintah Anda. Nilai substitusi dapat berupa string, atau jenis input Respons lainnya seperti gambar atau file.	Tidak.
└─ versi	string	Versi opsional templat prompt.	Tidak.
reasoning	objek	model seri o saja Opsi konfigurasi untuk model penalaran.	Tidak.
└─ usaha	OpenAI.ReasoningEffort	model seri o 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.	Tidak.
└─ menghasilkan_ringkasan	enum	Tidak digunakan lagi: gunakan summary sebagai gantinya. Ringkasan penalaran yang dilakukan oleh model. Ini dapat berguna untuk men-debug dan memahami proses penalaran model. Salah satu dari auto, concise, atau detailed. Nilai yang mungkin: auto, concise, detailed	Tidak.
└─ ringkasan	enum	Ringkasan penalaran yang dilakukan oleh model. Ini dapat berguna untuk men-debug dan memahami proses penalaran model. Salah satu dari auto, concise, atau detailed. Nilai yang mungkin: auto, concise, detailed	Tidak.
status	enum	Status generasi respons. Salah satu dari completed, , failedin_progress, cancelled, queued, atau incomplete. Nilai yang mungkin: completed, , failedin_progress, cancelled, queued,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
kirim pesan teks	objek	Opsi konfigurasi untuk respons teks dari model. Dapat berupa teks biasa atau data JSON terstruktur.	Tidak.
└─ bentuk	OpenAI.ResponseTextFormatConfiguration		Tidak.
tool_choice	objek	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.	Tidak.
└─ jenis	OpenAI.ToolChoiceObjectType	Menunjukkan bahwa model harus menggunakan alat bawaan untuk menghasilkan respons.	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.
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.	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.	Yes
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	OpenAI.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.	Yes

OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent

Dipancarkan ketika cuplikan kode parsial dialirkan oleh penerjemah kode.

Nama	Tipe	Deskripsi	Diperlukan	Default
delta	string	Cuplikan kode parsial yang dialirkan oleh penerjemah kode.	Yes
item_id	string	Pengidentifikasi unik item panggilan alat penerjemah kode.	Yes
output_index	bilangan bulat	Indeks item output dalam respons yang kodenya sedang dialirkan.	Yes
jenis	enum	Jenis peristiwa. Selalu response.code_interpreter_call_code.delta. Nilai yang mungkin: response.code_interpreter_call_code.delta	Yes

OpenAI.ResponseCodeInterpreterCallCodeDoneEvent

Dipancarkan ketika cuplikan kode diselesaikan oleh penerjemah kode.

Nama	Tipe	Deskripsi	Diperlukan	Default
kode	string	Output cuplikan kode akhir oleh penerjemah kode.	Yes
item_id	string	Pengidentifikasi unik item panggilan alat penerjemah kode.	Yes
output_index	bilangan bulat	Indeks item output dalam respons yang kodenya diselesaikan.	Yes
jenis	enum	Jenis peristiwa. Selalu response.code_interpreter_call_code.done. Nilai yang mungkin: response.code_interpreter_call_code.done	Yes

OpenAI.ResponseCodeInterpreterCallCompletedEvent

Dipancarkan ketika panggilan penerjemah kode selesai.

Nama	Tipe	Deskripsi	Diperlukan	Default
item_id	string	Pengidentifikasi unik item panggilan alat penerjemah kode.	Yes
output_index	bilangan bulat	Indeks item output dalam respons yang panggilan penerjemah kodenya selesai.	Yes
jenis	enum	Jenis peristiwa. Selalu response.code_interpreter_call.completed. Nilai yang mungkin: response.code_interpreter_call.completed	Yes

OpenAI.ResponseCodeInterpreterCallInProgressEvent

Dipancarkan saat panggilan penerjemah kode sedang berlangsung.

Nama	Tipe	Deskripsi	Diperlukan	Default
item_id	string	Pengidentifikasi unik item panggilan alat penerjemah kode.	Yes
output_index	bilangan bulat	Indeks item output dalam respons yang panggilan penerjemah kodenya sedang berlangsung.	Yes
jenis	enum	Jenis peristiwa. Selalu response.code_interpreter_call.in_progress. Nilai yang mungkin: response.code_interpreter_call.in_progress	Yes

OpenAI.ResponseCodeInterpreterCallInterpretingEvent

Dipancarkan ketika penerjemah kode secara aktif menafsirkan cuplikan kode.

Nama	Tipe	Deskripsi	Diperlukan	Default
item_id	string	Pengidentifikasi unik item panggilan alat penerjemah kode.	Yes
output_index	bilangan bulat	Indeks item output dalam respons yang ditafsirkan oleh penerjemah kode.	Yes
jenis	enum	Jenis peristiwa. Selalu response.code_interpreter_call.interpreting. Nilai yang mungkin: response.code_interpreter_call.interpreting	Yes

OpenAI.ResponseCompletedEvent

Dipancarkan saat respons model selesai.

Nama	Tipe	Deskripsi	Diperlukan	Default
response	objek		Yes
└─ latar belakang	Boolean	Apakah akan menjalankan respons model di latar belakang.	Tidak.	False
└─ dibuat_pada	bilangan bulat	Tanda waktu Unix (dalam detik) saat Respons ini dibuat.	Tidak.
└─ kesalahan	OpenAI.ResponseError	Objek kesalahan dikembalikan saat model gagal menghasilkan Respons.	Tidak.
└─ ID	string	Pengidentifikasi unik untuk Respons ini.	Tidak.
└─ detail_tidak_lengkap	objek	Detail tentang mengapa respons tidak lengkap.	Tidak.
└─ alasan	enum	Alasan mengapa respons tidak lengkap. Nilai yang mungkin: max_output_tokens, content_filter	Tidak.
└─ instruksi	string atau array	Pesan sistem (atau pengembang) dimasukkan ke 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 yang terlihat dan token penalaran	Tidak.
└─ max_tool_calls	bilangan bulat	Jumlah maksimum total panggilan ke alat bawaan yang dapat diproses dalam respons. Jumlah maksimum ini berlaku di semua panggilan alat bawaan, bukan per alat individual. Setiap upaya lebih lanjut untuk memanggil alat oleh model akan diabaikan.	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, dan mengkueri objek melalui API atau dasbor. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter.	Tidak.
└─ objek	enum	Jenis objek sumber daya ini - selalu diatur ke response. Nilai yang mungkin: response	Tidak.
└─ keluaran	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.	Tidak.
└─ teks hasil	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_parallel	Boolean	Apakah akan mengizinkan model menjalankan panggilan alat secara paralel.	Tidak.	Benar
└─ ID_respons_sebelumnya	string	ID unik dari respons sebelumnya ke model. Gunakan ini untuk membuat percakapan multi-giliran.	Tidak.
└─ perintah	OpenAI.Prompt	Referensi ke templat perintah dan variabelnya.	Tidak.
└─ penalaran	OpenAI.Reasoning	model seri o saja Opsi konfigurasi untuk model penalaran.	Tidak.
└─ status	enum	Status generasi respons. Salah satu dari completed, , failedin_progress, cancelled, queued, atau incomplete. Nilai yang mungkin: completed, , failedin_progress, cancelled, queued,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.	Tidak.
└─ teks	objek	Opsi konfigurasi untuk respons teks dari model. Dapat berupa teks biasa atau data JSON terstruktur.	Tidak.
└─ bentuk	OpenAI.ResponseTextFormatConfiguration		Tidak.
└─ pilihan_alat	OpenAI.ToolChoiceOptions atau OpenAI.ToolChoiceObject	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.
└─ peralatan	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.
└─ 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.	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.
└─ pemotongan	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.
└─ penggunaan	OpenAI.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.
jenis	enum	Jenis peristiwa. Selalu response.completed. Nilai yang mungkin: response.completed	Yes

OpenAI.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	objek		Yes
└─ jenis	OpenAI.ItemContentType	Konten multi-modal untuk input dan output.	Tidak.
jenis	enum	Jenis peristiwa. Selalu response.content_part.added. Nilai yang mungkin: response.content_part.added	Yes

OpenAI.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	objek		Yes
└─ jenis	OpenAI.ItemContentType	Konten multi-modal untuk input dan output.	Tidak.
jenis	enum	Jenis peristiwa. Selalu response.content_part.done. Nilai yang mungkin: response.content_part.done	Yes

OpenAI.ResponseCreatedEvent

Peristiwa yang dipancarkan saat respons dibuat.

Nama	Tipe	Deskripsi	Diperlukan	Default
response	objek		Yes
└─ latar belakang	Boolean	Apakah akan menjalankan respons model di latar belakang.	Tidak.	False
└─ dibuat_pada	bilangan bulat	Tanda waktu Unix (dalam detik) saat Respons ini dibuat.	Tidak.
└─ kesalahan	OpenAI.ResponseError	Objek kesalahan dikembalikan saat model gagal menghasilkan Respons.	Tidak.
└─ ID	string	Pengidentifikasi unik untuk Respons ini.	Tidak.
└─ detail_tidak_lengkap	objek	Detail tentang mengapa respons tidak lengkap.	Tidak.
└─ alasan	enum	Alasan mengapa respons tidak lengkap. Nilai yang mungkin: max_output_tokens, content_filter	Tidak.
└─ instruksi	string atau array	Pesan sistem (atau pengembang) dimasukkan ke 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 yang terlihat dan token penalaran	Tidak.
└─ max_tool_calls	bilangan bulat	Jumlah maksimum total panggilan ke alat bawaan yang dapat diproses dalam respons. Jumlah maksimum ini berlaku di semua panggilan alat bawaan, bukan per alat individual. Setiap upaya lebih lanjut untuk memanggil alat oleh model akan diabaikan.	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, dan mengkueri objek melalui API atau dasbor. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter.	Tidak.
└─ objek	enum	Jenis objek sumber daya ini - selalu diatur ke response. Nilai yang mungkin: response	Tidak.
└─ keluaran	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.	Tidak.
└─ teks hasil	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_parallel	Boolean	Apakah akan mengizinkan model menjalankan panggilan alat secara paralel.	Tidak.	Benar
└─ ID_respons_sebelumnya	string	ID unik dari respons sebelumnya ke model. Gunakan ini untuk membuat percakapan multi-giliran.	Tidak.
└─ perintah	OpenAI.Prompt	Referensi ke templat perintah dan variabelnya.	Tidak.
└─ penalaran	OpenAI.Reasoning	model seri o saja Opsi konfigurasi untuk model penalaran.	Tidak.
└─ status	enum	Status generasi respons. Salah satu dari completed, failed, in_progress, cancelled, queued, atau incomplete. Nilai yang mungkin: completed, , failedin_progress, cancelled, queued,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.	Tidak.
└─ teks	objek	Opsi konfigurasi untuk respons teks dari model. Dapat berupa teks biasa atau data JSON terstruktur.	Tidak.
└─ bentuk	OpenAI.ResponseTextFormatConfiguration		Tidak.
└─ pilihan_alat	OpenAI.ToolChoiceOptions atau OpenAI.ToolChoiceObject	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.
└─ peralatan	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.
└─ 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.	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.
└─ pemotongan	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.
└─ penggunaan	OpenAI.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.
jenis	enum	Jenis peristiwa. Selalu response.created. Nilai yang mungkin: response.created	Yes

OpenAI.ResponseError

Objek kesalahan dikembalikan saat model gagal menghasilkan Respons.

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

OpenAI.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

OpenAI.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

OpenAI.ResponseFailedEvent

Sebuah event yang dikeluarkan ketika respons gagal.

Nama	Tipe	Deskripsi	Diperlukan	Default
response	objek		Yes
└─ latar belakang	Boolean	Apakah akan menjalankan respons model di latar belakang.	Tidak.	False
└─ dibuat_pada	bilangan bulat	Tanda waktu Unix (dalam detik) saat Respons ini dibuat.	Tidak.
└─ kesalahan	OpenAI.ResponseError	Objek kesalahan dikembalikan saat model gagal menghasilkan Respons.	Tidak.
└─ ID	string	Pengidentifikasi unik untuk Respons ini.	Tidak.
└─ detail_tidak_lengkap	objek	Detail tentang mengapa respons tidak lengkap.	Tidak.
└─ alasan	enum	Alasan mengapa respons tidak lengkap. Nilai yang mungkin: max_output_tokens, content_filter	Tidak.
└─ instruksi	string atau array	Pesan sistem (atau pengembang) dimasukkan ke 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 yang terlihat dan token penalaran	Tidak.
└─ max_tool_calls	bilangan bulat	Jumlah maksimum total panggilan ke alat bawaan yang dapat diproses dalam respons. Jumlah maksimum ini berlaku di semua panggilan alat bawaan, bukan per alat individual. Setiap upaya lebih lanjut untuk memanggil alat oleh model akan diabaikan.	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, dan mengkueri objek melalui API atau dasbor. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter.	Tidak.
└─ objek	enum	Jenis objek sumber daya ini - selalu diatur ke response. Nilai yang mungkin: response	Tidak.
└─ keluaran	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.	Tidak.
└─ teks hasil	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_parallel	Boolean	Apakah akan mengizinkan model menjalankan panggilan alat secara paralel.	Tidak.	Benar
└─ ID_respons_sebelumnya	string	ID unik dari respons sebelumnya ke model. Gunakan ini untuk membuat percakapan multi-giliran.	Tidak.
└─ perintah	OpenAI.Prompt	Referensi ke templat perintah dan variabelnya.	Tidak.
└─ penalaran	OpenAI.Reasoning	model seri o saja Opsi konfigurasi untuk model penalaran.	Tidak.
└─ status	enum	Status generasi respons. Salah satu dari completed, , failedin_progress, cancelled, queued, atau incomplete. Nilai yang mungkin: completed, , failedin_progress, cancelled, queued,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.	Tidak.
└─ teks	objek	Opsi konfigurasi untuk respons teks dari model. Dapat berupa teks biasa atau data JSON terstruktur.	Tidak.
└─ bentuk	OpenAI.ResponseTextFormatConfiguration		Tidak.
└─ pilihan_alat	OpenAI.ToolChoiceOptions atau OpenAI.ToolChoiceObject	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.
└─ peralatan	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.
└─ 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.	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.
└─ pemotongan	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.
└─ penggunaan	OpenAI.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.
jenis	enum	Jenis peristiwa. Selalu response.failed. Nilai yang mungkin: response.failed	Yes

OpenAI.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

OpenAI.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

OpenAI.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

OpenAI.ResponseFormat

Diskriminator untuk OpenAI.ResponseFormat

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
text	OpenAI.ResponseFormatText
json_object	OpenAI.ResponseFormatJsonObject
json_schema	OpenAI.ResponseFormatJsonSchema

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	enum	Nilai yang mungkin: text, json_object, json_schema	Yes

OpenAI.ResponseFormatJsonObject

Format respons objek JSON. Metode lama untuk menghasilkan respons JSON. Penggunaan json_schema disarankan untuk model yang mendukungnya. Perhatikan bahwa model tidak akan menghasilkan JSON tanpa sistem atau pesan pengguna yang menginstruksikannya to do demikian.

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

OpenAI.ResponseFormatJsonSchema

Format Skema JSON untuk respons. Digunakan untuk menghasilkan respons JSON terstruktur.

Nama	Tipe	Deskripsi	Diperlukan	Default
json_schema	objek	Opsi konfigurasi Output Terstruktur, termasuk Skema JSON.	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	OpenAI.ResponseFormatJsonSchemaSchema	Skema untuk format respons, dijelaskan sebagai objek Skema JSON. Pelajari cara membuat skema JSON di sini.	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. Selalu json_schema. Nilai yang mungkin: json_schema	Yes

OpenAI.ResponseFormatJsonSchemaSchema

Skema untuk format respons, dijelaskan sebagai objek Skema JSON. Pelajari cara membuat skema JSON di sini.

Jenis: objek

OpenAI.ResponseFormatText

Format tanggapan bawaan. Digunakan untuk menghasilkan respons teks.

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

OpenAI.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

OpenAI.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

OpenAI.ResponseImageGenCallCompletedEvent

Dipancarkan ketika panggilan alat pembuatan gambar telah selesai dan gambar akhir tersedia.

Nama	Tipe	Deskripsi	Diperlukan	Default
item_id	string	Pengidentifikasi unik elemen pembuatan gambar yang sedang diproses.	Yes
output_index	bilangan bulat	Indeks item output pada keluaran array respons.	Yes
jenis	enum	Jenis peristiwa. Selalu 'response.image_generation_call.completed'. Nilai yang mungkin: response.image_generation_call.completed	Yes

OpenAI.ResponseImageGenCallGeneratingEvent

Dipancarkan saat panggilan alat pembuatan gambar secara aktif menghasilkan gambar (status menengah).

Nama	Tipe	Deskripsi	Diperlukan	Default
item_id	string	Pengidentifikasi unik elemen pembuatan gambar yang sedang diproses.	Yes
output_index	bilangan bulat	Indeks item output pada keluaran array respons.	Yes
jenis	enum	Jenis peristiwa. Selalu 'response.image_generation_call.generating'. Nilai yang mungkin: response.image_generation_call.generating	Yes

OpenAI.ResponseImageGenCallInProgressEvent

Dipancarkan ketika panggilan alat pembuatan gambar sedang berlangsung.

Nama	Tipe	Deskripsi	Diperlukan	Default
item_id	string	Pengidentifikasi unik elemen pembuatan gambar yang sedang diproses.	Yes
output_index	bilangan bulat	Indeks item output pada keluaran array respons.	Yes
jenis	enum	Jenis peristiwa. Selalu 'response.image_generation_call.in_progress'. Nilai yang mungkin: response.image_generation_call.in_progress	Yes

OpenAI.ResponseImageGenCallPartialImageEvent

Dipancarkan saat gambar parsial tersedia selama streaming proses pembuatan gambar.

Nama	Tipe	Deskripsi	Diperlukan	Default
item_id	string	Pengidentifikasi unik elemen pembuatan gambar yang sedang diproses.	Yes
output_index	bilangan bulat	Indeks item output pada keluaran array respons.	Yes
partial_image_b64	string	Data gambar parsial yang dikodekan Base64, cocok untuk penyajian sebagai gambar.	Yes
partial_image_index	bilangan bulat	Indeks berbasis 0 untuk gambar parsial (sistem backend berbasis 1, tetapi ini berbasis 0 untuk pengguna).	Yes
jenis	enum	Jenis peristiwa. Pasti selalu 'response.image_generation_call.partial_image'. Nilai yang mungkin: response.image_generation_call.partial_image	Yes

OpenAI.ResponseInProgressEvent

Dipancarkan ketika respons sedang berlangsung.

Nama	Tipe	Deskripsi	Diperlukan	Default
response	objek		Yes
└─ latar belakang	Boolean	Apakah akan menjalankan respons model di latar belakang.	Tidak.	False
└─ dibuat_pada	bilangan bulat	Tanda waktu Unix (dalam detik) saat Respons ini dibuat.	Tidak.
└─ kesalahan	OpenAI.ResponseError	Objek kesalahan dikembalikan saat model gagal menghasilkan Respons.	Tidak.
└─ ID	string	Pengidentifikasi unik untuk Respons ini.	Tidak.
└─ detail_tidak_lengkap	objek	Detail tentang mengapa respons tidak lengkap.	Tidak.
└─ alasan	enum	Alasan mengapa respons tidak lengkap. Nilai yang mungkin: max_output_tokens, content_filter	Tidak.
└─ instruksi	string atau array	Pesan sistem (atau pengembang) dimasukkan ke 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 yang terlihat dan token penalaran	Tidak.
└─ max_tool_calls	bilangan bulat	Jumlah maksimum total panggilan ke alat bawaan yang dapat diproses dalam respons. Jumlah maksimum ini berlaku di semua panggilan alat bawaan, bukan per alat individual. Setiap upaya lebih lanjut untuk memanggil alat oleh model akan diabaikan.	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, dan mengkueri objek melalui API atau dasbor. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter.	Tidak.
└─ objek	enum	Jenis objek sumber daya ini - selalu diatur ke response. Nilai yang mungkin: response	Tidak.
└─ keluaran	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.	Tidak.
└─ teks hasil	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_parallel	Boolean	Apakah akan mengizinkan model menjalankan panggilan alat secara paralel.	Tidak.	Benar
└─ ID_respons_sebelumnya	string	ID unik dari respons sebelumnya ke model. Gunakan ini untuk membuat percakapan multi-giliran.	Tidak.
└─ perintah	OpenAI.Prompt	Referensi ke templat perintah dan variabelnya.	Tidak.
└─ penalaran	OpenAI.Reasoning	model seri o saja Opsi konfigurasi untuk model penalaran.	Tidak.
└─ status	enum	Status generasi respons. Salah satu dari completed, , failedin_progress, cancelled, queued, atau incomplete. Nilai yang mungkin: completed, , failedin_progress, cancelled, queued,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.	Tidak.
└─ teks	objek	Opsi konfigurasi untuk respons teks dari model. Dapat berupa teks biasa atau data JSON terstruktur.	Tidak.
└─ bentuk	OpenAI.ResponseTextFormatConfiguration		Tidak.
└─ pilihan_alat	OpenAI.ToolChoiceOptions atau OpenAI.ToolChoiceObject	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.
└─ peralatan	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.
└─ 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.	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.
└─ pemotongan	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.
└─ penggunaan	OpenAI.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.
jenis	enum	Jenis peristiwa. Selalu response.in_progress. Nilai yang mungkin: response.in_progress	Yes

OpenAI.ResponseIncompleteEvent

Peristiwa yang dipancarkan ketika respons selesai sebagai tidak lengkap.

Nama	Tipe	Deskripsi	Diperlukan	Default
response	objek		Yes
└─ latar belakang	Boolean	Apakah akan menjalankan respons model di latar belakang.	Tidak.	False
└─ dibuat_pada	bilangan bulat	Tanda waktu Unix (dalam detik) saat Respons ini dibuat.	Tidak.
└─ kesalahan	OpenAI.ResponseError	Objek kesalahan dikembalikan saat model gagal menghasilkan Respons.	Tidak.
└─ ID	string	Pengidentifikasi unik untuk Respons ini.	Tidak.
└─ detail_tidak_lengkap	objek	Detail tentang mengapa respons tidak lengkap.	Tidak.
└─ alasan	enum	Alasan mengapa respons tidak lengkap. Nilai yang mungkin: max_output_tokens, content_filter	Tidak.
└─ instruksi	string atau array	Pesan sistem (atau pengembang) dimasukkan ke 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 yang terlihat dan token penalaran	Tidak.
└─ max_tool_calls	bilangan bulat	Jumlah maksimum total panggilan ke alat bawaan yang dapat diproses dalam respons. Jumlah maksimum ini berlaku di semua panggilan alat bawaan, bukan per alat individual. Setiap upaya lebih lanjut untuk memanggil alat oleh model akan diabaikan.	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, dan mengkueri objek melalui API atau dasbor. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter.	Tidak.
└─ objek	enum	Jenis objek sumber daya ini - selalu diatur ke response. Nilai yang mungkin: response	Tidak.
└─ keluaran	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.	Tidak.
└─ teks hasil	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_parallel	Boolean	Apakah akan mengizinkan model menjalankan panggilan alat secara paralel.	Tidak.	Benar
└─ ID_respons_sebelumnya	string	ID unik dari respons sebelumnya ke model. Gunakan ini untuk membuat percakapan multi-giliran.	Tidak.
└─ perintah	OpenAI.Prompt	Referensi ke templat perintah dan variabelnya.	Tidak.
└─ penalaran	OpenAI.Reasoning	model seri o saja Opsi konfigurasi untuk model penalaran.	Tidak.
└─ status	enum	Status generasi respons. Salah satu dari completed, , failedin_progress, cancelled, queued, atau incomplete. Nilai yang mungkin: completed, , failedin_progress, cancelled, queued,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.	Tidak.
└─ teks	objek	Opsi konfigurasi untuk respons teks dari model. Dapat berupa teks biasa atau data JSON terstruktur.	Tidak.
└─ bentuk	OpenAI.ResponseTextFormatConfiguration		Tidak.
└─ pilihan_alat	OpenAI.ToolChoiceOptions atau OpenAI.ToolChoiceObject	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.
└─ peralatan	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.
└─ 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.	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.
└─ pemotongan	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.
└─ penggunaan	OpenAI.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.
jenis	enum	Jenis peristiwa. Selalu response.incomplete. Nilai yang mungkin: response.incomplete	Yes

OpenAI.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

OpenAI.ResponseMCPCallArgumentsDeltaEvent

Dikeluarkan ketika ada perubahan parsial pada argumen panggilan alat MCP.

Nama	Tipe	Deskripsi	Diperlukan	Default
delta		Pembaruan parsial pada argumen untuk pemanggilan alat MCP.	Yes
item_id	string	Pengidentifikasi unik dari item panggilan alat MCP yang sedang diproses.	Yes
output_index	bilangan bulat	Indeks item output pada keluaran array respons.	Yes
jenis	enum	Jenis peristiwa. Selalu 'response.mcp_call.arguments_delta'. Nilai yang mungkin: response.mcp_call.arguments_delta	Yes

OpenAI.ResponseMCPCallArgumentsDoneEvent

Dipancarkan ketika argumen untuk panggilan alat MCP diselesaikan.

Nama	Tipe	Deskripsi	Diperlukan	Default
argumen		Argumen final untuk pemanggilan alat MCP.	Yes
item_id	string	Pengidentifikasi unik dari item panggilan alat MCP yang sedang diproses.	Yes
output_index	bilangan bulat	Indeks item output pada keluaran array respons.	Yes
jenis	enum	Jenis peristiwa. Selalu 'response.mcp_call.arguments_done'. Nilai yang mungkin: response.mcp_call.arguments_done	Yes

OpenAI.ResponseMCPCallCompletedEvent

Dipancarkan ketika panggilan alat MCP berhasil diselesaikan.

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

OpenAI.ResponseMCPCallFailedEvent

Dipancarkan ketika panggilan alat MCP gagal.

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

OpenAI.ResponseMCPCallInProgressEvent

Dipancarkan ketika panggilan alat MCP sedang berlangsung.

Nama	Tipe	Deskripsi	Diperlukan	Default
item_id	string	Pengidentifikasi unik dari item panggilan alat MCP yang sedang diproses.	Yes
output_index	bilangan bulat	Indeks item output pada keluaran array respons.	Yes
jenis	enum	Jenis peristiwa. Selalu 'response.mcp_call.in_progress'. Nilai yang mungkin: response.mcp_call.in_progress	Yes

OpenAI.ResponseMCPListToolsCompletedEvent

Diterbitkan ketika daftar alat MCP yang tersedia telah berhasil diperoleh.

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

OpenAI.ResponseMCPListToolsFailedEvent

Dipancarkan ketika upaya untuk mencantumkan alat MCP yang tersedia telah gagal.

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

OpenAI.ResponseMCPListToolsInProgressEvent

Dipancarkan ketika sistem sedang dalam proses pengambilan daftar alat MCP yang tersedia.

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

OpenAI.ResponseOutputItemAddedEvent

Dipancarkan saat item output baru ditambahkan.

Nama	Tipe	Deskripsi	Diperlukan	Default
item	objek	Item konten yang digunakan untuk menghasilkan respons.	Yes
└─ ID	string		Tidak.
└─ jenis	OpenAI.ItemType		Tidak.
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

OpenAI.ResponseOutputItemDoneEvent

Dipancarkan saat item output ditandai selesai.

Nama	Tipe	Deskripsi	Diperlukan	Default
item	objek	Item konten yang digunakan untuk menghasilkan respons.	Yes
└─ ID	string		Tidak.
└─ jenis	OpenAI.ItemType		Tidak.
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

OpenAI.ResponsePromptVariables

Peta nilai opsional untuk mengganti variabel dalam perintah Anda. Nilai substitusi dapat berupa string, atau jenis input Respons lainnya seperti gambar atau file.

Jenis: objek

OpenAI.ResponseQueuedEvent

Dipancarkan ketika respons diantrekan dan menunggu untuk diproses.

Nama	Tipe	Deskripsi	Diperlukan	Default
response	objek		Yes
└─ latar belakang	Boolean	Apakah akan menjalankan respons model di latar belakang.	Tidak.	False
└─ dibuat_pada	bilangan bulat	Tanda waktu Unix (dalam detik) saat Respons ini dibuat.	Tidak.
└─ kesalahan	OpenAI.ResponseError	Objek kesalahan dikembalikan saat model gagal menghasilkan Respons.	Tidak.
└─ ID	string	Pengidentifikasi unik untuk Respons ini.	Tidak.
└─ detail_tidak_lengkap	objek	Detail tentang mengapa respons tidak lengkap.	Tidak.
└─ alasan	enum	Alasan mengapa respons tidak lengkap. Nilai yang mungkin: max_output_tokens, content_filter	Tidak.
└─ instruksi	string atau array	Pesan sistem (atau pengembang) dimasukkan ke 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 yang terlihat dan token penalaran	Tidak.
└─ max_tool_calls	bilangan bulat	Jumlah maksimum total panggilan ke alat bawaan yang dapat diproses dalam respons. Jumlah maksimum ini berlaku di semua panggilan alat bawaan, bukan per alat individual. Setiap upaya lebih lanjut untuk memanggil alat oleh model akan diabaikan.	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, dan mengkueri objek melalui API atau dasbor. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter.	Tidak.
└─ objek	enum	Jenis objek sumber daya ini - selalu diatur ke response. Nilai yang mungkin: response	Tidak.
└─ keluaran	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.	Tidak.
└─ teks hasil	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_parallel	Boolean	Apakah akan mengizinkan model menjalankan panggilan alat secara paralel.	Tidak.	Benar
└─ ID_respons_sebelumnya	string	ID unik dari respons sebelumnya ke model. Gunakan ini untuk membuat percakapan multi-giliran.	Tidak.
└─ perintah	OpenAI.Prompt	Referensi ke templat perintah dan variabelnya.	Tidak.
└─ penalaran	OpenAI.Reasoning	model seri o saja Opsi konfigurasi untuk model penalaran.	Tidak.
└─ status	enum	Status generasi respons. Salah satu dari completed, , failedin_progress, cancelled, queued, atau incomplete. Nilai yang mungkin: completed, , failedin_progress, cancelled, queued,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.	Tidak.
└─ teks	objek	Opsi konfigurasi untuk respons teks dari model. Dapat berupa teks biasa atau data JSON terstruktur.	Tidak.
└─ bentuk	OpenAI.ResponseTextFormatConfiguration		Tidak.
└─ pilihan_alat	OpenAI.ToolChoiceOptions atau OpenAI.ToolChoiceObject	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.
└─ peralatan	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.
└─ 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.	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.
└─ pemotongan	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.
└─ penggunaan	OpenAI.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.
jenis	enum	Jenis peristiwa. Selalu 'response.queued'. Nilai yang mungkin: response.queued	Yes

OpenAI.ResponseReasoningDeltaEvent

Dipancarkan ketika ada perubahan (pembaruan parsial) pada konten penalaran.

Nama	Tipe	Deskripsi	Diperlukan	Default
content_index	bilangan bulat	Indeks bagian konten penalaran dalam item keluaran.	Yes
delta		Pembaruan parsial pada konten alasan.	Yes
item_id	string	Pengidentifikasi unik item yang penalarannya sedang diperbarui.	Yes
output_index	bilangan bulat	Indeks item output pada keluaran array respons.	Yes
jenis	enum	Jenis peristiwa. Selalu 'response.reasoning.delta'. Nilai yang mungkin: response.reasoning.delta	Yes

OpenAI.ResponseReasoningDoneEvent

Diterbitkan saat konten penalaran ditetapkan untuk item.

Nama	Tipe	Deskripsi	Diperlukan	Default
content_index	bilangan bulat	Indeks bagian konten penalaran dalam item keluaran.	Yes
item_id	string	Pengidentifikasi unik untuk item yang proses penalarannya telah diselesaikan.	Yes
output_index	bilangan bulat	Indeks item output pada keluaran array respons.	Yes
kirim pesan teks	string	Teks penalaran yang diselesaikan.	Yes
jenis	enum	Jenis peristiwa. Selalu 'response.reasoning.done'. Nilai yang mungkin: response.reasoning.done	Yes

OpenAI.ResponseReasoningSummaryDeltaEvent

Dipancarkan ketika ada perubahan (pembaruan parsial) pada konten ringkasan penalaran.

Nama	Tipe	Deskripsi	Diperlukan	Default
delta		Pembaruan parsial untuk konten ringkasan penalaran.	Yes
item_id	string	Pengidentifikasi unik dari barang yang ringkasan penalarannya sedang diperbarui.	Yes
output_index	bilangan bulat	Indeks item output pada keluaran array respons.	Yes
summary_index	bilangan bulat	Indeks bagian ringkasan pada item keluaran.	Yes
jenis	enum	Jenis peristiwa. Selalu 'response.reasoning_summary.delta'. Nilai yang mungkin: response.reasoning_summary.delta	Yes

OpenAI.ResponseReasoningSummaryDoneEvent

Dimunculkan saat konten ringkasan alur logika diselesaikan untuk suatu item.

Nama	Tipe	Deskripsi	Diperlukan	Default
item_id	string	Pengidentifikasi unik barang yang ringkasan penalarannya telah diselesaikan.	Yes
output_index	bilangan bulat	Indeks item output pada keluaran array respons.	Yes
summary_index	bilangan bulat	Indeks bagian ringkasan pada item keluaran.	Yes
kirim pesan teks	string	Teks ringkasan penalaran yang diselesaikan.	Yes
jenis	enum	Jenis peristiwa. Selalu 'response.reasoning_summary.done'. Nilai yang mungkin: response.reasoning_summary.done	Yes

OpenAI.ResponseReasoningSummaryPartAddedEvent

Dikeluarkan saat bagian ringkasan penalaran baru ditambahkan.

Nama	Tipe	Deskripsi	Diperlukan	Default
item_id	string	ID item yang dikaitkan dengan bagian ringkasan ini.	Yes
output_index	bilangan bulat	Indeks item output yang dikaitkan dengan bagian ringkasan ini.	Yes
bagian	objek		Yes
└─ jenis	OpenAI.ReasoningItemSummaryPartType		Tidak.
summary_index	bilangan bulat	Indeks bagian ikhtisar dalam rangkuman penalaran.	Yes
jenis	enum	Jenis peristiwa. Selalu response.reasoning_summary_part.added. Nilai yang mungkin: response.reasoning_summary_part.added	Yes

OpenAI.ResponseReasoningSummaryPartDoneEvent

Dihasilkan saat bagian ringkasan penalaran selesai.

Nama	Tipe	Deskripsi	Diperlukan	Default
item_id	string	ID item yang dikaitkan dengan bagian ringkasan ini.	Yes
output_index	bilangan bulat	Indeks item output yang dikaitkan dengan bagian ringkasan ini.	Yes
bagian	objek		Yes
└─ jenis	OpenAI.ReasoningItemSummaryPartType		Tidak.
summary_index	bilangan bulat	Indeks bagian ikhtisar dalam rangkuman penalaran.	Yes
jenis	enum	Jenis peristiwa. Selalu response.reasoning_summary_part.done. Nilai yang mungkin: response.reasoning_summary_part.done	Yes

OpenAI.ResponseReasoningSummaryTextDeltaEvent

Dikeluarkan saat sebuah delta ditambahkan ke ringkasan teks penalaran.

Nama	Tipe	Deskripsi	Diperlukan	Default
delta	string	Delta teks yang ditambahkan ke ringkasan.	Yes
item_id	string	ID item yang dikaitkan dengan delta teks ringkasan ini.	Yes
output_index	bilangan bulat	Indeks item output yang terkait dengan delta teks ringkasan ini.	Yes
summary_index	bilangan bulat	Indeks bagian ikhtisar dalam rangkuman penalaran.	Yes
jenis	enum	Jenis peristiwa. Selalu response.reasoning_summary_text.delta. Nilai yang mungkin: response.reasoning_summary_text.delta	Yes

OpenAI.ResponseReasoningSummaryTextDoneEvent

Dikeluarkan saat teks ringkasan penalaran selesai.

Nama	Tipe	Deskripsi	Diperlukan	Default
item_id	string	ID dari item yang terkait dengan teks ringkasan ini.	Yes
output_index	bilangan bulat	Indeks item keluaran yang terkait dengan teks ringkasan ini.	Yes
summary_index	bilangan bulat	Indeks bagian ikhtisar dalam rangkuman penalaran.	Yes
kirim pesan teks	string	Teks lengkap ringkasan penalaran yang telah selesai.	Yes
jenis	enum	Jenis peristiwa. Selalu response.reasoning_summary_text.done. Nilai yang mungkin: response.reasoning_summary_text.done	Yes

OpenAI.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

OpenAI.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

OpenAI.ResponseStreamEvent

Diskriminator untuk OpenAI.ResponseStreamEvent

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
response.completed	OpenAI.ResponseCompletedEvent
response.content_part.added	OpenAI.ResponseContentPartAddedEvent
response.content_part.done	OpenAI.ResponseContentPartDoneEvent
response.created	OpenAI.ResponseCreatedEvent
error	OpenAI.ResponseErrorEvent
response.file_search_call.completed	OpenAI.ResponseFileSearchCallCompletedEvent
response.file_search_call.in_progress	OpenAI.ResponseFileSearchCallInProgressEvent
response.file_search_call.searching	OpenAI.ResponseFileSearchCallSearchingEvent
response.function_call_arguments.delta	OpenAI.ResponseFunctionCallArgumentsDeltaEvent
response.function_call_arguments.done	OpenAI.ResponseFunctionCallArgumentsDoneEvent
response.in_progress	OpenAI.ResponseInProgressEvent
response.failed	OpenAI.ResponseFailedEvent
response.incomplete	OpenAI.ResponseIncompleteEvent
response.output_item.added	OpenAI.ResponseOutputItemAddedEvent
response.output_item.done	OpenAI.ResponseOutputItemDoneEvent
response.refusal.delta	OpenAI.ResponseRefusalDeltaEvent
response.refusal.done	OpenAI.ResponseRefusalDoneEvent
response.output_text.delta	OpenAI.ResponseTextDeltaEvent
response.output_text.done	OpenAI.ResponseTextDoneEvent
response.reasoning_summary_part.added	OpenAI.ResponseReasoningSummaryPartAddedEvent
response.reasoning_summary_part.done	OpenAI.ResponseReasoningSummaryPartDoneEvent
response.reasoning_summary_text.delta	OpenAI.ResponseReasoningSummaryTextDeltaEvent
response.reasoning_summary_text.done	OpenAI.ResponseReasoningSummaryTextDoneEvent
response.web_search_call.completed	OpenAI.ResponseWebSearchCallCompletedEvent
response.web_search_call.in_progress	OpenAI.ResponseWebSearchCallInProgressEvent
response.web_search_call.searching	OpenAI.ResponseWebSearchCallSearchingEvent
response.image_generation_call.completed	OpenAI.ResponseImageGenCallCompletedEvent
response.image_generation_call.generating	OpenAI.ResponseImageGenCallGeneratingEvent
response.image_generation_call.in_progress	OpenAI.ResponseImageGenCallInProgressEvent
response.image_generation_call.partial_image	OpenAI.ResponseImageGenCallPartialImageEvent
response.mcp_call.arguments_delta	OpenAI.ResponseMCPCallArgumentsDeltaEvent
response.mcp_call.arguments_done	OpenAI.ResponseMCPCallArgumentsDoneEvent
response.mcp_call.completed	OpenAI.ResponseMCPCallCompletedEvent
response.mcp_call.failed	OpenAI.ResponseMCPCallFailedEvent
response.mcp_call.in_progress	OpenAI.ResponseMCPCallInProgressEvent
response.mcp_list_tools.completed	OpenAI.ResponseMCPListToolsCompletedEvent
response.mcp_list_tools.failed	OpenAI.ResponseMCPListToolsFailedEvent
response.mcp_list_tools.in_progress	OpenAI.ResponseMCPListToolsInProgressEvent
response.queued	OpenAI.ResponseQueuedEvent
response.reasoning.delta	OpenAI.ResponseReasoningDeltaEvent
response.reasoning.done	OpenAI.ResponseReasoningDoneEvent
response.reasoning_summary.delta	OpenAI.ResponseReasoningSummaryDeltaEvent
response.reasoning_summary.done	OpenAI.ResponseReasoningSummaryDoneEvent
response.code_interpreter_call_code.delta	OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent
response.code_interpreter_call_code.done	OpenAI.ResponseCodeInterpreterCallCodeDoneEvent
response.code_interpreter_call.completed	OpenAI.ResponseCodeInterpreterCallCompletedEvent
response.code_interpreter_call.in_progress	OpenAI.ResponseCodeInterpreterCallInProgressEvent
response.code_interpreter_call.interpreting	OpenAI.ResponseCodeInterpreterCallInterpretingEvent

Nama	Tipe	Deskripsi	Diperlukan	Default
sequence_number	bilangan bulat	Nomor urut untuk peristiwa ini.	Yes
jenis	OpenAI.ResponseStreamEventType		Yes

OpenAI.ResponseStreamEventType

Harta benda	Nilai
Jenis	string
Nilai	response.audio.delta response.audio.done response.audio_transcript.delta response.audio_transcript.done response.code_interpreter_call_code.delta response.code_interpreter_call_code.done response.code_interpreter_call.completed response.code_interpreter_call.in_progress response.code_interpreter_call.interpreting response.completed response.content_part.added response.content_part.done response.created error response.file_search_call.completed response.file_search_call.in_progress response.file_search_call.searching response.function_call_arguments.delta response.function_call_arguments.done response.in_progress response.failed response.incomplete response.output_item.added response.output_item.done response.refusal.delta response.refusal.done response.output_text.annotation.added response.output_text.delta response.output_text.done response.reasoning_summary_part.added response.reasoning_summary_part.done response.reasoning_summary_text.delta response.reasoning_summary_text.done response.web_search_call.completed response.web_search_call.in_progress response.web_search_call.searching response.image_generation_call.completed response.image_generation_call.generating response.image_generation_call.in_progress response.image_generation_call.partial_image response.mcp_call.arguments_delta response.mcp_call.arguments_done response.mcp_call.completed response.mcp_call.failed response.mcp_call.in_progress response.mcp_list_tools.completed response.mcp_list_tools.failed response.mcp_list_tools.in_progress response.queued response.reasoning.delta response.reasoning.done response.reasoning_summary.delta response.reasoning_summary.done

OpenAI.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

OpenAI.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

OpenAI.ResponseTextFormatConfiguration

Diskriminator untuk OpenAI.ResponseTextFormatConfiguration

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
text	OpenAI.ResponseTextFormatConfigurationText
json_object	OpenAI.ResponseTextFormatConfigurationJsonObject
json_schema	OpenAI.ResponseTextFormatConfigurationJsonSchema

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	OpenAI.ResponseTextFormatConfigurationType	Objek yang menentukan format yang harus dihasilkan model. Mengonfigurasi { "type": "json_schema" } memungkinkan Output Terstruktur, yang memastikan model akan 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.	Yes

OpenAI.ResponseTextFormatConfigurationJsonObject

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	enum	Nilai yang mungkin: json_object	Yes

OpenAI.ResponseTextFormatConfigurationJsonSchema

Format Skema JSON untuk respons. Digunakan untuk menghasilkan respons JSON 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.	Yes
skema	OpenAI.ResponseFormatJsonSchemaSchema	Skema untuk format respons, dijelaskan sebagai objek Skema JSON. Pelajari cara membuat skema JSON di sini.	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

OpenAI.ResponseTextFormatConfigurationText

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	enum	Nilai yang mungkin: text	Yes

OpenAI.ResponseTextFormatConfigurationType

Objek yang menentukan format yang harus dihasilkan model.

Mengonfigurasi { "type": "json_schema" } memungkinkan Output Terstruktur, yang memastikan model akan 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.

Harta benda	Nilai
Deskripsi	Objek yang menentukan format yang harus dihasilkan model.

Mengonfigurasi { "type": "json_schema" } memungkinkan Output Terstruktur, yang memastikan model akan 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_schemalebih disukai untuk model yang mendukungnya.

OpenAI.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
input_tokens_details	objek	Perincian terperinci dari token input.	Yes
└─ token_yang_di-cache	bilangan bulat	Jumlah token yang diambil dari cache.	Tidak.
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

OpenAI.ResponseWebSearchCallCompletedEvent

Catatan: web_search belum tersedia melalui Azure OpenAI.

Nama	Tipe	Deskripsi	Diperlukan	Default
item_id	string	ID unik untuk item output yang terkait dengan panggilan pencarian web.	Yes
output_index	bilangan bulat	Indeks item output yang dikaitkan dengan panggilan pencarian web.	Yes
jenis	enum	Jenis peristiwa. Selalu response.web_search_call.completed. Nilai yang mungkin: response.web_search_call.completed	Yes

OpenAI.ResponseWebSearchCallInProgressEvent

Catatan: web_search belum tersedia melalui Azure OpenAI.

Nama	Tipe	Deskripsi	Diperlukan	Default
item_id	string	ID unik untuk item output yang terkait dengan panggilan pencarian web.	Yes
output_index	bilangan bulat	Indeks item output yang dikaitkan dengan panggilan pencarian web.	Yes
jenis	enum	Jenis peristiwa. Selalu response.web_search_call.in_progress. Nilai yang mungkin: response.web_search_call.in_progress	Yes

OpenAI.ResponseWebSearchCallSearchingEvent

Catatan: web_search belum tersedia melalui Azure OpenAI.

Nama	Tipe	Deskripsi	Diperlukan	Default
item_id	string	ID unik untuk item output yang terkait dengan panggilan pencarian web.	Yes
output_index	bilangan bulat	Indeks item output yang dikaitkan dengan panggilan pencarian web.	Yes
jenis	enum	Jenis peristiwa. Selalu response.web_search_call.searching. Nilai yang mungkin: response.web_search_call.searching	Yes

OpenAI.ResponsesAssistantMessageItemParam

Item parameter pesan dengan peran assistant.

Nama	Tipe	Deskripsi	Diperlukan	Default
isi	array	Konten yang terkait dengan pesan.	Yes
peran	enum	Peran pesan yang selalu assistant. Nilai yang mungkin: assistant	Yes

OpenAI.ResponsesAssistantMessageItemResource

Item sumber daya pesan dengan peran assistant.

Nama	Tipe	Deskripsi	Diperlukan	Default
isi	array	Konten yang terkait dengan pesan.	Yes
peran	enum	Peran pesan yang selalu assistant. Nilai yang mungkin: assistant	Yes

OpenAI.ResponsesDeveloperMessageItemParam

Item parameter pesan dengan peran developer.

Nama	Tipe	Deskripsi	Diperlukan	Default
isi	array	Konten yang terkait dengan pesan.	Yes
peran	enum	Peran pesan yang selalu developer. Nilai yang mungkin: developer	Yes

OpenAI.ResponsesDeveloperMessageItemResource

Item sumber daya pesan dengan peran developer.

Nama	Tipe	Deskripsi	Diperlukan	Default
isi	array	Konten yang terkait dengan pesan.	Yes
peran	enum	Peran pesan yang selalu developer. Nilai yang mungkin: developer	Yes

OpenAI.ResponsesMessageItemParam

Item pesan respons, mewakili peran dan konten, sebagaimana disediakan sebagai parameter permintaan klien.

Diskriminator untuk OpenAI.ResponsesMessageItemParam

Komponen ini menggunakan properti role untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
user	OpenAI.ResponsesUserMessageItemParam
system	OpenAI.ResponsesSystemMessageItemParam
developer	OpenAI.ResponsesDeveloperMessageItemParam
assistant	OpenAI.ResponsesAssistantMessageItemParam

Nama	Tipe	Deskripsi	Diperlukan	Default
peran	objek	Kumpulan peran yang valid untuk item pesan respons.	Yes
jenis	enum	Jenis item respons, yang selalu 'pesan'. Nilai yang mungkin: message	Yes

OpenAI.ResponsesMessageItemResource

Item sumber daya pesan respons, mewakili peran dan konten, seperti yang disediakan pada respons layanan.

Diskriminator untuk OpenAI.ResponsesMessageItemResource

Komponen ini menggunakan properti role untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
user	OpenAI.ResponsesUserMessageItemResource
system	OpenAI.ResponsesSystemMessageItemResource
developer	OpenAI.ResponsesDeveloperMessageItemResource
assistant	OpenAI.ResponsesAssistantMessageItemResource

Nama	Tipe	Deskripsi	Diperlukan	Default
peran	objek	Kumpulan peran yang valid untuk item pesan respons.	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 item respons, yang selalu 'pesan'. Nilai yang mungkin: message	Yes

OpenAI.ResponsesMessageRole

Kumpulan peran yang valid untuk item pesan respons.

Harta benda	Nilai
Deskripsi	Kumpulan peran yang valid untuk item pesan respons.
Jenis	string
Nilai	system developer user assistant

OpenAI.ResponsesSystemMessageItemParam

Item parameter pesan dengan peran system.

Nama	Tipe	Deskripsi	Diperlukan	Default
isi	array	Konten yang terkait dengan pesan.	Yes
peran	enum	Peran pesan yang selalu system. Nilai yang mungkin: system	Yes

OpenAI.ResponsesSystemMessageItemResource

Item sumber daya pesan dengan peran system.

Nama	Tipe	Deskripsi	Diperlukan	Default
isi	array	Konten yang terkait dengan pesan.	Yes
peran	enum	Peran pesan yang selalu system. Nilai yang mungkin: system	Yes

OpenAI.ResponsesUserMessageItemParam

Item parameter pesan dengan peran user.

Nama	Tipe	Deskripsi	Diperlukan	Default
isi	array	Konten yang terkait dengan pesan.	Yes
peran	enum	Peran pesan yang selalu user. Nilai yang mungkin: user	Yes

OpenAI.ResponsesUserMessageItemResource

Item sumber daya pesan dengan peran user.

Nama	Tipe	Deskripsi	Diperlukan	Default
isi	array	Konten yang terkait dengan pesan.	Yes
peran	enum	Peran pesan yang selalu user. Nilai yang mungkin: user	Yes

OpenAI.RunGraderRequest

Nama	Tipe	Deskripsi	Diperlukan	Default
Grader	objek	Objek StringCheckGrader yang melakukan perbandingan string antara input dan referensi menggunakan operasi tertentu.	Yes
└─ calculate_output (menghitung_output)	string	Rumus untuk menghitung output berdasarkan hasil grader.	Tidak.
└─ metrik_penilaian	enum	Metrik evaluasi yang akan digunakan. Salah satu dari fuzzy_match, , bleugleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5, atau rouge_l. Nilai yang mungkin: fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5, rouge_l	Tidak.
└─ siswa kelas	objek		Tidak.
└─ tag gambar	string	Tag gambar yang digunakan untuk skrip python.	Tidak.
└─ masukan	array	Teks input. Ini mungkin termasuk string templat.	Tidak.
└─ model	string	Model yang digunakan untuk evaluasi.	Tidak.
└─ nama	string	Nama penilai.	Tidak.
└─ operasi	enum	Operasi pemeriksaan string yang perlu dilakukan. Salah satu dari eq, ne, like, atau ilike. Nilai yang mungkin: eq, ne, like, ilike	Tidak.
└─ rentang	array	Rentang skor. Secara default menjadi [0, 1].	Tidak.
└─ referensi	string	Teks yang sedang dinilai.	Tidak.
└─ parameter_pengambilan_sampel		Parameter pengambilan sampel untuk model.	Tidak.
└─ sumber	string	Kode sumber skrip python.	Tidak.
└─ jenis	enum	Tipe objek, yang selalu multi. Nilai yang mungkin: multi	Tidak.
item		Item himpunan data yang disediakan untuk grader. Ini akan digunakan untuk mengisi item namespace.	Tidak.
model_sample	string	Sampel model yang akan dievaluasi. Nilai ini akan digunakan untuk mengisi sample namespace. Variabel output_json akan diisi jika sampel model adalah string JSON yang valid.	Yes

OpenAI.RunGraderResponse

Nama	Tipe	Deskripsi	Diperlukan	Default
metadata	objek		Yes
└─ kesalahan	objek		Tidak.
kesalahan_pemrosesan_formula	Boolean		Tidak.
└─ kesalahan_variabel_tidak_valid	Boolean		Tidak.
└─ model_grader_parse_error (kesalahan parse model_grader)	Boolean		Tidak.
└─ kesalahan_penolakan_penilaian_model	Boolean		Tidak.
└─ Kesalahan server pada model_grader	Boolean		Tidak.
└─ perincian_kesalahan_server_penilai_model	string		Tidak.
└─ kesalahan_lain	Boolean		Tidak.
└─ Kesalahan Waktu Eksekusi Python Grader (python_grader_runtime_error)	Boolean		Tidak.
└─ detail_kesalahan_runtime_python_grader	string		Tidak.
└─ python_grader_server_error	Boolean		Tidak.
└─ tipe_kesalahan_server_python_grader	string		Tidak.
contoh_kesalahan_parse	Boolean		Tidak.
└─ kesalahan_observasi_terpotong	Boolean		Tidak.
└─ kesalahan_hadiah_tidak_responsif	Boolean		Tidak.
└─ waktu_eksekusi	nomor/angka		Tidak.
└─ nama	string		Tidak.
└─ nama_model_sampel	string		Tidak.
└─ skor			Tidak.
└─ penggunaan_token	bilangan bulat		Tidak.
└─ jenis	string		Tidak.
model_grader_token_usage_per_model			Yes
hadiah	nomor/angka		Yes
sub_rewards			Yes

OpenAI.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

OpenAI.StaticChunkingStrategyRequestParam

Sesuaikan strategi penggugusan Anda sendiri dengan mengatur ukuran gugus dan gugus tumpang tindih.

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

OpenAI.StaticChunkingStrategyResponseParam

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

OpenAI.StopConfiguration

Tidak didukung dengan model penalaran yang terbaru o3 dan o4-mini.

Hingga 4 urutan di mana API akan berhenti menghasilkan token lebih lanjut. Teks yang dikembalikan tidak akan berisi urutan berhenti.

Skema ini menerima salah satu jenis berikut:

• string
• array

OpenAI.Tool

Diskriminator untuk OpenAI.Tool

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
function	OpenAI.FunctionTool
file_search	OpenAI.FileSearchTool
computer_use_preview	OpenAI.ComputerUsePreviewTool
web_search_preview	OpenAI.WebSearchPreviewTool
code_interpreter	OpenAI.CodeInterpreterTool
image_generation	OpenAI.ImageGenTool
local_shell	OpenAI.LocalShellTool
mcp	OpenAI.MCPTool

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	OpenAI.ToolType	Alat yang dapat digunakan untuk menghasilkan respons.	Yes

OpenAI.ToolChoiceObject

Diskriminator untuk OpenAI.ToolChoiceObject

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
file_search	OpenAI.ToolChoiceObjectFileSearch
computer_use_preview	OpenAI.ToolChoiceObjectComputer
web_search_preview	OpenAI.ToolChoiceObjectWebSearch
image_generation	OpenAI.ToolChoiceObjectImageGen
code_interpreter	OpenAI.ToolChoiceObjectCodeInterpreter
function	OpenAI.ToolChoiceObjectFunction
mcp	OpenAI.ToolChoiceObjectMCP

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	OpenAI.ToolChoiceObjectType	Menunjukkan bahwa model harus menggunakan alat bawaan untuk menghasilkan respons.	Yes

OpenAI.ToolChoiceObjectCodeInterpreter

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	enum	Nilai yang mungkin: code_interpreter	Yes

OpenAI.ToolChoiceObjectComputer

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	enum	Nilai yang mungkin: computer_use_preview	Yes

OpenAI.ToolChoiceObjectFileSearch

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	enum	Nilai yang mungkin: file_search	Yes

OpenAI.ToolChoiceObjectFunction

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

OpenAI.ToolChoiceObjectImageGen

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	enum	Nilai yang mungkin: image_generation	Yes

OpenAI.ToolChoiceObjectMCP

Gunakan opsi ini untuk memaksa model memanggil alat tertentu di server MCP jarak jauh.

Nama	Tipe	Deskripsi	Diperlukan	Default
Nama	string	Nama alat yang akan dipanggil di server.	Tidak.
server_label	string	Label server MCP yang akan digunakan.	Yes
jenis	enum	Untuk alat MCP, jenisnya selalu mcp. Nilai yang mungkin: mcp	Yes

OpenAI.ToolChoiceObjectType

Menunjukkan bahwa model harus menggunakan alat bawaan untuk menghasilkan respons.

Harta benda	Nilai
Deskripsi	Menunjukkan bahwa model harus menggunakan alat bawaan untuk menghasilkan respons.
Jenis	string
Nilai	file_search function computer_use_preview web_search_preview image_generation code_interpreter mcp

OpenAI.ToolChoiceObjectWebSearch

Catatan: web_search belum tersedia melalui Azure OpenAI.

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	enum	Nilai yang mungkin: web_search_preview	Yes

OpenAI.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

OpenAI.ToolType

Alat yang dapat digunakan untuk menghasilkan respons.

Harta benda	Nilai
Deskripsi	Alat yang dapat digunakan untuk menghasilkan respons.
Jenis	string
Nilai	file_search function computer_use_preview web_search_preview mcp code_interpreter image_generation local_shell

OpenAI.TopLogProb

Probabilitas log atas token.

Nama	Tipe	Deskripsi	Diperlukan	Default
Byte	array		Yes
logprob	nomor/angka		Yes
token	string		Yes

OpenAI.TranscriptionAudioResponseFormat

Referensi: OpenAI.AudioResponseFormat

OpenAI.TranscriptionInclude

Harta benda	Nilai
Jenis	string
Nilai	logprobs

OpenAI.TranscriptionSegment

Nama	Tipe	Deskripsi	Diperlukan	Default
avg_logprob	nomor/angka	Log probabilitas rata-rata dari segmen. Jika nilai lebih rendah dari -1, anggap logprobs tidak berhasil.	Yes
compression_ratio	nomor/angka	Rasio kompresi segmen. Jika nilainya lebih besar dari 2,4, pertimbangkan kompresi gagal.	Yes
akhir	nomor/angka	Waktu akhir segmen dalam hitungan detik.	Yes
id	bilangan bulat	Pengidentifikasi unik dari segmen.	Yes
no_speech_prob	nomor/angka	Probabilitas ketiadaan ucapan pada segmen. Jika nilainya lebih tinggi dari 1,0 dan avg_logprob di bawah -1, pertimbangkan segmen ini senyap.	Yes
seek	bilangan bulat	Mencari offset dari segmen.	Yes
mulai	nomor/angka	Waktu mulai segmen dalam hitungan detik.	Yes
suhu	nomor/angka	Parameter suhu yang digunakan untuk menghasilkan segmen.	Yes
kirim pesan teks	string	Konten teks segmen.	Yes
tokens	array	Array ID token untuk konten teks.	Yes

OpenAI.TranscriptionWord

Nama	Tipe	Deskripsi	Diperlukan	Default
akhir	nomor/angka	Waktu akhir kata dalam hitungan detik.	Yes
mulai	nomor/angka	Waktu mulai kata dalam hitungan detik.	Yes
word	string	Konten teks kata.	Yes

OpenAI.TranslationAudioResponseFormat

Referensi: OpenAI.AudioResponseFormat

OpenAI.UpdateVectorStoreFileAttributesRequest

Nama	Tipe	Deskripsi	Diperlukan	Default
attributes	objek	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

OpenAI.UpdateVectorStoreRequest

Nama	Tipe	Deskripsi	Diperlukan	Default
kedaluwarsa_setelah	objek	Kebijakan kedaluwarsa untuk penyimpanan vektor.	Tidak.
└─ jangkar	enum	Tanda waktu jangkar setelah kebijakan kedaluwarsa berlaku. Jangkar yang didukung: last_active_at. Nilai yang mungkin: last_active_at	Tidak.
└─ hari	bilangan bulat	Jumlah hari setelah waktu jangkar penyimpanan vektor akan kedaluwarsa.	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, dan mengkueri objek melalui API atau dasbor. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter.	Tidak.
Nama	string	Nama toko vektor.	Tidak.

OpenAI.VadConfig

Nama	Tipe	Deskripsi	Diperlukan	Default
prefix_padding_ms	bilangan bulat	Jumlah audio yang akan disertakan sebelum ucapan yang terdeteksi oleh VAD (dalam milidetik).	Tidak.	300
silence_duration_ms	bilangan bulat	Durasi keheningan untuk mendeteksi pemberhentian ucapan (dalam milidetik). Dengan nilai yang lebih pendek, model akan merespons lebih cepat, tetapi mungkin melompat pada jeda singkat dari pengguna.	Tidak.	200
ambang	nomor/angka	Ambang sensitivitas (0,0 hingga 1,0) untuk deteksi aktivitas suara. 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.	0,5
jenis	enum	Harus diatur ke server_vad untuk mengaktifkan penggugusan manual menggunakan VAD sisi server. Nilai yang mungkin: server_vad	Yes

OpenAI.ValidateGraderRequest

Nama	Tipe	Deskripsi	Diperlukan	Default
Grader	objek	Objek StringCheckGrader yang melakukan perbandingan string antara input dan referensi menggunakan operasi tertentu.	Yes
└─ calculate_output (menghitung_output)	string	Rumus untuk menghitung output berdasarkan hasil grader.	Tidak.
└─ metrik_penilaian	enum	Metrik evaluasi yang akan digunakan. Salah satu dari fuzzy_match, , bleugleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5, atau rouge_l. Nilai yang mungkin: fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5, rouge_l	Tidak.
└─ siswa kelas	objek		Tidak.
└─ tag gambar	string	Tag gambar yang digunakan untuk skrip python.	Tidak.
└─ masukan	array	Teks input. Ini mungkin termasuk string templat.	Tidak.
└─ model	string	Model yang digunakan untuk evaluasi.	Tidak.
└─ nama	string	Nama penilai.	Tidak.
└─ operasi	enum	Operasi pemeriksaan string yang perlu dilakukan. Salah satu dari eq, ne, like, atau ilike. Nilai yang mungkin: eq, ne, like, ilike	Tidak.
└─ rentang	array	Rentang skor. Secara default menjadi [0, 1].	Tidak.
└─ referensi	string	Teks yang sedang dinilai.	Tidak.
└─ parameter_pengambilan_sampel		Parameter pengambilan sampel untuk model.	Tidak.
└─ sumber	string	Kode sumber skrip python.	Tidak.
└─ jenis	enum	Tipe objek, yang selalu multi. Nilai yang mungkin: multi	Tidak.

OpenAI.ValidateGraderResponse

Nama	Tipe	Deskripsi	Diperlukan	Default
Grader	objek	Objek StringCheckGrader yang melakukan perbandingan string antara input dan referensi menggunakan operasi tertentu.	Tidak.
└─ calculate_output (menghitung_output)	string	Rumus untuk menghitung output berdasarkan hasil grader.	Tidak.
└─ metrik_penilaian	enum	Metrik evaluasi yang akan digunakan. Salah satu dari fuzzy_match, , bleugleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5, atau rouge_l. Nilai yang mungkin: fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5, rouge_l	Tidak.
└─ siswa kelas	objek		Tidak.
└─ tag gambar	string	Tag gambar yang digunakan untuk skrip python.	Tidak.
└─ masukan	array	Teks input. Ini mungkin termasuk string templat.	Tidak.
└─ model	string	Model yang digunakan untuk evaluasi.	Tidak.
└─ nama	string	Nama penilai.	Tidak.
└─ operasi	enum	Operasi pemeriksaan string yang perlu dilakukan. Salah satu dari eq, ne, like, atau ilike. Nilai yang mungkin: eq, ne, like, ilike	Tidak.
└─ rentang	array	Rentang skor. Secara default menjadi [0, 1].	Tidak.
└─ referensi	string	Teks yang sedang dinilai.	Tidak.
└─ parameter_pengambilan_sampel		Parameter pengambilan sampel untuk model.	Tidak.
└─ sumber	string	Kode sumber skrip python.	Tidak.
└─ jenis	enum	Tipe objek, yang selalu multi. Nilai yang mungkin: multi	Tidak.

OpenAI.VectorStoreExpirationAfter

Kebijakan kedaluwarsa untuk penyimpanan vektor.

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

OpenAI.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.

Jenis: objek

OpenAI.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	enum	Tipe objek, yang selalu vector_store.file_batch. Nilai yang mungkin: vector_store.files_batch	Yes
status	enum	Status batch file penyimpanan vektor, yang dapat berupa in_progress, , completedcancelled atau failed. Nilai yang mungkin: in_progress, completed, cancelled, failed	Yes
vector_store_id	string	ID penyimpanan vektor tempat file dilampirkan.	Yes

OpenAI.VectorStoreFileObject

Daftar file yang dilampirkan ke penyimpanan vektor.

Nama	Tipe	Deskripsi	Diperlukan	Default
attributes	objek	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.
chunking_strategy	objek		Tidak.
└─ jenis	enum	Nilai yang mungkin: static, other	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	enum	Salah satu server_error atau rate_limit_exceeded. Nilai yang mungkin: server_error, unsupported_file, invalid_file	Tidak.
└─ pesan	string	Deskripsi kesalahan yang dapat dibaca manusia.	Tidak.
objek	enum	Tipe objek, yang selalu vector_store.file. Nilai yang mungkin: vector_store.file	Yes
status	enum	Status file penyimpanan vektor, yang dapat berupa in_progress, , completedcancelled, atau failed. Status completed menunjukkan bahwa file penyimpanan vektor siap digunakan. Nilai yang mungkin: in_progress, completed, cancelled, failed	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

OpenAI.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	OpenAI.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, dan mengkueri objek melalui API atau dasbor. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter.	Yes
Nama	string	Nama toko vektor.	Yes
objek	enum	Tipe objek, yang selalu vector_store. Nilai yang mungkin: vector_store	Yes
status	enum	Status penyimpanan vektor, yang dapat berupa expired, , in_progressatau completed. Status completed menunjukkan bahwa penyimpanan vektor siap digunakan. Nilai yang mungkin: expired, in_progress, completed	Yes
usage_bytes	bilangan bulat	Jumlah total byte yang digunakan oleh file di penyimpanan vektor.	Yes

OpenAI.VoiceIdsShared

Harta benda	Nilai
Jenis	string
Nilai	alloy ash ballad coral echo fable onyx nova sage shimmer verse

OpenAI.WebSearchAction

Diskriminator untuk OpenAI.WebSearchAction

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
find	OpenAI.WebSearchActionFind
open_page	OpenAI.WebSearchActionOpenPage
search	OpenAI.WebSearchActionSearch

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	OpenAI.WebSearchActionType		Yes

OpenAI.WebSearchActionFind

Jenis tindakan "temukan": Mencari pola dalam halaman yang dimuat.

Nama	Tipe	Deskripsi	Diperlukan	Default
pola	string	Pola atau teks yang akan dicari di dalam halaman.	Yes
jenis	enum	Jenis tindakan. Nilai yang mungkin: find	Yes
URL	string	URL halaman mencari pola.	Yes

OpenAI.WebSearchActionOpenPage

Jenis tindakan "open_page" - Membuka URL tertentu dari hasil pencarian.

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	enum	Jenis tindakan. Nilai yang mungkin: open_page	Yes
URL	string	URL yang dibuka oleh model.	Yes

OpenAI.WebSearchActionSearch

Jenis tindakan "pencarian" - Melakukan kueri pencarian web.

Nama	Tipe	Deskripsi	Diperlukan	Default
kueri	string	Kueri pencarian.	Yes
jenis	enum	Jenis tindakan. Nilai yang mungkin: search	Yes

OpenAI.WebSearchActionType

Harta benda	Nilai
Jenis	string
Nilai	search open_page find

OpenAI.WebSearchPreviewTool

Catatan: web_search belum tersedia melalui Azure OpenAI.

Nama	Tipe	Deskripsi	Diperlukan	Default
ukuran_konteks_pencarian	enum	Panduan tingkat tinggi untuk jumlah ruang jendela konteks yang akan digunakan untuk pencarian. Salah satu dari low, medium, atau high. medium adalah default. Nilai yang mungkin: low, medium, high	Tidak.
jenis	enum	Jenis alat pencarian web. Salah satu web_search_preview atau web_search_preview_2025_03_11. Nilai yang mungkin: web_search_preview	Yes
lokasi_pengguna	objek		Tidak.
└─ jenis	OpenAI.LocationType		Tidak.

OpenAI.WebSearchToolCallItemParam

Catatan: web_search belum tersedia melalui Azure OpenAI.

Nama	Tipe	Deskripsi	Diperlukan	Default
tindakan	objek		Yes
└─ jenis	OpenAI.WebSearchActionType		Tidak.
jenis	enum	Nilai yang mungkin: web_search_call	Yes

OpenAI.WebSearchToolCallItemResource

Catatan: web_search belum tersedia melalui Azure OpenAI.

Nama	Tipe	Deskripsi	Diperlukan	Default
tindakan	objek		Yes
└─ jenis	OpenAI.WebSearchActionType		Tidak.
status	enum	Status panggilan alat pencarian web. Nilai yang mungkin: in_progress, searching, completed, failed	Yes
jenis	enum	Nilai yang mungkin: web_search_call	Yes

PineconeChatDataSource

Nama	Tipe	Deskripsi	Diperlukan	Default
parameter	objek	Informasi parameter untuk mengontrol penggunaan sumber data Pinecone.	Yes
└─ izinkan_hasil_parsial	Boolean	Jika diatur ke true, sistem akan mengizinkan hasil pencarian parsial digunakan dan permintaan akan gagal jika semua kueri parsial gagal. Jika tidak ditentukan atau ditentukan sebagai false, permintaan akan gagal jika ada kueri pencarian yang gagal.	Tidak.	False
└─ autentikasi	objek		Tidak.
└─ kunci	string		Tidak.
└─ jenis	enum	Nilai yang mungkin: api_key	Tidak.
└─ ketergantungan_embedding	objek	Representasi sumber vektorisasi data yang dapat digunakan sebagai resource embedding pada sumber data.	Tidak.
└─ jenis	AzureChatDataSourceVectorizationSourceType	Pengidentifikasi unik untuk sumber vektorisasi spesifik.	Tidak.
└─ lingkungan	string	Nama lingkungan yang akan digunakan dengan Pinecone.	Tidak.
└─ pemetaan_bidang	objek	Pemetaan bidang untuk diterapkan ke data yang digunakan oleh sumber data Pinecone. Perhatikan bahwa pemetaan bidang konten diperlukan untuk Pinecone.	Tidak.
└─ kolom_konten	array		Tidak.
└─ pemisah_bidang_konten	string		Tidak.
└─ filepath_field	string		Tidak.
└─ bidang_judul	string		Tidak.
└─ url_field	string		Tidak.
└─ in_scope	Boolean	Apakah kueri harus dibatasi untuk menggunakan data terindeks.	Tidak.
└─ sertakan_konteks	array	Properti konteks output untuk disertakan pada respons. Secara default, kutipan dan niat akan diminta.	Tidak.	['kutipan', 'tujuan']
└─ nama_indeks	string	Nama indeks database Pinecone yang akan digunakan.	Tidak.
└─ kueri_pencarian_maksimum	bilangan bulat	Jumlah maksimum kueri yang ditulis ulang yang harus dikirim ke penyedia pencarian untuk satu pesan pengguna. Secara default, sistem akan membuat penentuan otomatis.	Tidak.
└─ keketatan	bilangan bulat	Ketatnya pemfilteran relevansi pencarian yang dikonfigurasi. Ketegasan yang lebih tinggi akan meningkatkan presisi tetapi pengenalan jawaban yang lebih rendah.	Tidak.
└─ top_n_documents	bilangan bulat	Jumlah dokumen yang dikonfigurasi untuk ditampilkan dalam kueri.	Tidak.
jenis	enum	Pengidentifikasi jenis yang didiskriminasi, yang selalu 'pinecone'. Nilai yang mungkin: pinecone	Yes

Kualitas

Kualitas konten video yang akan diambil. Ini menentukan kualitas konten video yang harus dikembalikan.

Harta benda	Nilai
Deskripsi	Kualitas konten video yang akan diambil. Ini menentukan kualitas konten video yang harus dikembalikan.
Jenis	string
Nilai	high low

ResponseFormatJSONSchemaRequest

Nama	Tipe	Deskripsi	Diperlukan	Default
json_schema	objek	Skema JSON untuk format respons	Yes
jenis	enum	Jenis format respons Nilai yang mungkin: json_schema	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"]

Array dari: string

SpeechGenerationResponseFormat

Format output audio yang didukung untuk teks ke ucapan.

Komponen ini bisa menjadi salah satu hal berikut:

VideoGeneration

Hasil pembuatan video.

Nama	Tipe	Deskripsi	Diperlukan	Default
dibuat_pada	bilangan bulat	Waktu ketika pembuatan video dibuat.	Yes
height	bilangan bulat	Tinggi video.	Yes
id	string	Id pembuatan video.	Yes
job_id	string	ID pekerjaan pembuatan video untuk video ini.	Yes
n_seconds	bilangan bulat	Durasi pembuatan video.	Yes
objek	enum	Nilai yang mungkin: video.generation	Yes
minta	string	Petunjuk pembuatan video ini.	Yes
width	bilangan bulat	Lebar dari video.	Yes

VideoGenerationJob

Pekerjaan pembuatan video.

Nama	Tipe	Deskripsi	Diperlukan	Default
dibuat_pada	bilangan bulat	Waktu ketika tugas diciptakan.	Yes
kedaluwarsa_pada	bilangan bulat	Waktu ketika pekerjaan dihapus secara otomatis dari layanan. Konten video dan metadata pekerjaan harus disimpan sebelum tanggal ini untuk menghindari kehilangan data.	Tidak.
failure_reason	string (lihat model yang valid di bawah)		Tidak.
selesai_pada	bilangan bulat	Waktu ketika pekerjaan selesai dengan semua pembuatan video.	Tidak.
Generasi	array	Video-video yang dihasilkan untuk tugas ini. Jumlahnya tergantung pada n_variants yang diberikan dan keberhasilan dalam menghasilkan generasi.	Tidak.
height	bilangan bulat	Tinggi video.	Yes
id	string	Id pekerjaan.	Yes
inpaint_items	array	Item inpainting opsional untuk pekerjaan pembuatan video ini.	Tidak.
model	string	Nama penyebaran yang akan digunakan untuk tugas pembuatan video ini.	Yes
n_seconds	bilangan bulat	Durasi pekerjaan pembuatan video.	Yes
n_variants	bilangan bulat	Jumlah video yang akan dibuat sebagai varian untuk pekerjaan pembuatan video ini.	Yes
objek	enum	Nilai yang mungkin: video.generation.job	Yes
minta	string	Arahan untuk pekerjaan pembuatan video ini.	Yes
status	objek	Status pekerjaan pembuatan video.	Yes
width	bilangan bulat	Tinggi video.	Yes

VideoGenerationJobList

Daftar pekerjaan pembuatan video.

Nama	Tipe	Deskripsi	Diperlukan	Default
data	array	Daftar pekerjaan pembuatan video.	Yes
first_id	string	ID pekerjaan pertama di halaman saat ini, jika tersedia.	Tidak.
ada_lagi	Boolean	Bendera yang menunjukkan apakah ada lebih banyak pekerjaan yang tersedia setelah daftar.	Yes
ID terakhir	string	ID pekerjaan terakhir di halaman saat ini, jika tersedia.	Tidak.
objek	enum	Nilai yang mungkin: list	Yes

Langkah selanjutnya

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