Microsoft Foundry

Versi API: v1

Authentication

Alur: implisit

URL Otorisasi:https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Cakupan:

https://ai.azure.com/.default

Agents

Agen - buat agen

POST {endpoint}/agents?api-version=v1

Membuat agen.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
Foundry-Features	False	string Nilai yang mungkin: `ContainerAgents=V1Preview`, `HostedAgents=V1Preview`, `WorkflowAgents=V1Preview`	Keikutsertaan bendera fitur diperlukan saat menggunakan operasi pratinjau atau memodifikasi sumber daya pratinjau yang bertahan.

Isi Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan
definisi	AgentDefinition		Yes
└─ jenis	AgentKind		Yes
└─ rai_config	RaiConfig	Konfigurasi untuk fitur pemfilteran konten dan keamanan AI yang Bertanggung Jawab (RAI).	Tidak.
deskripsi	string	Deskripsi agen yang dapat dibaca manusia. Batasan: maxLength: 512	Tidak.
metadata	objek	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini bisa berguna untuk menyimpan informasi tambahan tentang objek dalam terstruktur pemformatan dan pengambilan kueri untuk 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 unik yang mengidentifikasi agen. Nama dapat digunakan untuk mengambil/memperbarui/menghapus agen. - Harus dimulai dan diakhir dengan karakter alfanumerik, - Dapat berisi tanda hubung di tengah - Tidak boleh melebihi 63 karakter. Batasan: maxLength: 63	Yes

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	AgentObject

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Agen - daftar agen

GET {endpoint}/agents?api-version=v1

Mengembalikan daftar semua agen.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
jenis	kueri	Tidak.	string Nilai yang mungkin: `prompt`, `hosted`, `container_app`, `workflow`	Filter agen berdasarkan jenisnya. Jika tidak disediakan, semua agen dikembalikan.
limit	kueri	Tidak.	bilangan bulat	Batas jumlah objek yang akan dikembalikan. Batas dapat berkisar antara 1 dan 100, dan defaultnya adalah 20.
order	kueri	Tidak.	string Nilai yang mungkin: `asc`, `desc`	Urutkan urutan menurut `created_at` tanda waktu objek. `asc` untuk urutan naik dan`desc` untuk urutan turun.
after	kueri	Tidak.	string	Kursor untuk digunakan dalam penomoran halaman. `after` adalah ID objek yang menentukan tempat Anda dalam daftar. Misalnya, jika Anda membuat permintaan daftar dan menerima 100 objek, objek terakhir adalah obj_foo, Panggilan berikutnya dapat mencakup after=obj_foo untuk mendapatkan halaman berikutnya dari daftar.
sebelum	kueri	Tidak.	string	Kursor untuk digunakan dalam penomoran halaman. `before` adalah ID objek yang menentukan tempat Anda dalam daftar. Misalnya, jika Anda membuat permintaan daftar dan menerima 100 objek, objek terakhir adalah obj_foo, Panggilan berikutnya dapat mencakup before=obj_foo untuk menampilkan halaman sebelumnya dari daftar item.
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	objek	Data respons untuk daftar item yang diminta.

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Agen - dapatkan agen

GET {endpoint}/agents/{agent_name}?api-version=v1

Mengambil agen.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
agent_name	path	Yes	string	Nama agen yang akan diambil.
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	AgentObject

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Agen - agen pembaruan

POST {endpoint}/agents/{agent_name}?api-version=v1

Memperbarui agen dengan menambahkan versi baru jika ada perubahan pada definisi agen. Jika tidak ada perubahan, mengembalikan versi agen yang ada.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
agent_name	path	Yes	string	Nama agen yang akan diambil.
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
Foundry-Features	False	string Nilai yang mungkin: `ContainerAgents=V1Preview`, `HostedAgents=V1Preview`, `WorkflowAgents=V1Preview`	Keikutsertaan bendera fitur diperlukan saat menggunakan operasi pratinjau atau memodifikasi sumber daya pratinjau yang bertahan.

Isi Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan
definisi	AgentDefinition		Yes
└─ jenis	AgentKind		Yes
└─ rai_config	RaiConfig	Konfigurasi untuk fitur pemfilteran konten dan keamanan AI yang Bertanggung Jawab (RAI).	Tidak.
deskripsi	string	Deskripsi agen yang dapat dibaca manusia. Batasan: maxLength: 512	Tidak.
metadata	objek	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini bisa berguna untuk menyimpan informasi tambahan tentang objek dalam terstruktur pemformatan dan pengambilan kueri untuk objek melalui API atau dasbor. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter.	Tidak.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	AgentObject

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Agen - hapus agen

DELETE {endpoint}/agents/{agent_name}?api-version=v1

Menghapus agen.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
agent_name	path	Yes	string	Nama agen yang akan dihapus.
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	DeleteAgentResponse

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Agen - memperbarui agen dari manifes

POST {endpoint}/agents/{agent_name}/import?api-version=v1

Memperbarui agen dari manifes dengan menambahkan versi baru jika ada perubahan pada definisi agen. Jika tidak ada perubahan, mengembalikan versi agen yang ada.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
agent_name	path	Yes	string	Nama agen yang akan diperbarui.
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.

Isi Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan
deskripsi	string	Deskripsi agen yang dapat dibaca manusia. Batasan: maxLength: 512	Tidak.
manifest_id	string	ID manifes untuk mengimpor versi agen.	Yes
metadata	objek	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini bisa berguna untuk menyimpan informasi tambahan tentang objek dalam terstruktur pemformatan dan pengambilan kueri untuk objek melalui API atau dasbor. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter.	Tidak.
parameter_values	objek	Input ke manifes yang akan menghasilkan Agen yang sepenuhnya terwujud.	Yes

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	AgentObject

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Agen - membuat versi agen

POST {endpoint}/agents/{agent_name}/versions?api-version=v1

Buat versi agen baru.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
agent_name	path	Yes	string	Nama unik yang mengidentifikasi agen. Nama dapat digunakan untuk mengambil/memperbarui/menghapus agen. - Harus dimulai dan diakhir dengan karakter alfanumerik, - Dapat berisi tanda hubung di tengah - Tidak boleh melebihi 63 karakter.
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
Foundry-Features	False	string Nilai yang mungkin: `ContainerAgents=V1Preview`, `HostedAgents=V1Preview`, `WorkflowAgents=V1Preview`	Keikutsertaan bendera fitur diperlukan saat menggunakan operasi pratinjau atau memodifikasi sumber daya pratinjau yang bertahan.

Isi Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan
definisi	AgentDefinition		Yes
└─ jenis	AgentKind		Yes
└─ rai_config	RaiConfig	Konfigurasi untuk fitur pemfilteran konten dan keamanan AI yang Bertanggung Jawab (RAI).	Tidak.
deskripsi	string	Deskripsi agen yang dapat dibaca manusia. Batasan: maxLength: 512	Tidak.
metadata	objek	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini bisa berguna untuk menyimpan informasi tambahan tentang objek dalam terstruktur pemformatan dan pengambilan kueri untuk objek melalui API atau dasbor. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter.	Tidak.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	AgentVersionObject

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Agen - mencantumkan versi agen

GET {endpoint}/agents/{agent_name}/versions?api-version=v1

Mengembalikan daftar versi agen.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
agent_name	path	Yes	string	Nama agen untuk mengambil versi.
limit	kueri	Tidak.	bilangan bulat	Batas jumlah objek yang akan dikembalikan. Batas dapat berkisar antara 1 dan 100, dan defaultnya adalah 20.
order	kueri	Tidak.	string Nilai yang mungkin: `asc`, `desc`	Urutkan urutan menurut `created_at` tanda waktu objek. `asc` untuk urutan naik dan`desc` untuk urutan turun.
after	kueri	Tidak.	string	Kursor untuk digunakan dalam penomoran halaman. `after` adalah ID objek yang menentukan tempat Anda dalam daftar. Misalnya, jika Anda membuat permintaan daftar dan menerima 100 objek, objek terakhir adalah obj_foo, Panggilan berikutnya dapat mencakup after=obj_foo untuk mendapatkan halaman berikutnya dari daftar.
sebelum	kueri	Tidak.	string	Kursor untuk digunakan dalam penomoran halaman. `before` adalah ID objek yang menentukan tempat Anda dalam daftar. Misalnya, jika Anda membuat permintaan daftar dan menerima 100 objek, objek terakhir adalah obj_foo, Panggilan berikutnya dapat mencakup before=obj_foo untuk menampilkan halaman sebelumnya dari daftar item.
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	objek	Data respons untuk daftar item yang diminta.

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Agen - dapatkan versi agen

GET {endpoint}/agents/{agent_name}/versions/{agent_version}?api-version=v1

Mengambil versi agen tertentu.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
agent_name	path	Yes	string	Nama agen yang akan diambil.
agent_version	path	Yes	string	Versi agen yang akan diambil.
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	AgentVersionObject

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Agen - hapus versi agen

DELETE {endpoint}/agents/{agent_name}/versions/{agent_version}?api-version=v1

Menghapus versi agen tertentu.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
agent_name	path	Yes	string	Nama agen yang akan dihapus.
agent_version	path	Yes	string	Versi agen yang akan dihapus
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	DeleteAgentVersionResponse

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Agen - membuat versi agen dari manifes

POST {endpoint}/agents/{agent_name}/versions:import?api-version=v1

Buat versi agen baru dari manifes.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
agent_name	path	Yes	string	Nama unik yang mengidentifikasi agen. Nama dapat digunakan untuk mengambil/memperbarui/menghapus agen. - Harus dimulai dan diakhir dengan karakter alfanumerik, - Dapat berisi tanda hubung di tengah - Tidak boleh melebihi 63 karakter.
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.

Isi Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan
deskripsi	string	Deskripsi agen yang dapat dibaca manusia. Batasan: maxLength: 512	Tidak.
manifest_id	string	ID manifes untuk mengimpor versi agen.	Yes
metadata	objek	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini bisa berguna untuk menyimpan informasi tambahan tentang objek dalam terstruktur pemformatan dan pengambilan kueri untuk objek melalui API atau dasbor. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter.	Tidak.
parameter_values	objek	Input ke manifes yang akan menghasilkan Agen yang sepenuhnya terwujud.	Yes

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	AgentVersionObject

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Agen - membuat agen dari manifes

POST {endpoint}/agents:import?api-version=v1

Membuat agen dari manifes.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.

Isi Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan
deskripsi	string	Deskripsi agen yang dapat dibaca manusia. Batasan: maxLength: 512	Tidak.
manifest_id	string	ID manifes untuk mengimpor versi agen.	Yes
metadata	objek	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini bisa berguna untuk menyimpan informasi tambahan tentang objek dalam terstruktur pemformatan dan pengambilan kueri untuk 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 unik yang mengidentifikasi agen. Nama dapat digunakan untuk mengambil/memperbarui/menghapus agen. - Harus dimulai dan diakhir dengan karakter alfanumerik, - Dapat berisi tanda hubung di tengah - Tidak boleh melebihi 63 karakter. Batasan: maxLength: 63	Yes
parameter_values	objek	Input ke manifes yang akan menghasilkan Agen yang sepenuhnya terwujud.	Yes

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	AgentObject

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Kontainer Agen

Kontainer agen - mencantumkan operasi kontainer agen

GET {endpoint}/agents/{agent_name}/operations?api-version=v1

Mencantumkan operasi kontainer untuk agen.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
agent_name	path	Yes	string	Nama agen.
limit	kueri	Tidak.	bilangan bulat	Batas jumlah objek yang akan dikembalikan. Batas dapat berkisar antara 1 dan 100, dan defaultnya adalah 20.
order	kueri	Tidak.	string Nilai yang mungkin: `asc`, `desc`	Urutkan urutan menurut `created_at` tanda waktu objek. `asc` untuk urutan naik dan`desc` untuk urutan turun.
after	kueri	Tidak.	string	Kursor untuk digunakan dalam penomoran halaman. `after` adalah ID objek yang menentukan tempat Anda dalam daftar. Misalnya, jika Anda membuat permintaan daftar dan menerima 100 objek, objek terakhir adalah obj_foo, Panggilan berikutnya dapat mencakup after=obj_foo untuk mendapatkan halaman berikutnya dari daftar.
sebelum	kueri	Tidak.	string	Kursor untuk digunakan dalam penomoran halaman. `before` adalah ID objek yang menentukan tempat Anda dalam daftar. Misalnya, jika Anda membuat permintaan daftar dan menerima 100 objek, objek terakhir adalah obj_foo, Panggilan berikutnya dapat mencakup before=obj_foo untuk menampilkan halaman sebelumnya dari daftar item.
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
Foundry-Features	False	string Nilai yang mungkin: `ContainerAgents=V1Preview`	Keikutsertaan bendera fitur diperlukan saat menggunakan operasi pratinjau atau memodifikasi sumber daya pratinjau yang bertahan.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	objek	Data respons untuk daftar item yang diminta.

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Kontainer agen - dapatkan operasi kontainer agen

GET {endpoint}/agents/{agent_name}/operations/{operation_id}?api-version=v1

Dapatkan status operasi kontainer untuk agen.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
agent_name	path	Yes	string	Nama agen.
operation_id	path	Yes	string	ID operasi.
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
Foundry-Features	False	string Nilai yang mungkin: `ContainerAgents=V1Preview`	Keikutsertaan bendera fitur diperlukan saat menggunakan operasi pratinjau atau memodifikasi sumber daya pratinjau yang bertahan.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	AgentContainerOperationObject

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Kontainer agen - dapatkan kontainer agen

GET {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default?api-version=v1

Dapatkan kontainer untuk versi agen tertentu.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
agent_name	path	Yes	string	Nama agen.
agent_version	path	Yes	string	Versi agen.
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
Foundry-Features	False	string Nilai yang mungkin: `ContainerAgents=V1Preview`	Keikutsertaan bendera fitur diperlukan saat menggunakan operasi pratinjau atau memodifikasi sumber daya pratinjau yang bertahan.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	AgentContainerObject

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Kontainer agen - mencantumkan operasi kontainer versi agen

GET {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default/operations?api-version=v1

Mencantumkan operasi kontainer untuk versi agen tertentu.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
agent_name	path	Yes	string	Nama agen.
agent_version	path	Yes	string	Versi agen.
limit	kueri	Tidak.	bilangan bulat	Batas jumlah objek yang akan dikembalikan. Batas dapat berkisar antara 1 dan 100, dan defaultnya adalah 20.
order	kueri	Tidak.	string Nilai yang mungkin: `asc`, `desc`	Urutkan urutan menurut `created_at` tanda waktu objek. `asc` untuk urutan naik dan`desc` untuk urutan turun.
after	kueri	Tidak.	string	Kursor untuk digunakan dalam penomoran halaman. `after` adalah ID objek yang menentukan tempat Anda dalam daftar. Misalnya, jika Anda membuat permintaan daftar dan menerima 100 objek, objek terakhir adalah obj_foo, Panggilan berikutnya dapat mencakup after=obj_foo untuk mendapatkan halaman berikutnya dari daftar.
sebelum	kueri	Tidak.	string	Kursor untuk digunakan dalam penomoran halaman. `before` adalah ID objek yang menentukan tempat Anda dalam daftar. Misalnya, jika Anda membuat permintaan daftar dan menerima 100 objek, objek terakhir adalah obj_foo, Panggilan berikutnya dapat mencakup before=obj_foo untuk menampilkan halaman sebelumnya dari daftar item.
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
Foundry-Features	False	string Nilai yang mungkin: `ContainerAgents=V1Preview`	Keikutsertaan bendera fitur diperlukan saat menggunakan operasi pratinjau atau memodifikasi sumber daya pratinjau yang bertahan.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	objek	Data respons untuk daftar item yang diminta.

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Kontainer agen - hapus kontainer agen

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:delete?api-version=v1

Menghapus kontainer untuk versi agen tertentu. Jika kontainer tidak ada, operasi akan no-op. Operasi ini adalah operasi jangka panjang. Mengikuti pedoman desain untuk operasi yang berjalan lama di Azure REST API. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
agent_name	path	Yes	string	Nama agen.
agent_version	path	Yes	string	Versi agen.
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
Foundry-Features	False	string Nilai yang mungkin: `ContainerAgents=V1Preview`	Keikutsertaan bendera fitur diperlukan saat menggunakan operasi pratinjau atau memodifikasi sumber daya pratinjau yang bertahan.

Responses

Kode Status: 202

Deskripsi: Permintaan telah diterima untuk diproses, tetapi pemrosesan belum selesai.

Content-Type	Jenis	Deskripsi
application/json	AgentContainerOperationObject

Header Respons:

Header	Tipe	Deskripsi
Operasi-Lokasi	string

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Kontainer agen - log kontainer agen aliran

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:logstream?api-version=v1

Entri log kontainer dialirkan dari kontainer sebagai potongan teks. Setiap potongan adalah string UTF-8 yang mungkin berupa baris log teks biasa atau entri log berformat JSON, tergantung pada jenis log kontainer yang dialirkan. Klien harus memperlakukan setiap potongan sebagai teks buram dan, jika perlu, mencoba menguraikannya sebagai JSON berdasarkan persyaratan pengelogan mereka.

Untuk log sistem, formatnya adalah JSON dengan struktur berikut: {"TimeStamp":"2025-12-15T16:51:33Z","Type":"Normal","ContainerAppName":null,"RevisionName":null,"ReplicaName":null,"Msg":"Menghubungkan ke kolektor peristiwa...","Reason":"StartingGettingEvents","EventSource":"ContainerAppController","Count":1} {"TimeStamp":"2025-12-15T16:51:34Z","Type":"Normal","ContainerAppName":null,"RevisionName":null,"ReplicaName":null,"Msg":"Berhasil terhubung ke peristiwa server","Alasan":"ConnectedToEventsServer","EventSource":"ContainerAppController","Count":1}

Untuk log konsol, formatnya adalah teks biasa seperti yang dipancarkan oleh stdout/stderr kontainer. 2025-12-15T08:43:48.72656 Menghubungkan ke kontainer 'kontainer agen'... 2025-12-15T08:43:48.75451 Berhasil Terhubung ke kontainer: 'agen-kontainer' [Revisi: 'je90fe655aa742ef9a188b9fd14d6764--7tca06b', replika: 'je90fe655aa742ef9a188b9fd14d6764--7tca06b-6898b9c89f-mpkjc'] 2025-12-15T08:33:59.0671054Z stdout F INFO: 127.0.0.1:42588 - "GET /readiness HTTP/1.1" 200 OK 2025-12-15T08:34:29.0649033Z stdout F INFO: 127.0.0.1:60246 - "GET /readiness HTTP/1.1" 200 OK 2025-12-15T08:34:59.0644467Z stdout F INFO: 127.0.0.1:43994 - "GET /readiness HTTP/1.1" 200 OK

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
agent_name	path	Yes	string	Nama agen.
agent_version	path	Yes	string	Versi agen.
jenis	kueri	Tidak.	string Nilai yang mungkin: `console`, `system`	Konsol mengembalikan kontainer stdout/stderr, sistem mengembalikan aliran peristiwa aplikasi kontainer. default ke konsol
replica_name	kueri	Tidak.	string	Saat diabaikan, server memilih replika pertama untuk log konsol. Diperlukan untuk menargetkan replika tertentu.
ekor	kueri	Tidak.	bilangan bulat	Jumlah baris berikutnya yang dikembalikan. Diberlakukan menjadi 1-300. Default ke 20
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
Foundry-Features	False	string Nilai yang mungkin: `ContainerAgents=V1Preview`	Keikutsertaan bendera fitur diperlukan saat menggunakan operasi pratinjau atau memodifikasi sumber daya pratinjau yang bertahan.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Kontainer agen - mulai kontainer agen

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:start?api-version=v1

Mulai kontainer untuk versi agen tertentu. Jika kontainer sudah berjalan, operasi akan no-op. Operasi ini adalah operasi jangka panjang. Mengikuti pedoman desain untuk operasi yang berjalan lama di Azure REST API. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
agent_name	path	Yes	string	Nama agen.
agent_version	path	Yes	string	Versi agen.
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
Foundry-Features	False	string Nilai yang mungkin: `ContainerAgents=V1Preview`	Keikutsertaan bendera fitur diperlukan saat menggunakan operasi pratinjau atau memodifikasi sumber daya pratinjau yang bertahan.

Isi Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan	Default
max_replicas	bilangan bulat	Jumlah maksimum replika. Default ke 1.	Tidak.	1
min_replicas	bilangan bulat	Jumlah minimum replika. Default ke 1.	Tidak.	1

Responses

Kode Status: 202

Deskripsi: Permintaan telah diterima untuk diproses, tetapi pemrosesan belum selesai.

Content-Type	Jenis	Deskripsi
application/json	AgentContainerOperationObject

Header Respons:

Header	Tipe	Deskripsi
Operasi-Lokasi	string

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Kontainer agen - hentikan kontainer agen

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:stop?api-version=v1

Hentikan kontainer untuk versi agen tertentu. Jika kontainer tidak berjalan, atau sudah berhenti, operasi akan no-op. Operasi ini adalah operasi jangka panjang. Mengikuti pedoman desain untuk operasi yang berjalan lama di Azure REST API. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
agent_name	path	Yes	string	Nama agen.
agent_version	path	Yes	string	Versi agen.
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
Foundry-Features	False	string Nilai yang mungkin: `ContainerAgents=V1Preview`	Keikutsertaan bendera fitur diperlukan saat menggunakan operasi pratinjau atau memodifikasi sumber daya pratinjau yang bertahan.

Responses

Kode Status: 202

Deskripsi: Permintaan telah diterima untuk diproses, tetapi pemrosesan belum selesai.

Content-Type	Jenis	Deskripsi
application/json	AgentContainerOperationObject

Header Respons:

Header	Tipe	Deskripsi
Operasi-Lokasi	string

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Kontainer agen - memperbarui kontainer agen

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:update?api-version=v1

Perbarui kontainer untuk versi agen tertentu. Jika kontainer tidak berjalan, operasi akan no-op. Operasi ini adalah operasi jangka panjang. Mengikuti pedoman desain untuk operasi yang berjalan lama di Azure REST API. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
agent_name	path	Yes	string	Nama agen.
agent_version	path	Yes	string	Versi agen.
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
Foundry-Features	False	string Nilai yang mungkin: `ContainerAgents=V1Preview`	Keikutsertaan bendera fitur diperlukan saat menggunakan operasi pratinjau atau memodifikasi sumber daya pratinjau yang bertahan.

Isi Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan	Default
max_replicas	bilangan bulat	Jumlah maksimum replika.	Tidak.
min_replicas	bilangan bulat	Jumlah minimum replika.	Tidak.

Responses

Kode Status: 202

Deskripsi: Permintaan telah diterima untuk diproses, tetapi pemrosesan belum selesai.

Content-Type	Jenis	Deskripsi
application/json	AgentContainerOperationObject

Header Respons:

Header	Tipe	Deskripsi
Operasi-Lokasi	string

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Connections

Koneksi - daftar

GET {endpoint}/connections?api-version=v1

Cantumkan semua koneksi di project, tanpa mengisi kredensial koneksi

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.
tipe koneksi	kueri	Tidak.	string Nilai yang mungkin: `AzureOpenAI`, `AzureBlob`, `AzureStorageAccount`, `CognitiveSearch`, `CosmosDB`, `ApiKey`, `AppConfig`, `AppInsights`, `CustomKeys`, `RemoteTool_Preview`	Daftar koneksi jenis khusus ini
defaultConnection	kueri	Tidak.	Boolean	Daftar koneksi yang merupakan koneksi default

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
x-ms-client-request-id	False	string	Pengidentifikasi string yang buram dan unik secara global yang dihasilkan klien untuk permintaan tersebut.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	PagedConnection

Header Respons:

Header	Tipe	Deskripsi
x-ms-client-request-id		Pengidentifikasi string yang buram dan unik secara global yang dihasilkan klien untuk permintaan tersebut.

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	Azure. Core.Foundations.ErrorResponse

Header Respons:

Header	Tipe	Deskripsi
x-ms-error-code	string	Kode kesalahan string yang menunjukkan apa yang salah.

Koneksi - dapatkan

GET {endpoint}/connections/{name}?api-version=v1

Dapatkan koneksi berdasarkan nama, tanpa mengisi kredensial koneksi

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.
Nama	path	Yes	string	Nama koneksi yang ramah, disediakan oleh pengguna.

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
x-ms-client-request-id	False	string	Pengidentifikasi string yang buram dan unik secara global yang dihasilkan klien untuk permintaan tersebut.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	Koneksi

Header Respons:

Header	Tipe	Deskripsi
x-ms-client-request-id		Pengidentifikasi string yang buram dan unik secara global yang dihasilkan klien untuk permintaan tersebut.

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	Azure. Core.Foundations.ErrorResponse

Header Respons:

Header	Tipe	Deskripsi
x-ms-error-code	string	Kode kesalahan string yang menunjukkan apa yang salah.

Koneksi - dapatkan dengan kredensial

POST {endpoint}/connections/{name}/getConnectionWithCredentials?api-version=v1

Dapatkan koneksi berdasarkan nama, dengan kredensial koneksinya

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.
Nama	path	Yes	string	Nama koneksi yang ramah, disediakan oleh pengguna.

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
x-ms-client-request-id	False	string	Pengidentifikasi string yang buram dan unik secara global yang dihasilkan klien untuk permintaan tersebut.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	Koneksi

Header Respons:

Header	Tipe	Deskripsi
x-ms-client-request-id		Pengidentifikasi string yang buram dan unik secara global yang dihasilkan klien untuk permintaan tersebut.

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	Azure. Core.Foundations.ErrorResponse

Header Respons:

Header	Tipe	Deskripsi
x-ms-error-code	string	Kode kesalahan string yang menunjukkan apa yang salah.

Kumpulan Data

Himpunan data - daftar terbaru

GET {endpoint}/datasets?api-version=v1

Cantumkan versi terbaru dari setiap DatasetVersion

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	PagedDatasetVersion

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	Azure. Core.Foundations.ErrorResponse

Header Respons:

Header	Tipe	Deskripsi
x-ms-error-code	string	Kode kesalahan string yang menunjukkan apa yang salah.

Himpunan data - versi daftar

GET {endpoint}/datasets/{name}/versions?api-version=v1

Cantumkan semua versi DatasetVersion yang diberikan

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.
Nama	path	Yes	string	Nama sumber daya

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	PagedDatasetVersion

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	Azure. Core.Foundations.ErrorResponse

Header Respons:

Header	Tipe	Deskripsi
x-ms-error-code	string	Kode kesalahan string yang menunjukkan apa yang salah.

Himpunan data - dapatkan versi

GET {endpoint}/datasets/{name}/versions/{version}?api-version=v1

Dapatkan versi spesifik dari DatasetVersion. Layanan mengembalikan kesalahan 404 Tidak Ditemukan jika DatasetVersion tidak ada.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.
Nama	path	Yes	string	Nama sumber daya
versi	path	Yes	string	ID versi spesifik dari DatasetVersion untuk diambil.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	DatasetVersion

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	Azure. Core.Foundations.ErrorResponse

Header Respons:

Header	Tipe	Deskripsi
x-ms-error-code	string	Kode kesalahan string yang menunjukkan apa yang salah.

Himpunan data - hapus versi

DELETE {endpoint}/datasets/{name}/versions/{version}?api-version=v1

Hapus versi tertentu dari DatasetVersion. Layanan mengembalikan 204 Tidak Ada Konten jika DatasetVersion berhasil dihapus atau jika DatasetVersion tidak ada.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.
Nama	path	Yes	string	Nama sumber daya
versi	path	Yes	string	Versi DatasetVersion yang akan dihapus.

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	Azure. Core.Foundations.ErrorResponse

Header Respons:

Header	Tipe	Deskripsi
x-ms-error-code	string	Kode kesalahan string yang menunjukkan apa yang salah.

Himpunan data - membuat atau memperbarui versi

PATCH {endpoint}/datasets/{name}/versions/{version}?api-version=v1

Buat baru atau perbarui DatasetVersion yang ada dengan id versi yang diberikan

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.
Nama	path	Yes	string	Nama sumber daya
versi	path	Yes	string	ID versi spesifik dari DatasetVersion untuk dibuat atau diperbarui.

Isi Permintaan

Jenis Konten: application/merge-patch+json

Nama	Tipe	Deskripsi	Diperlukan
deskripsi	string	Teks deskripsi aset.	Tidak.
tags	objek	Kamus tag. Tag dapat ditambahkan, dihapus, dan diperbarui.	Tidak.
jenis	DatasetType	Enum untuk menentukan jenis data.	Yes

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	DatasetVersion

Kode Status: 201

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

Content-Type	Jenis	Deskripsi
application/json	DatasetVersion

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	Azure. Core.Foundations.ErrorResponse

Header Respons:

Header	Tipe	Deskripsi
x-ms-error-code	string	Kode kesalahan string yang menunjukkan apa yang salah.

Himpunan data - mendapatkan kredensial

POST {endpoint}/datasets/{name}/versions/{version}/credentials?api-version=v1

Dapatkan kredensial SAS untuk access akun storage yang terkait dengan versi Himpunan Data.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.
Nama	path	Yes	string	Nama sumber daya
versi	path	Yes	string	ID versi spesifik dari DatasetVersion untuk dioperasikan.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	AssetCredentialResponse

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	Azure. Core.Foundations.ErrorResponse

Header Respons:

Header	Tipe	Deskripsi
x-ms-error-code	string	Kode kesalahan string yang menunjukkan apa yang salah.

Himpunan data - mulai mengunggah versi yang tertunda

POST {endpoint}/datasets/{name}/versions/{version}/startPendingUpload?api-version=v1

Mulai yang baru atau dapatkan unggahan set data yang tertunda untuk versi tertentu.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.
Nama	path	Yes	string	Nama sumber daya
versi	path	Yes	string	ID versi spesifik dari DatasetVersion untuk dioperasikan.

Isi Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan
connectionName	string	Nama koneksi Akun Azure Storage yang akan digunakan untuk menghasilkan token SAS sementara	Tidak.
pendingUploadId	string	Jika PendingUploadId tidak disediakan, GUID acak akan digunakan.	Tidak.
pendingUploadType	enum	BlobReference adalah satu-satunya jenis yang didukung. Nilai yang mungkin: `BlobReference`	Yes

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	PendingUploadResponse

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	Azure. Core.Foundations.ErrorResponse

Header Respons:

Header	Tipe	Deskripsi
x-ms-error-code	string	Kode kesalahan string yang menunjukkan apa yang salah.

Penyebaran

Penyebaran - daftar

GET {endpoint}/deployments?api-version=v1

Cantumkan semua model yang disebarkan di project

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.
modelPublisher	kueri	Tidak.	string	Model publisher untuk memfilter model berdasarkan
modelName	kueri	Tidak.	string	Nama model (nama khusus publisher) untuk memfilter model berdasarkan
deploymentType	kueri	Tidak.	string Nilai yang mungkin: `ModelDeployment`	Jenis penyebaran untuk memfilter daftar berdasarkan

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
x-ms-client-request-id	False	string	Pengidentifikasi string yang buram dan unik secara global yang dihasilkan klien untuk permintaan tersebut.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	PagedDeployment

Header Respons:

Header	Tipe	Deskripsi
x-ms-client-request-id		Pengidentifikasi string yang buram dan unik secara global yang dihasilkan klien untuk permintaan tersebut.

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	Azure. Core.Foundations.ErrorResponse

Header Respons:

Header	Tipe	Deskripsi
x-ms-error-code	string	Kode kesalahan string yang menunjukkan apa yang salah.

Penyebaran - dapatkan

GET {endpoint}/deployments/{name}?api-version=v1

Dapatkan model yang disebarkan.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.
Nama	path	Yes	string	Nama penyebaran

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
x-ms-client-request-id	False	string	Pengidentifikasi string yang buram dan unik secara global yang dihasilkan klien untuk permintaan tersebut.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	Penyebaran

Header Respons:

Header	Tipe	Deskripsi
x-ms-client-request-id		Pengidentifikasi string yang buram dan unik secara global yang dihasilkan klien untuk permintaan tersebut.

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	Azure. Core.Foundations.ErrorResponse

Header Respons:

Header	Tipe	Deskripsi
x-ms-error-code	string	Kode kesalahan string yang menunjukkan apa yang salah.

Taksonomi Evaluasi

Taksonomi evaluasi - daftar

GET {endpoint}/evaluationtaxonomies?api-version=v1

Daftar taksonomi evaluasi

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.
inputName	kueri	Tidak.	string	Filter berdasarkan nama input evaluasi.
inputType	kueri	Tidak.	string	Filter berdasarkan jenis input taksonomi.

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
Foundry-Features	Benar	string Nilai yang mungkin: `Evaluations=V1Preview`	Keikutsertaan bendera fitur diperlukan saat menggunakan operasi pratinjau atau memodifikasi sumber daya pratinjau yang bertahan.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	PagedEvaluationTaxonomy

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	Azure. Core.Foundations.ErrorResponse

Header Respons:

Header	Tipe	Deskripsi
x-ms-error-code	string	Kode kesalahan string yang menunjukkan apa yang salah.

Taksonomi evaluasi - dapatkan

GET {endpoint}/evaluationtaxonomies/{name}?api-version=v1

Dapatkan evaluasi yang dijalankan berdasarkan nama.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.
Nama	path	Yes	string	Nama sumber daya

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
Foundry-Features	Benar	string Nilai yang mungkin: `Evaluations=V1Preview`	Keikutsertaan bendera fitur diperlukan saat menggunakan operasi pratinjau atau memodifikasi sumber daya pratinjau yang bertahan.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	EvaluasiTaxonomy

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	Azure. Core.Foundations.ErrorResponse

Header Respons:

Header	Tipe	Deskripsi
x-ms-error-code	string	Kode kesalahan string yang menunjukkan apa yang salah.

Taksonomi evaluasi - hapus

DELETE {endpoint}/evaluationtaxonomies/{name}?api-version=v1

Hapus taksonomi evaluasi berdasarkan nama.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.
Nama	path	Yes	string	Nama sumber daya

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
Foundry-Features	Benar	string Nilai yang mungkin: `Evaluations=V1Preview`	Keikutsertaan bendera fitur diperlukan saat menggunakan operasi pratinjau atau memodifikasi sumber daya pratinjau yang bertahan.

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	Azure. Core.Foundations.ErrorResponse

Header Respons:

Header	Tipe	Deskripsi
x-ms-error-code	string	Kode kesalahan string yang menunjukkan apa yang salah.

Taksonomi evaluasi - buat

PUT {endpoint}/evaluationtaxonomies/{name}?api-version=v1

Buat taksonomi evaluasi.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.
Nama	path	Yes	string	Nama taksonomi evaluasi.

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
Foundry-Features	Benar	string Nilai yang mungkin: `Evaluations=V1Preview`	Keikutsertaan bendera fitur diperlukan saat menggunakan operasi pratinjau atau memodifikasi sumber daya pratinjau yang bertahan.

Isi Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan
deskripsi	string	Teks deskripsi aset.	Tidak.
properties	objek	Properti tambahan untuk taksonomi evaluasi.	Tidak.
tags	objek	Kamus tag. Tag dapat ditambahkan, dihapus, dan diperbarui.	Tidak.
taxonomyCategories	array TaxonomyCategory	Daftar kategori taksonomi.	Tidak.
taxonomyInput	EvaluasiTaxonomyInput	Konfigurasi input untuk taksonomi evaluasi.	Yes
└─ jenis	EvaluationTaxonomyInputType	Jenis input taksonomi evaluasi.	Yes

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	EvaluasiTaxonomy

Kode Status: 201

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

Content-Type	Jenis	Deskripsi
application/json	EvaluasiTaxonomy

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	Azure. Core.Foundations.ErrorResponse

Header Respons:

Header	Tipe	Deskripsi
x-ms-error-code	string	Kode kesalahan string yang menunjukkan apa yang salah.

Taksonomi evaluasi - pembaruan

PATCH {endpoint}/evaluationtaxonomies/{name}?api-version=v1

Perbarui taksonomi evaluasi.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.
Nama	path	Yes	string	Nama taksonomi evaluasi.

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
Foundry-Features	Benar	string Nilai yang mungkin: `Evaluations=V1Preview`	Keikutsertaan bendera fitur diperlukan saat menggunakan operasi pratinjau atau memodifikasi sumber daya pratinjau yang bertahan.

Isi Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan
deskripsi	string	Teks deskripsi aset.	Tidak.
properties	objek	Properti tambahan untuk taksonomi evaluasi.	Tidak.
tags	objek	Kamus tag. Tag dapat ditambahkan, dihapus, dan diperbarui.	Tidak.
taxonomyCategories	array TaxonomyCategory	Daftar kategori taksonomi.	Tidak.
taxonomyInput	EvaluationTaxonomyInputUpdate	Konfigurasi input untuk taksonomi evaluasi.	Tidak.
└─ jenis	EvaluationTaxonomyInputType	Jenis input taksonomi evaluasi.	Yes

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	EvaluasiTaxonomy

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	Azure. Core.Foundations.ErrorResponse

Header Respons:

Header	Tipe	Deskripsi
x-ms-error-code	string	Kode kesalahan string yang menunjukkan apa yang salah.

Aturan Evaluasi

Aturan evaluasi - daftar

GET {endpoint}/evaluationrules?api-version=v1

Cantumkan semua aturan evaluasi.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.
actionType	kueri	Tidak.	string Nilai yang mungkin: `continuousEvaluation`, `humanEvaluationPreview`	Filter berdasarkan jenis aturan evaluasi.
agen Nama	kueri	Tidak.	string	Filter berdasarkan nama agen.
enabled	kueri	Tidak.	Boolean	Filter berdasarkan status yang diaktifkan.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	PagedEvaluationRule

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	Azure. Core.Foundations.ErrorResponse

Header Respons:

Header	Tipe	Deskripsi
x-ms-error-code	string	Kode kesalahan string yang menunjukkan apa yang salah.

Aturan evaluasi - dapatkan

GET {endpoint}/evaluationrules/{id}?api-version=v1

Dapatkan aturan evaluasi.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.
id	path	Yes	string	Pengidentifikasi unik untuk aturan evaluasi.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	EvaluationRule

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	Azure. Core.Foundations.ErrorResponse

Header Respons:

Header	Tipe	Deskripsi
x-ms-error-code	string	Kode kesalahan string yang menunjukkan apa yang salah.

Aturan evaluasi - hapus

DELETE {endpoint}/evaluationrules/{id}?api-version=v1

Hapus aturan evaluasi.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.
id	path	Yes	string	Pengidentifikasi unik untuk aturan evaluasi.

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	Azure. Core.Foundations.ErrorResponse

Header Respons:

Header	Tipe	Deskripsi
x-ms-error-code	string	Kode kesalahan string yang menunjukkan apa yang salah.

Aturan evaluasi - membuat atau memperbarui

PUT {endpoint}/evaluationrules/{id}?api-version=v1

Membuat atau memperbarui aturan evaluasi.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.
id	path	Yes	string	Pengidentifikasi unik untuk aturan evaluasi.

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
Foundry-Features	False	string Nilai yang mungkin: `Evaluations=V1Preview`	Keikutsertaan bendera fitur diperlukan saat menggunakan operasi pratinjau atau memodifikasi sumber daya pratinjau yang bertahan.

Isi Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan
tindakan	EvaluationRuleAction	Model tindakan evaluasi.	Yes
└─ jenis	EvaluationRuleActionType	Jenis tindakan evaluasi.	Yes
deskripsi	string	Deskripsi untuk aturan evaluasi.	Tidak.
nama tampilan	string	Nama Tampilan untuk aturan evaluasi.	Tidak.
enabled	Boolean	Menunjukkan apakah aturan evaluasi diaktifkan. Nilai default adalah benar.	Yes
eventType	EvaluationRuleEventType	Jenis peristiwa aturan evaluasi.	Yes
filter	EvaluationRuleFilter	Model filter evaluasi.	Tidak.
└─ agenNama	string	Filter berdasarkan nama agen.	Yes
id	string (baca-saja)	Pengidentifikasi unik untuk aturan evaluasi.	Yes
sistem Data	objek (baca-saja)	Metadata sistem untuk aturan evaluasi.	Yes

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	EvaluationRule

Kode Status: 201

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

Content-Type	Jenis	Deskripsi
application/json	EvaluationRule

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	Azure. Core.Foundations.ErrorResponse

Header Respons:

Header	Tipe	Deskripsi
x-ms-error-code	string	Kode kesalahan string yang menunjukkan apa yang salah.

Evaluator

Evaluator - mencantumkan versi terbaru

GET {endpoint}/evaluators?api-version=v1

Cantumkan versi terbaru dari setiap evaluator

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.
jenis	kueri	Tidak.	string Nilai yang mungkin: `builtin`, `custom`, `all`	Filter evaluator berdasarkan jenis. Nilai yang memungkinkan: 'semua', 'kustom', 'bawaan'.
limit	kueri	Tidak.	bilangan bulat	Batas jumlah objek yang akan dikembalikan. Batas dapat berkisar antara 1 dan 100, dan defaultnya adalah 20.

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
Foundry-Features	Benar	string Nilai yang mungkin: `Evaluations=V1Preview`	Keikutsertaan bendera fitur diperlukan saat menggunakan operasi pratinjau atau memodifikasi sumber daya pratinjau yang bertahan.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	PagedEvaluatorVersion

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	Azure. Core.Foundations.ErrorResponse

Header Respons:

Header	Tipe	Deskripsi
x-ms-error-code	string	Kode kesalahan string yang menunjukkan apa yang salah.

Evaluator - daftar versi

GET {endpoint}/evaluators/{name}/versions?api-version=v1

Cantumkan semua versi evaluator yang diberikan

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.
Nama	path	Yes	string	Nama sumber daya
jenis	kueri	Tidak.	string Nilai yang mungkin: `builtin`, `custom`, `all`	Filter evaluator berdasarkan jenis. Nilai yang memungkinkan: 'semua', 'kustom', 'bawaan'.
limit	kueri	Tidak.	bilangan bulat	Batas jumlah objek yang akan dikembalikan. Batas dapat berkisar antara 1 dan 100, dan defaultnya adalah 20.

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
Foundry-Features	Benar	string Nilai yang mungkin: `Evaluations=V1Preview`	Keikutsertaan bendera fitur diperlukan saat menggunakan operasi pratinjau atau memodifikasi sumber daya pratinjau yang bertahan.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	PagedEvaluatorVersion

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	Azure. Core.Foundations.ErrorResponse

Header Respons:

Header	Tipe	Deskripsi
x-ms-error-code	string	Kode kesalahan string yang menunjukkan apa yang salah.

Evaluator - buat versi

POST {endpoint}/evaluators/{name}/versions?api-version=v1

Membuat EvaluatorVersion baru dengan id versi bertambah otomatis

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.
Nama	path	Yes	string	Nama sumber daya

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
Foundry-Features	Benar	string Nilai yang mungkin: `Evaluations=V1Preview`	Keikutsertaan bendera fitur diperlukan saat menggunakan operasi pratinjau atau memodifikasi sumber daya pratinjau yang bertahan.

Isi Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan
categories	array EvaluatorCategory	Kategori evaluator	Yes
definisi	EvaluatorDefinition	Konfigurasi evaluator dasar dengan diskriminator	Yes
└─ data_schema	objek	Skema JSON (Draf 2020-12) untuk data input evaluator. Ini termasuk parameter seperti jenis, properti, diperlukan.	Tidak.
└─ init_parameters	objek	Skema JSON (Draf 2020-12) untuk parameter input evaluator. Ini termasuk parameter seperti jenis, properti, diperlukan.	Tidak.
└─ metrik	objek	Daftar metrik output yang dihasilkan oleh evaluator ini	Tidak.
└─ jenis	EvaluatorDefinitionType	Jenis definisi evaluator	Yes
deskripsi	string	Teks deskripsi aset.	Tidak.
display_name	string	Nama Tampilan untuk evaluator. Ini membantu menemukan evaluator dengan mudah di AI Foundry. Tidak perlu unik.	Tidak.
evaluator_type	EvaluatorType	Jenis evaluator	Yes
metadata	objek	Metadata tentang evaluator	Tidak.
tags	objek	Kamus tag. Tag dapat ditambahkan, dihapus, dan diperbarui.	Tidak.

Responses

Kode Status: 201

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

Content-Type	Jenis	Deskripsi
application/json	EvaluatorVersion

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	Azure. Core.Foundations.ErrorResponse

Header Respons:

Header	Tipe	Deskripsi
x-ms-error-code	string	Kode kesalahan string yang menunjukkan apa yang salah.

Evaluator - dapatkan versi

GET {endpoint}/evaluators/{name}/versions/{version}?api-version=v1

Dapatkan versi spesifik dari EvaluatorVersion. Layanan mengembalikan kesalahan 404 Tidak Ditemukan jika EvaluatorVersion tidak ada.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.
Nama	path	Yes	string	Nama sumber daya
versi	path	Yes	string	Id versi tertentu dari EvaluatorVersion untuk diambil.

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
Foundry-Features	Benar	string Nilai yang mungkin: `Evaluations=V1Preview`	Keikutsertaan bendera fitur diperlukan saat menggunakan operasi pratinjau atau memodifikasi sumber daya pratinjau yang bertahan.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	EvaluatorVersion

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	Azure. Core.Foundations.ErrorResponse

Header Respons:

Header	Tipe	Deskripsi
x-ms-error-code	string	Kode kesalahan string yang menunjukkan apa yang salah.

Evaluator - hapus versi

DELETE {endpoint}/evaluators/{name}/versions/{version}?api-version=v1

Hapus versi tertentu dari EvaluatorVersion. Layanan mengembalikan 204 Tidak Ada Konten jika EvaluatorVersion berhasil dihapus atau jika EvaluatorVersion tidak ada.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.
Nama	path	Yes	string	Nama sumber daya
versi	path	Yes	string	Versi EvaluatorVersion yang akan dihapus.

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
Foundry-Features	Benar	string Nilai yang mungkin: `Evaluations=V1Preview`	Keikutsertaan bendera fitur diperlukan saat menggunakan operasi pratinjau atau memodifikasi sumber daya pratinjau yang bertahan.

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	Azure. Core.Foundations.ErrorResponse

Header Respons:

Header	Tipe	Deskripsi
x-ms-error-code	string	Kode kesalahan string yang menunjukkan apa yang salah.

Evaluator - versi pembaruan

PATCH {endpoint}/evaluators/{name}/versions/{version}?api-version=v1

Perbarui EvaluatorVersion yang ada dengan id versi yang diberikan

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.
Nama	path	Yes	string	Nama sumber daya
versi	path	Yes	string	Versi EvaluatorVersion yang akan diperbarui.

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
Foundry-Features	Benar	string Nilai yang mungkin: `Evaluations=V1Preview`	Keikutsertaan bendera fitur diperlukan saat menggunakan operasi pratinjau atau memodifikasi sumber daya pratinjau yang bertahan.

Isi Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan
categories	array EvaluatorCategory	Kategori evaluator	Tidak.
deskripsi	string	Teks deskripsi aset.	Tidak.
display_name	string	Nama Tampilan untuk evaluator. Ini membantu menemukan evaluator dengan mudah di AI Foundry. Tidak perlu unik.	Tidak.
metadata	objek	Metadata tentang evaluator	Tidak.
tags	objek	Kamus tag. Tag dapat ditambahkan, dihapus, dan diperbarui.	Tidak.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	EvaluatorVersion

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	Azure. Core.Foundations.ErrorResponse

Header Respons:

Header	Tipe	Deskripsi
x-ms-error-code	string	Kode kesalahan string yang menunjukkan apa yang salah.

Indeks

Indeks - daftar terbaru

GET {endpoint}/indexes?api-version=v1

Cantumkan versi terbaru dari setiap Indeks

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	PagedIndex

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	Azure. Core.Foundations.ErrorResponse

Header Respons:

Header	Tipe	Deskripsi
x-ms-error-code	string	Kode kesalahan string yang menunjukkan apa yang salah.

Indeks - versi daftar

GET {endpoint}/indexes/{name}/versions?api-version=v1

Cantumkan semua versi Indeks yang diberikan

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.
Nama	path	Yes	string	Nama sumber daya

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	PagedIndex

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	Azure. Core.Foundations.ErrorResponse

Header Respons:

Header	Tipe	Deskripsi
x-ms-error-code	string	Kode kesalahan string yang menunjukkan apa yang salah.

Indeks - dapatkan versi

GET {endpoint}/indexes/{name}/versions/{version}?api-version=v1

Dapatkan versi spesifik dari Indeks. Layanan mengembalikan kesalahan 404 Tidak Ditemukan jika Indeks tidak ada.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.
Nama	path	Yes	string	Nama sumber daya
versi	path	Yes	string	ID versi spesifik dari Indeks yang akan diambil.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	Indeks

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	Azure. Core.Foundations.ErrorResponse

Header Respons:

Header	Tipe	Deskripsi
x-ms-error-code	string	Kode kesalahan string yang menunjukkan apa yang salah.

Indeks - hapus versi

DELETE {endpoint}/indexes/{name}/versions/{version}?api-version=v1

Hapus versi Indeks tertentu. Layanan mengembalikan 204 Tidak Ada Konten jika Indeks berhasil dihapus atau jika Indeks tidak ada.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.
Nama	path	Yes	string	Nama sumber daya
versi	path	Yes	string	Versi Indeks yang akan dihapus.

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	Azure. Core.Foundations.ErrorResponse

Header Respons:

Header	Tipe	Deskripsi
x-ms-error-code	string	Kode kesalahan string yang menunjukkan apa yang salah.

Indeks - membuat atau memperbarui versi

PATCH {endpoint}/indexes/{name}/versions/{version}?api-version=v1

Buat baru atau perbarui Indeks yang ada dengan id versi yang diberikan

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.
Nama	path	Yes	string	Nama sumber daya
versi	path	Yes	string	ID versi spesifik dari Indeks untuk dibuat atau diperbarui.

Isi Permintaan

Jenis Konten: application/merge-patch+json

Nama	Tipe	Deskripsi	Diperlukan
deskripsi	string	Teks deskripsi aset.	Tidak.
tags	objek	Kamus tag. Tag dapat ditambahkan, dihapus, dan diperbarui.	Tidak.
jenis	IndexType		Yes

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	Indeks

Kode Status: 201

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

Content-Type	Jenis	Deskripsi
application/json	Indeks

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	Azure. Core.Foundations.ErrorResponse

Header Respons:

Header	Tipe	Deskripsi
x-ms-error-code	string	Kode kesalahan string yang menunjukkan apa yang salah.

Insights

Wawasan - hasilkan

POST {endpoint}/insights?api-version=v1

Hasilkan Wawasan

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
Foundry-Features	Benar	string Nilai yang mungkin: `Insights=V1Preview`	Keikutsertaan bendera fitur diperlukan saat menggunakan operasi pratinjau atau memodifikasi sumber daya pratinjau yang bertahan.
Pengulangan-Request-ID	False	string	Pengidentifikasi unik yang dihasilkan klien untuk memastikan idempotensi permintaan. Gunakan ID yang sama untuk percobaan ulang untuk mencegah evaluasi duplikat.
Pengulangan-First-Sent	False	string	Stempel waktu yang menunjukkan kapan permintaan ini pertama kali dimulai. Digunakan bersama dengan repeatability-request-id untuk kontrol idempotensi.

Isi Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan
nama tampilan	string	Nama tampilan yang mudah digunakan untuk wawasan.	Yes
id	string (baca-saja)	Pengidentifikasi unik untuk laporan wawasan.	Yes
metadata	InsightsMetadata (baca-saja)	Metadata tentang wawasan.	Yes
└─ selesaiPada	string	Stempel waktu saat wawasan selesai.	Tidak.
└─ createAt	string	Stempel waktu saat wawasan dibuat.	Yes
permintaan	InsightRequest	Permintaan laporan wawasan.	Yes
└─ jenis	InsightType	Jenis permintaan.	Yes
hasil	InsightResult (baca-saja)	Hasil wawasan.	Tidak.
└─ jenis	InsightType	Jenis hasil wawasan.	Yes
state	Azure. Core.Foundations.OperationState (baca-saja)	Enum yang menjelaskan status operasi yang diizinkan.	Yes

Responses

Kode Status: 201

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

Content-Type	Jenis	Deskripsi
application/json	Wawasan

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	Azure. Core.Foundations.ErrorResponse

Header Respons:

Header	Tipe	Deskripsi
x-ms-error-code	string	Kode kesalahan string yang menunjukkan apa yang salah.

Wawasan - daftar

GET {endpoint}/insights?api-version=v1

Cantumkan semua wawasan dalam urutan kronologis terbalik (yang terbaru terlebih dahulu).

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.
jenis	kueri	Tidak.	string Nilai yang mungkin: `EvaluationRunClusterInsight`, `AgentClusterInsight`, `EvaluationComparison`	Filter berdasarkan jenis analisis.
evalId	kueri	Tidak.	string	Filter berdasarkan ID evaluasi.
runId	kueri	Tidak.	string	Filter berdasarkan ID eksekusi evaluasi.
agen Nama	kueri	Tidak.	string	Filter berdasarkan nama agen.
includeCoordinates	kueri	Tidak.	Boolean	Apakah akan menyertakan koordinat untuk visualisasi dalam respons. Secara default diatur ke false.

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
Foundry-Features	Benar	string Nilai yang mungkin: `Insights=V1Preview`	Keikutsertaan bendera fitur diperlukan saat menggunakan operasi pratinjau atau memodifikasi sumber daya pratinjau yang bertahan.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	PagedInsight

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	Azure. Core.Foundations.ErrorResponse

Header Respons:

Header	Tipe	Deskripsi
x-ms-error-code	string	Kode kesalahan string yang menunjukkan apa yang salah.

Wawasan - dapatkan

GET {endpoint}/insights/{id}?api-version=v1

Dapatkan wawasan spesifik berdasarkan Id.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.
id	path	Yes	string	Pengidentifikasi unik untuk laporan wawasan.
includeCoordinates	kueri	Tidak.	Boolean	Apakah akan menyertakan koordinat untuk visualisasi dalam respons. Secara default diatur ke false.

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
Foundry-Features	Benar	string Nilai yang mungkin: `Insights=V1Preview`	Keikutsertaan bendera fitur diperlukan saat menggunakan operasi pratinjau atau memodifikasi sumber daya pratinjau yang bertahan.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	Wawasan

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	Azure. Core.Foundations.ErrorResponse

Header Respons:

Header	Tipe	Deskripsi
x-ms-error-code	string	Kode kesalahan string yang menunjukkan apa yang salah.

Penyimpanan Memori

Membuat penyimpanan memori

POST {endpoint}/memory_stores?api-version=v1

Buat penyimpanan memori.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
Foundry-Features	Benar	string Nilai yang mungkin: `MemoryStores=V1Preview`	Keikutsertaan bendera fitur diperlukan saat menggunakan operasi pratinjau atau memodifikasi sumber daya pratinjau yang bertahan.

Isi Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan
definisi	MemoryStoreDefinition	Definisi dasar untuk konfigurasi penyimpanan memori.	Yes
└─ jenis	MemoryStoreKind	Jenis penyimpanan memori.	Yes
deskripsi	string	Deskripsi penyimpanan memori yang dapat dibaca manusia. Batasan: maxLength: 512	Tidak.
metadata	objek	Metadata nilai kunci arbitrer untuk dikaitkan dengan penyimpanan memori.	Tidak.
Nama	string	Nama penyimpanan memori. Batasan: maxLength: 256	Yes

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	MemoryStoreObject

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Mencantumkan penyimpanan memori

GET {endpoint}/memory_stores?api-version=v1

Cantumkan semua penyimpanan memori.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
limit	kueri	Tidak.	bilangan bulat	Batas jumlah objek yang akan dikembalikan. Batas dapat berkisar antara 1 dan 100, dan defaultnya adalah 20.
order	kueri	Tidak.	string Nilai yang mungkin: `asc`, `desc`	Urutkan urutan menurut `created_at` tanda waktu objek. `asc` untuk urutan naik dan`desc` untuk urutan turun.
after	kueri	Tidak.	string	Kursor untuk digunakan dalam penomoran halaman. `after` adalah ID objek yang menentukan tempat Anda dalam daftar. Misalnya, jika Anda membuat permintaan daftar dan menerima 100 objek, objek terakhir adalah obj_foo, Panggilan berikutnya dapat mencakup after=obj_foo untuk mendapatkan halaman berikutnya dari daftar.
sebelum	kueri	Tidak.	string	Kursor untuk digunakan dalam penomoran halaman. `before` adalah ID objek yang menentukan tempat Anda dalam daftar. Misalnya, jika Anda membuat permintaan daftar dan menerima 100 objek, objek terakhir adalah obj_foo, Panggilan berikutnya dapat mencakup before=obj_foo untuk menampilkan halaman sebelumnya dari daftar item.
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
Foundry-Features	Benar	string Nilai yang mungkin: `MemoryStores=V1Preview`	Keikutsertaan bendera fitur diperlukan saat menggunakan operasi pratinjau atau memodifikasi sumber daya pratinjau yang bertahan.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	objek	Data respons untuk daftar item yang diminta.

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Memperbarui penyimpanan memori

POST {endpoint}/memory_stores/{name}?api-version=v1

Perbarui penyimpanan memori.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
Nama	path	Yes	string	Nama penyimpanan memori yang akan diperbarui.
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
Foundry-Features	Benar	string Nilai yang mungkin: `MemoryStores=V1Preview`	Keikutsertaan bendera fitur diperlukan saat menggunakan operasi pratinjau atau memodifikasi sumber daya pratinjau yang bertahan.

Isi Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan	Default
deskripsi	string	Deskripsi penyimpanan memori yang dapat dibaca manusia. Batasan: maxLength: 512	Tidak.
metadata	objek	Metadata nilai kunci arbitrer untuk dikaitkan dengan penyimpanan memori.	Tidak.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	MemoryStoreObject

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Dapatkan penyimpanan memori

GET {endpoint}/memory_stores/{name}?api-version=v1

Ambil penyimpanan memori.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
Nama	path	Yes	string	Nama penyimpanan memori yang akan diambil.
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
Foundry-Features	Benar	string Nilai yang mungkin: `MemoryStores=V1Preview`	Keikutsertaan bendera fitur diperlukan saat menggunakan operasi pratinjau atau memodifikasi sumber daya pratinjau yang bertahan.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	MemoryStoreObject

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Hapus penyimpanan memori

DELETE {endpoint}/memory_stores/{name}?api-version=v1

Hapus penyimpanan memori.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
Nama	path	Yes	string	Nama penyimpanan memori yang akan dihapus.
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
Foundry-Features	Benar	string Nilai yang mungkin: `MemoryStores=V1Preview`	Keikutsertaan bendera fitur diperlukan saat menggunakan operasi pratinjau atau memodifikasi sumber daya pratinjau yang bertahan.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	DeleteMemoryStoreResponse

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Dapatkan hasil pembaruan

GET {endpoint}/memory_stores/{name}/updates/{update_id}?api-version=v1

Dapatkan hasil pembaruan penyimpanan memori.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
Nama	path	Yes	string	Nama penyimpanan memori.
update_id	path	Yes	string	ID operasi pembaruan memori.
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
Foundry-Features	Benar	string Nilai yang mungkin: `MemoryStores=V1Preview`	Keikutsertaan bendera fitur diperlukan saat menggunakan operasi pratinjau atau memodifikasi sumber daya pratinjau yang bertahan.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	MemoryStoreUpdateResponse

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Menghapus memori cakupan

POST {endpoint}/memory_stores/{name}:delete_scope?api-version=v1

Hapus semua memori yang terkait dengan cakupan tertentu dari penyimpanan memori.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
Nama	path	Yes	string	Nama penyimpanan memori.
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
Foundry-Features	Benar	string Nilai yang mungkin: `MemoryStores=V1Preview`	Keikutsertaan bendera fitur diperlukan saat menggunakan operasi pratinjau atau memodifikasi sumber daya pratinjau yang bertahan.

Isi Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan	Default
cakupan	string	Namespace yang secara logis mengelompokkan dan mengisolasi memori untuk dihapus, seperti ID pengguna.	Yes

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	MemoryStoreDeleteScopeResponse

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Kenangan pencarian

POST {endpoint}/memory_stores/{name}:search_memories?api-version=v1

Cari kenangan yang relevan dari penyimpanan memori berdasarkan konteks percakapan.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
Nama	path	Yes	string	Nama penyimpanan memori yang akan dicari.
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
Foundry-Features	Benar	string Nilai yang mungkin: `MemoryStores=V1Preview`	Keikutsertaan bendera fitur diperlukan saat menggunakan operasi pratinjau atau memodifikasi sumber daya pratinjau yang bertahan.

Isi Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan
items	array OpenAI.InputItem	Item untuk mencari kenangan yang relevan.	Tidak.
options	MemorySearchOptions	Opsi pencarian memori.	Tidak.
└─ max_memories	bilangan bulat	Jumlah maksimum item memori yang akan dikembalikan.	Tidak.
previous_search_id	string	ID unik dari permintaan pencarian sebelumnya, memungkinkan pencarian memori inkremental dari tempat operasi terakhir ditinggalkan.	Tidak.
cakupan	string	Namespace yang secara logis mengelompokkan dan mengisolasi memori, seperti ID pengguna.	Yes

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	MemoryStoreSearchResponse

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Memperbarui memori

POST {endpoint}/memory_stores/{name}:update_memories?api-version=v1

Perbarui penyimpanan memori dengan memori percakapan.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
Nama	path	Yes	string	Nama penyimpanan memori yang akan diperbarui.
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
Foundry-Features	Benar	string Nilai yang mungkin: `MemoryStores=V1Preview`	Keikutsertaan bendera fitur diperlukan saat menggunakan operasi pratinjau atau memodifikasi sumber daya pratinjau yang bertahan.

Isi Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan	Default
items	array OpenAI.InputItem	Item percakapan untuk mengekstrak kenangan.	Tidak.
previous_update_id	string	ID unik dari permintaan pembaruan sebelumnya, memungkinkan pembaruan memori inkremental dari tempat operasi terakhir ditinggalkan.	Tidak.
cakupan	string	Namespace yang secara logis mengelompokkan dan mengisolasi memori, seperti ID pengguna.	Yes
update_delay	bilangan bulat	Periode batas waktu sebelum memproses pembaruan memori dalam hitungan detik. Jika permintaan pembaruan baru diterima selama periode ini, permintaan saat ini akan membatalkan permintaan saat ini dan mengatur ulang batas waktu. Atur ke 0 untuk segera memicu pembaruan tanpa penundaan. Default ke 300 (5 menit).	Tidak.	300

Responses

Kode Status: 202

Deskripsi: Permintaan telah diterima untuk diproses, tetapi pemrosesan belum selesai.

Content-Type	Jenis	Deskripsi
application/json	MemoryStoreUpdateResponse

Header Respons:

Header	Tipe	Deskripsi
Operasi-Lokasi	string	Lokasi untuk memantau status operasi.

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Percakapan

Membuat percakapan

POST {endpoint}/openai/v1/conversations

Buat percakapan.

Isi Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan	Default
items	array OpenAI.InputItem		Tidak.
metadata	OpenAI.Metadata (dapat diberisi dengan null)	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini bisa berguna untuk menyimpan informasi tambahan tentang objek dalam terstruktur pemformatan dan pengambilan kueri untuk objek melalui API atau dasbor. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter.	Tidak.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	OpenAI.ConversationResource

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Mencantumkan percakapan

GET {endpoint}/openai/v1/conversations

Mengembalikan daftar semua percakapan.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
limit	kueri	Tidak.	bilangan bulat	Batas jumlah objek yang akan dikembalikan. Batas dapat berkisar antara 1 dan 100, dan defaultnya adalah 20.
order	kueri	Tidak.	string Nilai yang mungkin: `asc`, `desc`	Urutkan urutan menurut `created_at` tanda waktu objek. `asc` untuk urutan naik dan`desc` untuk urutan turun.
after	kueri	Tidak.	string	Kursor untuk digunakan dalam penomoran halaman. `after` adalah ID objek yang menentukan tempat Anda dalam daftar. Misalnya, jika Anda membuat permintaan daftar dan menerima 100 objek, objek terakhir adalah obj_foo, Panggilan berikutnya dapat mencakup after=obj_foo untuk mendapatkan halaman berikutnya dari daftar.
sebelum	kueri	Tidak.	string	Kursor untuk digunakan dalam penomoran halaman. `before` adalah ID objek yang menentukan tempat Anda dalam daftar. Misalnya, jika Anda membuat permintaan daftar dan menerima 100 objek, objek terakhir adalah obj_foo, Panggilan berikutnya dapat mencakup before=obj_foo untuk menampilkan halaman sebelumnya dari daftar item.
agent_name	kueri	Tidak.	string	Filter berdasarkan nama agen. Jika disediakan, hanya item yang terkait dengan agen yang ditentukan yang akan dikembalikan.
agent_id	kueri	Tidak.	string	Filter menurut ID agen dalam format `name:version`. Jika disediakan, hanya item yang terkait dengan ID agen yang ditentukan yang akan dikembalikan.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	objek	Data respons untuk daftar item yang diminta.

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Memperbarui percakapan

POST {endpoint}/openai/v1/conversations/{conversation_id}

Memperbarui percakapan.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
conversation_id	path	Yes	string	Id percakapan yang akan diperbarui.

Isi Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan	Default
metadata	OpenAI.Metadata (dapat diberisi dengan null)	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini bisa berguna untuk menyimpan informasi tambahan tentang objek dalam terstruktur pemformatan dan pengambilan kueri untuk objek melalui API atau dasbor. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter.	Yes

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	OpenAI.ConversationResource

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Dapatkan percakapan

GET {endpoint}/openai/v1/conversations/{conversation_id}

Mengambil percakapan.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
conversation_id	path	Yes	string	Id percakapan yang akan diambil.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	OpenAI.ConversationResource

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Menghapus percakapan

DELETE {endpoint}/openai/v1/conversations/{conversation_id}

Menghapus percakapan.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
conversation_id	path	Yes	string	Id percakapan yang akan dihapus.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	OpenAI.DeletedConversationResource

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Membuat item percakapan

POST {endpoint}/openai/v1/conversations/{conversation_id}/items

Buat item dalam percakapan dengan ID yang diberikan.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
conversation_id	path	Yes	string	Id percakapan tempat item perlu dibuat.
termasuk	kueri	Tidak.	array	Bidang tambahan untuk disertakan dalam respons. `include` Lihat parameter untuk mencantumkan item Percakapan untuk informasi selengkapnya.

Isi Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan	Default
items	array OpenAI.Item	Item yang akan ditambahkan ke percakapan. Anda dapat menambahkan hingga 20 item pada satu waktu.	Yes

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	OpenAI.ConversationItemList

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Mencantumkan item percakapan

GET {endpoint}/openai/v1/conversations/{conversation_id}/items

Mencantumkan semua item untuk percakapan dengan ID yang diberikan.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
conversation_id	path	Yes	string	Id percakapan tempat item perlu dicantumkan.
limit	kueri	Tidak.	bilangan bulat	Batas jumlah objek yang akan dikembalikan. Batas dapat berkisar antara 1 dan 100, dan defaultnya adalah 20.
order	kueri	Tidak.	string Nilai yang mungkin: `asc`, `desc`	Urutkan urutan menurut `created_at` tanda waktu objek. `asc` untuk urutan naik dan`desc` untuk urutan turun.
after	kueri	Tidak.	string	Kursor untuk digunakan dalam penomoran halaman. `after` adalah ID objek yang menentukan tempat Anda dalam daftar. Misalnya, jika Anda membuat permintaan daftar dan menerima 100 objek, objek terakhir adalah obj_foo, Panggilan berikutnya dapat mencakup after=obj_foo untuk mendapatkan halaman berikutnya dari daftar.
sebelum	kueri	Tidak.	string	Kursor untuk digunakan dalam penomoran halaman. `before` adalah ID objek yang menentukan tempat Anda dalam daftar. Misalnya, jika Anda membuat permintaan daftar dan menerima 100 objek, objek terakhir adalah obj_foo, Panggilan berikutnya dapat mencakup before=obj_foo untuk menampilkan halaman sebelumnya dari daftar item.
item_type	kueri	Tidak.	string Nilai yang mungkin: `message`, , `output_message`, `file_search_callcomputer_call`, `computer_call_output`, `web_search_call`, `function_call`, `function_call_output`, `reasoning`, `compactionimage_generation_call`, , `code_interpreter_call`, `local_shell_call`, `local_shell_call_outputshell_call`, `shell_call_output`, `apply_patch_call`, `apply_patch_call_output`, `mcp_list_toolsmcp_approval_requestmcp_approval_responsemcp_call`, `custom_tool_call_output`, , `custom_tool_call`, `structured_outputs`, , , `oauth_consent_requestmemory_search_callworkflow_action`	Filter menurut jenis item. Jika disediakan, hanya item dari jenis yang ditentukan yang akan dikembalikan.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	objek	Data respons untuk daftar item yang diminta.

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Mendapatkan item percakapan

GET {endpoint}/openai/v1/conversations/{conversation_id}/items/{item_id}

Dapatkan satu item dari percakapan dengan ID yang diberikan.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
conversation_id	path	Yes	string	ID percakapan yang berisi item.
item_id	path	Yes	string	Id item percakapan yang akan diambil.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	OpenAI.OutputItem

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Menghapus item percakapan

DELETE {endpoint}/openai/v1/conversations/{conversation_id}/items/{item_id}

Menghapus item dari percakapan dengan ID yang diberikan.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
conversation_id	path	Yes	string	Id percakapan tempat item perlu dihapus.
item_id	path	Yes	string	Id item percakapan yang akan dihapus.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	OpenAI.ConversationResource

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Evaluasi

Evals - daftar evaluasi

GET {endpoint}/openai/v1/evals

Cantumkan semua evaluasi Daftar evaluasi untuk project.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
after	kueri	Tidak.	string	Pengidentifikasi untuk pengoperasian terakhir dari permintaan paginasi sebelumnya.
limit	kueri	Tidak.	bilangan bulat	Jumlah putaran yang akan diambil.
order	kueri	Tidak.	string Nilai yang mungkin: `asc`, `desc`	Urutkan urutan untuk dijalankan menurut tanda waktu. Gunakan `asc` untuk urutan naik atau `desc` untuk urutan turun. Secara default menjadi `asc`.
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.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	objek	Data respons untuk daftar item yang diminta.

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Evals - buat evaluasi

POST {endpoint}/openai/v1/evals

Buat evaluasi Buat struktur evaluasi yang dapat digunakan untuk menguji performa model. Evaluasi adalah serangkaian kriteria pengujian dan konfigurasi untuk sumber data, yang menentukan skema data yang digunakan dalam evaluasi. Setelah membuat evaluasi, Anda dapat menjalankannya pada model dan parameter model yang berbeda. Kami mendukung beberapa jenis penilai dan sumber data. Untuk informasi selengkapnya, lihat

Isi Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan
konfigurasi_sumber_data	OpenAI.CreateEvalCustomDataSourceConfig atau OpenAI.CreateEvalLogsDataSourceConfig atau OpenAI.CreateEvalStoredCompletionsDataSourceConfig atau AzureAIDataSourceConfig	Konfigurasi untuk sumber data yang digunakan untuk evaluasi berjalan. Menentukan skema data yang digunakan dalam evaluasi.	Yes
metadata	OpenAI.Metadata (dapat diberisi dengan null)	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini bisa berguna untuk menyimpan informasi tambahan tentang objek dalam terstruktur pemformatan dan pengambilan kueri untuk 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.
properties	objek	Set pasangan kunci-nilai 16 yang tidak dapat diubah yang dapat dilampirkan ke objek untuk menyimpan informasi tambahan. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter.	Tidak.
kriteria_pengujian	array OpenAI.EvalGraderLabelModel atau OpenAI.EvalGraderStringCheck atau OpenAI.EvalGraderTextSimilarity atau OpenAI.EvalGraderPython atau OpenAI.EvalGraderScoreModel atau EvalGraderAzureAIEvaluator	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	Evaluasi

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Evals - hapus evaluasi

DELETE {endpoint}/openai/v1/evals/{eval_id}

Menghapus evaluasi Hapus evaluasi.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
eval_id	path	Yes	string	ID evaluasi yang akan dihapus.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	DeleteEvalResponse

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Evals - dapatkan evaluasi

GET {endpoint}/openai/v1/evals/{eval_id}

Dapatkan evaluasi Dapatkan evaluasi berdasarkan ID.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
eval_id	path	Yes	string	ID dari evaluasi yang akan diambil.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	Evaluasi

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Evals - perbarui evaluasi

POST {endpoint}/openai/v1/evals/{eval_id}

Perbarui evaluasi Perbarui properti evaluasi tertentu.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
eval_id	path	Yes	string	ID evaluasi yang akan diperbarui.

Isi Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan
metadata	OpenAI.Metadata (dapat diberisi dengan null)	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini bisa berguna untuk menyimpan informasi tambahan tentang objek dalam terstruktur pemformatan dan pengambilan kueri untuk 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.
properties	objek	Set pasangan kunci-nilai 16 yang tidak dapat diubah yang dapat dilampirkan ke objek untuk menyimpan informasi tambahan. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter.	Tidak.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	Evaluasi

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Evals - daftar berjalan

GET {endpoint}/openai/v1/evals/{eval_id}/runs

Dapatkan daftar eksekusi untuk evaluasi Dapatkan daftar eksekusi untuk evaluasi.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
eval_id	path	Yes	string	ID evaluasi untuk mendapatkan data pelaksanaan.
after	kueri	Tidak.	string	Pengidentifikasi untuk pengoperasian terakhir dari permintaan paginasi sebelumnya.
limit	kueri	Tidak.	bilangan bulat	Jumlah putaran yang akan diambil.
order	kueri	Tidak.	string Nilai yang mungkin: `asc`, `desc`	Urutkan urutan untuk dijalankan menurut tanda waktu. Gunakan `asc` untuk urutan naik atau `desc` untuk urutan turun. Secara default menjadi `asc`.
status	kueri	Tidak.	string Nilai yang mungkin: `queued`, , `in_progresscompleted`, `canceled`, `failed` . Filter berjalan menurut status. Salah satu dari `queued`, `in_progress`, `failed`, `completed`, `canceled`.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	objek	Data respons untuk daftar item yang diminta.

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Evals - buat eval run

POST {endpoint}/openai/v1/evals/{eval_id}/runs

Membuat eksekusi evaluasi

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
eval_id	path	Yes	string	ID evaluasi untuk membuat pengulangan.

Isi Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan
sumber data	OpenAI.CreateEvalJsonlRunDataSource atau OpenAI.CreateEvalCompletionsRunDataSource atau OpenAI.CreateEvalResponsesRunDataSource atau EvalRunDataSource	Detail tentang sumber data eksekusi.	Yes
metadata	OpenAI.Metadata (dapat diberisi dengan null)	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini bisa berguna untuk menyimpan informasi tambahan tentang objek dalam terstruktur pemformatan dan pengambilan kueri untuk 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.
properties	objek	Set pasangan kunci-nilai 16 yang tidak dapat diubah yang dapat dilampirkan ke objek untuk menyimpan informasi tambahan. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter.	Tidak.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	EvalRun

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Evals - hapus eval run

DELETE {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}

Hapus evaluasi jalankan Hapus eval run.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
eval_id	path	Yes	string	ID evaluasi untuk menghapus eksekusi.
run_id	path	Yes	string	ID eksekusi yang akan dihapus.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	DeleteEvalRunResponse

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Evals - dapatkan eksekusi evaluasi

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}

Dapatkan evaluasi jalankan Dapatkan evaluasi yang dijalankan oleh ID.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
eval_id	path	Yes	string	ID evaluasi untuk mendapatkan data pelaksanaan.
run_id	path	Yes	string	ID run untuk diambil.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	EvalRun

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Evals - batalkan eval run

POST {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}

Batalkan evaluasi jalankan Batalkan eksekusi evaluasi yang sedang berlangsung.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
eval_id	path	Yes	string	ID evaluasi yang ingin Anda batalkan pelaksanaannya.
run_id	path	Yes	string	ID dari eksekusi yang ingin dibatalkan.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	EvalRun

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Evals - dapatkan item output eksekusi evaluasi

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}/output_items

Dapatkan item output eksekusi evaluasi Dapatkan daftar item output untuk eksekusi evaluasi.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
eval_id	path	Yes	string
run_id	path	Yes	string	ID run yang digunakan untuk mengambil item output.
after	kueri	Tidak.	string	Pengidentifikasi untuk pengoperasian terakhir dari permintaan paginasi sebelumnya.
limit	kueri	Tidak.	bilangan bulat	Jumlah putaran yang akan diambil.
order	kueri	Tidak.	string Nilai yang mungkin: `asc`, `desc`	Urutkan urutan untuk dijalankan menurut tanda waktu. Gunakan `asc` untuk urutan naik atau `desc` untuk urutan turun. Secara default menjadi `asc`.
status	kueri	Tidak.	string Nilai yang mungkin: `fail`, `pass`	Saring hasil output berdasarkan status. Gunakan `failed` untuk memfilter berdasarkan output yang gagal item atau `pass` untuk memfilter berdasarkan item output yang diteruskan.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	objek	Data respons untuk daftar item yang diminta.

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Evals - dapatkan item output eksekusi evaluasi

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}/output_items/{output_item_id}

Dapatkan item output dari eksekusi evaluasi Dapatkan item output eksekusi evaluasi berdasarkan ID.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
eval_id	path	Yes	string	ID evaluasi untuk mendapatkan data pelaksanaan.
run_id	path	Yes	string	ID run untuk diambil.
output_item_id	path	Yes	string	ID item output yang akan diambil.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	EvalRunOutputItem

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Fine-Tuning

Membuat pekerjaan penyetelan halus

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

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.

Pelajari lebih lanjut tentang penyempurnaan

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.

Isi Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan	Default
hyperparameter	OpenAI.CreateFineTuningJobRequestHyperparameters		Tidak.
└─ batch_size	string atau OpenAI.integer		Tidak.	auto
└─ pengali_kecepatan_pembelajaran	string atau OpenAI.numeric		Tidak.
└─ n_epochs	string atau OpenAI.integer		Tidak.	auto
integrasi	array OpenAI.CreateFineTuningJobRequestIntegrations	Daftar integrasi yang akan diaktifkan untuk pekerjaan penyempurnaan Anda.	Tidak.
metadata	OpenAI.Metadata (dapat diberisi dengan null)	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini bisa berguna untuk menyimpan informasi tambahan tentang objek dalam terstruktur pemformatan dan pengambilan kueri untuk 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. Anda dapat memilih salah satu c0.	Yes
seed	OpenAI.integer (dapat diakses dengan null)		Tidak.
Akhiran	string (dapat diakses NULL)	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`. Batasan: minLength: 1, maxLength: 64	Tidak.
file_pelatihan	string	ID file yang diunggah yang berisi data pelatihan. Lihat mengunggah file untuk cara mengunggah file. 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 . Lihat panduan penyetelan fine-tuning untuk detail selengkapnya.	Yes
validation_file	string (dapat diakses NULL)	ID file yang diunggah yang berisi data validasi. Jika Anda menyediakan file ini, data digunakan untuk menghasilkan validasi metrik secara berkala selama penyempurnaan. Metrik ini dapat dilihat di 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`. Lihat panduan penyetelan fine-tuning untuk detail selengkapnya.	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	ApiErrorResponse

Mencantumkan pekerjaan penyetelan halus yang dipaginasi

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

Mencantumkan pekerjaan penyempurnaan organisasi Anda

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
after	kueri	Tidak.	string	Pengidentifikasi untuk pekerjaan terakhir dari permintaan penomoran halaman sebelumnya.
limit	kueri	Tidak.	bilangan bulat	Jumlah pekerjaan penyempurnaan yang akan diambil.
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.

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	ApiErrorResponse

Mengambil pekerjaan penyetelan halus

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

Dapatkan info tentang pekerjaan penyempurnaan.

Pelajari lebih lanjut tentang penyempurnaan

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
ID_pekerjaan_penyesuaian	path	Yes	string	ID pekerjaan penyempurnaan.
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.

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	ApiErrorResponse

Membatalkan pekerjaan penyetelan halus

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

Segera batalkan pekerjaan yang menyempurnakan.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
ID_pekerjaan_penyesuaian	path	Yes	string	ID pekerjaan penyempurnaan untuk dibatalkan.
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.

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	ApiErrorResponse

Mencantumkan titik pemeriksaan pekerjaan penyetelan halus

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

Mencantumkan titik pemeriksaan untuk pekerjaan penyempurnaan.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
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.
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.

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	ApiErrorResponse

Mencantumkan peristiwa pekerjaan penyetelan halus

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

Dapatkan pembaruan status menenangkan untuk pekerjaan penyempurnaan.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
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.
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.

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	ApiErrorResponse

Menjeda pekerjaan penyetelan halus

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

Jeda pekerjaan yang berjalan dengan baik.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
ID_pekerjaan_penyesuaian	path	Yes	string	ID pekerjaan penyempurnaan untuk dijeda.
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.

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	ApiErrorResponse

Melanjutkan pekerjaan penyetelan halus

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

Lanjutkan pekerjaan yang dijeda yang disempurnakan.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
ID_pekerjaan_penyesuaian	path	Yes	string	ID pekerjaan penyempurnaan untuk dilanjutkan.
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.

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	ApiErrorResponse

Responses

Membuat respons - membuat aliran respons

POST {endpoint}/openai/v1/responses

Membuat tanggapan berdasarkan model. Membuat respons model (respons streaming).

Isi Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan	Default
agent_reference	AgentReference		Tidak.
└─ nama	string	Nama agen. Batasan: maxLength: 256	Yes
└─ jenis	enum	Nilai yang mungkin: `agent_reference`	Yes
└─ versi	string	Pengidentifikasi versi agen.	Tidak.
latar belakang	Boolean (dapat diberisi dengan null)		Tidak.
percakapan	OpenAI.ConversationParam (dapat diberilang)	Percakapan tempat respons ini berada. Item dari percakapan ini sebelumnya ditujukan untuk `input_items` permintaan respons ini. Item input dan item output dari respons ini secara otomatis ditambahkan ke percakapan ini setelah respons ini selesai.	Tidak.
termasuk	array OpenAI.IncludeEnum		Tidak.
Masukan	OpenAI.InputParam	Input teks, gambar, atau file ke model, digunakan untuk menghasilkan respons. Pelajari lebih lanjut: - Input dan output teks - Input gambar - Input file - Status percakapan - Panggilan fungsi	Tidak.
instructions	string (dapat diakses NULL)		Tidak.
max_output_tokens	OpenAI.integer (dapat diakses dengan null)		Tidak.
max_tool_calls	OpenAI.integer (dapat diakses dengan null)		Tidak.
metadata	OpenAI.Metadata (dapat diberisi dengan null)	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini bisa berguna untuk menyimpan informasi tambahan tentang objek dalam terstruktur pemformatan dan pengambilan kueri untuk 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.	Tidak.
pemanggilan_alat_paralel	Boolean (dapat diberisi dengan null)		Tidak.	Benar
previous_response_id	string (dapat diakses NULL)		Tidak.
minta	OpenAI.Prompt	Referensi ke templat perintah dan variabelnya. Pelajari lebih lanjut.	Tidak.
prompt_cache_key	string	Digunakan oleh OpenAI untuk menyimpan respons untuk permintaan serupa guna mengoptimalkan tingkat hit cache Anda. Mengganti bidang `user`. Pelajari lebih lanjut.	Tidak.
prompt_cache_retention	enum	Nilai yang mungkin: `in-memory`, `24h`	Tidak.
reasoning	OpenAI.Reasoning (nullable)	model gpt-5 dan o-series saja Opsi konfigurasi untuk model penalaran.	Tidak.
└─ usaha	OpenAI.ReasoningEffort	Membatasi upaya penalaran untuk model penalaran. Nilai yang saat ini didukung adalah `none`, `minimal`, `low`, `medium`, `high`, dan `xhigh`. Mengurangi upaya penalaran dapat menghasilkan respons yang lebih cepat dan lebih sedikit token yang digunakan penalaran dalam sebuah respons. - `gpt-5.1` default ke `none`, yang tidak melakukan penalaran. Nilai penalaran yang didukung untuk `gpt-5.1` adalah `none`, `low`, `medium`, dan `high`. Panggilan alat didukung untuk semua nilai penalaran dalam gpt-5.1. - Semua model sebelum `gpt-5.1` default ke `medium` upaya penalaran, dan tidak mendukung `none`. - Model `gpt-5-pro` default ke (dan hanya mendukung) `high` upaya penalaran. - `xhigh` didukung untuk semua model setelah `gpt-5.1-codex-max`.	Tidak.
└─ menghasilkan_ringkasan	enum	Nilai yang mungkin: `auto`, `concise`, `detailed`	Tidak.
└─ ringkasan	enum	Nilai yang mungkin: `auto`, `concise`, `detailed`	Tidak.
safety_identifier	string	Pengidentifikasi stabil yang digunakan untuk membantu mendeteksi pengguna aplikasi Anda yang mungkin melanggar kebijakan penggunaan OpenAI. ID harus berupa string yang secara unik mengidentifikasi setiap pengguna. Sebaiknya hash nama pengguna atau alamat email mereka, untuk menghindari pengiriman informasi identifikasi apa pun kepada kami. Pelajari lebih lanjut.	Tidak.
tingkat_layanan	OpenAI.ServiceTier	Menentukan jenis pemrosesan yang digunakan untuk melayani permintaan. - Jika diatur ke 'otomatis', permintaan akan diproses dengan tingkat layanan yang dikonfigurasi di pengaturan Project. Kecuali dikonfigurasi lain, Project akan menggunakan 'default'. - Jika diatur ke 'default', maka permintaan akan diproses dengan harga dan performa standar untuk model yang dipilih. - Jika diatur ke 'flex' atau 'priority', maka permintaan akan diproses dengan tingkat layanan yang sesuai. - Ketika tidak diatur, perilaku defaultnya adalah 'otomatis'. `service_tier` Ketika parameter diatur, isi respons akan menyertakan `service_tier` nilai berdasarkan mode pemrosesan yang benar-benar digunakan untuk melayani permintaan. Nilai respons ini mungkin berbeda dari nilai yang ditetapkan dalam parameter .	Tidak.
simpan	Boolean (dapat diberisi dengan null)		Tidak.	Benar
aliran	Boolean (dapat diberisi dengan null)		Tidak.
stream_options	OpenAI.ResponseStreamOptions (dapat diberisi dengan null)	Opsi untuk respons streaming. Hanya atur ini saat Anda mengatur `stream: true`.	Tidak.
└─ include_obfuscation	Boolean	Jika true, obfuscation streaming akan diaktifkan. Pengaburan streaming ditambahkan karakter acak ke `obfuscation` bidang pada peristiwa delta streaming ke menormalkan ukuran payload sebagai mitigasi terhadap serangan saluran samping tertentu. Bidang obfuscation ini disertakan secara default, tetapi menambahkan sejumlah kecil overhead ke aliran data. Anda dapat mengatur `include_obfuscation` ke false untuk mengoptimalkan bandwidth jika Anda mempercayai tautan jaringan antara aplikasi Anda dan OpenAI API.	Tidak.
structured_inputs	objek	Input terstruktur ke respons yang dapat berpartisipasi dalam penggantian templat perintah atau pengikatan argumen alat.	Tidak.
suhu	OpenAI.numeric (nullable)		Tidak.	1
kirim pesan teks	OpenAI.ResponseTextParam	Opsi konfigurasi untuk respons teks dari model. Bisa biasa teks atau data JSON terstruktur. Pelajari lebih lanjut: - Input dan output teks - Output Terstruktur	Tidak.
tool_choice	OpenAI.ToolChoiceOptions atau OpenAI.ToolChoiceParam		Tidak.
perangkat	OpenAI.ToolsArray	Sekumpulan alat yang dapat dipanggil model ketika menghasilkan respons. Anda dapat menentukan alat mana yang akan digunakan dengan mengatur `tool_choice` parameter . Kami mendukung kategori alat berikut: - Alat bawaan: Alat yang disediakan oleh OpenAI yang memperluas Kemampuan model, seperti Web Search atau pencarian file. Pelajari selengkapnya tentang alat bawaan. - Alat MCP: Integrasi dengan sistem pihak ketiga melalui server MCP kustom atau konektor yang telah ditentukan sebelumnya seperti Google Drive dan SharePoint. Pelajari selengkapnya tentang Alat MCP. - Panggilan fungsi (alat kustom): Fungsi yang ditentukan oleh Anda, memungkinkan model untuk memanggil kode Anda sendiri dengan argumen yang sangat ditik dan output. Pelajari selengkapnya tentang panggilan fungsi. Anda juga dapat menggunakan alat kustom untuk memanggil kode Anda sendiri.	Tidak.
top_logprobs	OpenAI.integer (dapat diakses dengan null)		Tidak.
top_p	OpenAI.numeric (nullable)		Tidak.	1
truncation	enum	Nilai yang mungkin: `auto`, `disabled`	Tidak.
pengguna	string (tidak digunakan lagi)	Bidang ini sedang digantikan oleh `safety_identifier` dan `prompt_cache_key`. Gunakan `prompt_cache_key` sebagai gantinya untuk mempertahankan pengoptimalan penembolokan. Pengidentifikasi yang stabil untuk pengguna akhir Anda. Digunakan untuk meningkatkan tingkat hit cache dengan membuat wadah permintaan serupa dengan lebih baik dan untuk membantu OpenAI mendeteksi dan mencegah penyalahgunaan. Pelajari lebih lanjut.	Tidak.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	OpenAI.Response
text/event-stream	OpenAI.CreateResponseStreamingResponse

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Mencantumkan respons

GET {endpoint}/openai/v1/responses

Mengembalikan daftar semua respons.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
limit	kueri	Tidak.	bilangan bulat	Batas jumlah objek yang akan dikembalikan. Batas dapat berkisar antara 1 dan 100, dan defaultnya adalah 20.
order	kueri	Tidak.	string Nilai yang mungkin: `asc`, `desc`	Urutkan urutan menurut `created_at` tanda waktu objek. `asc` untuk urutan naik dan`desc` untuk urutan turun.
after	kueri	Tidak.	string	Kursor untuk digunakan dalam penomoran halaman. `after` adalah ID objek yang menentukan tempat Anda dalam daftar. Misalnya, jika Anda membuat permintaan daftar dan menerima 100 objek, objek terakhir adalah obj_foo, Panggilan berikutnya dapat mencakup after=obj_foo untuk mendapatkan halaman berikutnya dari daftar.
sebelum	kueri	Tidak.	string	Kursor untuk digunakan dalam penomoran halaman. `before` adalah ID objek yang menentukan tempat Anda dalam daftar. Misalnya, jika Anda membuat permintaan daftar dan menerima 100 objek, objek terakhir adalah obj_foo, Panggilan berikutnya dapat mencakup before=obj_foo untuk menampilkan halaman sebelumnya dari daftar item.
agent_name	kueri	Tidak.	string	Filter berdasarkan nama agen. Jika disediakan, hanya item yang terkait dengan agen yang ditentukan yang akan dikembalikan.
agent_id	kueri	Tidak.	string	Filter menurut ID agen dalam format `name:version`. Jika disediakan, hanya item yang terkait dengan ID agen yang ditentukan yang akan dikembalikan.
conversation_id	kueri	Tidak.	string	Filter menurut ID percakapan. Jika disediakan, hanya respons yang terkait dengan percakapan yang ditentukan yang akan dikembalikan.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	objek	Data respons untuk daftar item yang diminta.

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Percakapan respons ringkas

POST {endpoint}/openai/v1/responses/compact

Menghasilkan pemadatan percakapan respons.

Isi Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan
Masukan	string atau array OpenAI.InputItem		Tidak.
instructions	string (dapat diakses NULL)		Tidak.
model	OpenAI.ModelIdsCompaction	ID model yang digunakan untuk menghasilkan respons, seperti `gpt-5` atau `o3`. OpenAI menawarkan berbagai model dengan kemampuan, karakteristik performa, dan titik harga yang berbeda. Lihat panduan model untuk menelusuri dan membandingkan model yang tersedia.	Yes
previous_response_id	string (dapat diakses NULL)		Tidak.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	OpenAI.CompactResource

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Dapatkan respons - dapatkan aliran respons

GET {endpoint}/openai/v1/responses/{response_id}

Mengambil respons model dengan ID yang diberikan. Mengambil respons model dengan ID yang diberikan (respons streaming).

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
response_id	path	Yes	string
include[]	kueri	Tidak.	array
aliran	kueri	Tidak.	Boolean
starting_after	kueri	Tidak.	bilangan bulat

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
Menerima	False	string Nilai yang mungkin: `text/event-stream`

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	OpenAI.Response
text/event-stream	OpenAI.CreateResponseStreamingResponse

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Hapus tanggapan

DELETE {endpoint}/openai/v1/responses/{response_id}

Menghapus respons model.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
response_id	path	Yes	string	ID respons untuk dihapus.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	DeleteResponseResult

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Batalkan respons

POST {endpoint}/openai/v1/responses/{response_id}/cancel

Membatalkan respons model.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
response_id	path	Yes	string	ID respons untuk dibatalkan.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	OpenAI.Response

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Mencantumkan item input

GET {endpoint}/openai/v1/responses/{response_id}/input_items

Mengembalikan daftar item input untuk respons tertentu.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
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 dan`desc` untuk urutan turun.
after	kueri	Tidak.	string	Kursor untuk digunakan dalam penomoran halaman. `after` adalah ID objek yang menentukan tempat Anda dalam daftar. Misalnya, jika Anda membuat permintaan daftar dan menerima 100 objek, objek terakhir adalah obj_foo, Panggilan berikutnya dapat mencakup after=obj_foo untuk mendapatkan halaman berikutnya dari daftar.
sebelum	kueri	Tidak.	string	Kursor untuk digunakan dalam penomoran halaman. `before` adalah ID objek yang menentukan tempat Anda dalam daftar. Misalnya, jika Anda membuat permintaan daftar dan menerima 100 objek, objek terakhir adalah obj_foo, Panggilan berikutnya dapat mencakup before=obj_foo untuk menampilkan halaman sebelumnya dari daftar item.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	objek	Data respons untuk daftar item yang diminta.

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Redteam

Redteams - daftar

GET {endpoint}/redTeams/runs?api-version=v1

Cantumkan tim merah berdasarkan nama.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
Foundry-Features	Benar	string Nilai yang mungkin: `RedTeams=V1Preview`	Keikutsertaan bendera fitur diperlukan saat menggunakan operasi pratinjau atau memodifikasi sumber daya pratinjau yang bertahan.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	PagedRedTeam

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	Azure. Core.Foundations.ErrorResponse

Header Respons:

Header	Tipe	Deskripsi
x-ms-error-code	string	Kode kesalahan string yang menunjukkan apa yang salah.

Redteams - dapatkan

GET {endpoint}/redTeams/runs/{name}?api-version=v1

Dapatkan nama tim merah.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.
Nama	path	Yes	string	Pengidentifikasi lari tim merah.

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
Foundry-Features	Benar	string Nilai yang mungkin: `RedTeams=V1Preview`	Keikutsertaan bendera fitur diperlukan saat menggunakan operasi pratinjau atau memodifikasi sumber daya pratinjau yang bertahan.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	RedTeam

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	Azure. Core.Foundations.ErrorResponse

Header Respons:

Header	Tipe	Deskripsi
x-ms-error-code	string	Kode kesalahan string yang menunjukkan apa yang salah.

Redteams - buat

POST {endpoint}/redTeams/runs:run?api-version=v1

Membuat redteam run.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
Foundry-Features	Benar	string Nilai yang mungkin: `RedTeams=V1Preview`	Keikutsertaan bendera fitur diperlukan saat menggunakan operasi pratinjau atau memodifikasi sumber daya pratinjau yang bertahan.

Isi Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan	Default
applicationScenario	string	Skenario aplikasi untuk operasi tim merah, untuk menghasilkan serangan khusus skenario.	Tidak.
attackStrategies	array AttackStrategy	Daftar strategi serangan atau daftar strategi serangan bersarang.	Tidak.
nama tampilan	string	Nama tim merah yang berjalan.	Tidak.
id	string (baca-saja)	Pengidentifikasi lari tim merah.	Yes
numTurns	bilangan bulat	Jumlah putaran simulasi.	Tidak.
properties	objek	Properti tim merah. Tidak seperti tag, properti bersifat add-only. Setelah ditambahkan, properti tidak dapat dihapus.	Tidak.
riskCategories	array RiskCategory	Daftar kategori risiko untuk menghasilkan tujuan serangan.	Tidak.
simulationOnly	Boolean	Simulasi saja atau Simulasi + Evaluasi. Default false, jika true pemindaian menghasilkan percakapan bukan hasil evaluasi.	Tidak.	False
status	string (baca-saja)	Status tim merah. Ini diatur oleh layanan dan hanya-baca.	Tidak.
tags	objek	Tag tim merah. Tidak seperti properti, tag sepenuhnya dapat diubah.	Tidak.
sasaran	TargetConfig	Kelas abstrak untuk konfigurasi target.	Yes
└─ jenis	string	Jenis konfigurasi model.	Yes

Responses

Kode Status: 201

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

Content-Type	Jenis	Deskripsi
application/json	RedTeam

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Jadwal

Jadwal - daftar

GET {endpoint}/schedules?api-version=v1

Cantumkan semua jadwal.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.
jenis	kueri	Tidak.	string Nilai yang mungkin: `Evaluation`, `Insight`	Filter menurut jenis jadwal.
enabled	kueri	Tidak.	Boolean	Filter berdasarkan status yang diaktifkan.

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
Foundry-Features	Benar	string Nilai yang mungkin: `Schedules=V1Preview`	Keikutsertaan bendera fitur diperlukan saat menggunakan operasi pratinjau atau memodifikasi sumber daya pratinjau yang bertahan.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	PagedSchedule

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	Azure. Core.Foundations.ErrorResponse

Header Respons:

Header	Tipe	Deskripsi
x-ms-error-code	string	Kode kesalahan string yang menunjukkan apa yang salah.

Jadwal - hapus

DELETE {endpoint}/schedules/{id}?api-version=v1

Menghapus jadwal.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.
id	path	Yes	string	Pengidentifikasi jadwal.

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
Foundry-Features	Benar	string Nilai yang mungkin: `Schedules=V1Preview`	Keikutsertaan bendera fitur diperlukan saat menggunakan operasi pratinjau atau memodifikasi sumber daya pratinjau yang bertahan.

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	Azure. Core.Foundations.ErrorResponse

Header Respons:

Header	Tipe	Deskripsi
x-ms-error-code	string	Kode kesalahan string yang menunjukkan apa yang salah.

Jadwal - dapatkan

GET {endpoint}/schedules/{id}?api-version=v1

Dapatkan jadwal berdasarkan id.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.
id	path	Yes	string	Pengidentifikasi jadwal.

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
Foundry-Features	Benar	string Nilai yang mungkin: `Schedules=V1Preview`	Keikutsertaan bendera fitur diperlukan saat menggunakan operasi pratinjau atau memodifikasi sumber daya pratinjau yang bertahan.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	Jadwal

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	Azure. Core.Foundations.ErrorResponse

Header Respons:

Header	Tipe	Deskripsi
x-ms-error-code	string	Kode kesalahan string yang menunjukkan apa yang salah.

Jadwal - membuat atau memperbarui

PUT {endpoint}/schedules/{id}?api-version=v1

Membuat atau memperbarui templat operasi.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.
id	path	Yes	string	Pengidentifikasi jadwal.

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
Foundry-Features	Benar	string Nilai yang mungkin: `Schedules=V1Preview`	Keikutsertaan bendera fitur diperlukan saat menggunakan operasi pratinjau atau memodifikasi sumber daya pratinjau yang bertahan.

Isi Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan
deskripsi	string	Deskripsi jadwal.	Tidak.
nama tampilan	string	Nama jadwal.	Tidak.
enabled	Boolean	Mengaktifkan status jadwal.	Yes
id	string (baca-saja)	Pengidentifikasi jadwal.	Yes
properties	objek	Properti jadwal. Tidak seperti tag, properti bersifat add-only. Setelah ditambahkan, properti tidak dapat dihapus.	Tidak.
status penyediaan	ScheduleProvisioningStatus (baca-saja)	Jadwalkan status penyediaan.	Tidak.
sistem Data	objek (baca-saja)	Metadata sistem untuk sumber daya.	Yes
tags	objek	Tag jadwal. Tidak seperti properti, tag sepenuhnya dapat diubah.	Tidak.
tugas	ScheduleTask	Jadwalkan model tugas.	Yes
└─ konfigurasi	objek	Konfigurasi untuk tugas tersebut.	Tidak.
└─ jenis	ScheduleTaskType	Jenis tugas.	Yes
pemicu	Trigger	Model dasar untuk Pemicu jadwal.	Yes
└─ jenis	TriggerType	Jenis pemicu.	Yes

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	Jadwal

Kode Status: 201

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

Content-Type	Jenis	Deskripsi
application/json	Jadwal

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	Azure. Core.Foundations.ErrorResponse

Header Respons:

Header	Tipe	Deskripsi
x-ms-error-code	string	Kode kesalahan string yang menunjukkan apa yang salah.

Jadwal - daftar berjalan

GET {endpoint}/schedules/{id}/runs?api-version=v1

Cantumkan semua jadwal eksekusi.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.
id	path	Yes	string	Pengidentifikasi jadwal.
jenis	kueri	Tidak.	string Nilai yang mungkin: `Evaluation`, `Insight`	Filter menurut jenis jadwal.
enabled	kueri	Tidak.	Boolean	Filter berdasarkan status yang diaktifkan.

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
Foundry-Features	Benar	string Nilai yang mungkin: `Schedules=V1Preview`	Keikutsertaan bendera fitur diperlukan saat menggunakan operasi pratinjau atau memodifikasi sumber daya pratinjau yang bertahan.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	PagedScheduleRun

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	Azure. Core.Foundations.ErrorResponse

Header Respons:

Header	Tipe	Deskripsi
x-ms-error-code	string	Kode kesalahan string yang menunjukkan apa yang salah.

Jadwal - jalankan

GET {endpoint}/schedules/{schedule_id}/runs/{run_id}?api-version=v1

Dapatkan jadwal yang dijalankan berdasarkan id.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string	Titik akhir Foundry Project dalam formulir "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Jika Anda hanya memiliki satu Project di Foundry Hub, atau untuk menargetkan Project default di Hub Anda, gunakan formulir "https://{ai-services-account-name}.services.ai. azure.com/api/proyek/_project"
schedule_id	path	Yes	string	Pengidentifikasi unik jadwal.
run_id	path	Yes	string	Pengidentifikasi unik dari eksekusi jadwal.
versi-API	kueri	Yes	string	Versi API yang digunakan untuk operasi ini.

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
Foundry-Features	Benar	string Nilai yang mungkin: `Schedules=V1Preview`	Keikutsertaan bendera fitur diperlukan saat menggunakan operasi pratinjau atau memodifikasi sumber daya pratinjau yang bertahan.

Responses

Kode Status: 200

Deskripsi: Permintaan telah berhasil.

Content-Type	Jenis	Deskripsi
application/json	ScheduleRun

Kode Status: default

Deskripsi: Respons kesalahan yang tidak terduga.

Content-Type	Jenis	Deskripsi
application/json	ApiErrorResponse

Komponen

A2APreviewTool

Agen yang mengimplementasikan protokol A2A.

Nama	Tipe	Deskripsi	Diperlukan
agent_card_path	string	Jalur ke kartu agen relatif terhadap `base_url`. Jika tidak disediakan, default ke `/.well-known/agent-card.json`	Tidak.
base_url	string	URL dasar agen.	Tidak.
project_connection_id	string	ID koneksi dalam project untuk server A2A. Koneksi menyimpan autentikasi dan detail koneksi lain yang diperlukan untuk terhubung ke server A2A.	Tidak.
jenis	enum	Jenis alat. Selalu `"a2a_preview`. Nilai yang mungkin: `a2a_preview`	Yes

AISearchIndexResource

Sumber daya Indeks Pencarian AI.

Nama	Tipe	Deskripsi	Diperlukan
filter	string	filter string untuk resource pencarian. Pelajari lebih lanjut di sini.	Tidak.
index_asset_id	string	Indeks id aset untuk resource pencarian.	Tidak.
nama indeks	string	Nama indeks dalam IndexResource yang dilampirkan ke agen ini.	Tidak.
project_connection_id	string	ID koneksi indeks dalam IndexResource yang dilampirkan ke agen ini.	Tidak.
jenis_kueri	AzureAISearchQueryType	Jenis kueri yang tersedia untuk alat Azure AI Search.	Tidak.
top_k	bilangan bulat	Jumlah dokumen yang akan diambil dari pencarian dan presentasi ke model.	Tidak.

AgentClusterInsightRequest

Wawasan tentang kumpulan Hasil Evaluasi Agen

Nama	Tipe	Deskripsi	Diperlukan
agen Nama	string	Pengidentifikasi untuk agen.	Yes
modelKonfigurasi	InsightModelConfiguration	Konfigurasi model yang digunakan dalam pembuatan wawasan.	Tidak.
└─ modelDeploymentName	string	Penyebaran model yang akan dievaluasi. Menerima nama penyebaran saja atau dengan nama koneksi sebagai `{connectionName}/<modelDeploymentName>`.	Yes
jenis	enum	Jenis permintaan. Nilai yang mungkin: `AgentClusterInsight`	Yes

AgentClusterInsightResult

Wawasan dari analisis kluster agen.

Nama	Tipe	Deskripsi	Diperlukan	Default
clusterInsight	ClusterInsightResult	Wawasan dari analisis kluster.	Yes
jenis	enum	Jenis hasil wawasan. Nilai yang mungkin: `AgentClusterInsight`	Yes

AgentContainerObject

Detail kontainer dari versi agen tertentu.

Nama	Tipe	Deskripsi	Diperlukan
container	ContainerDetails (baca-saja)	Informasi terperinci tentang kontainer.	Tidak.
└─ health_state	string	Status kesehatan kontainer.	Yes
└─ provisioning_error	string	Kesalahan provisi kontainer, jika ada.	Tidak.
└─ provisioning_state	string	Status provisi kontainer.	Yes
└─ replika	array ContainerReplica	Daftar replika dalam kontainer.	Yes
└─ status	string	Keadaan kontainer.	Yes
└─ updated_on	string	Waktu pembaruan terakhir kontainer.	Yes
dibuat_pada	string	Waktu pembuatan kontainer.	Yes
error_message	string (baca-saja)	Pesan kesalahan jika kontainer gagal beroperasi, jika ada.	Tidak.
id	string (baca-saja)	Pengidentifikasi kontainer.	Tidak.
max_replicas	bilangan bulat	Jumlah maksimum replika untuk kontainer. Pengaturan awal adalah 1.	Tidak.
min_replicas	bilangan bulat	Jumlah minimum replika untuk kontainer. Pengaturan awal adalah 1.	Tidak.
objek	enum	Jenis objek, yang selalu 'agent.container'. Nilai yang mungkin: `agent.container`	Yes
status	AgentContainerStatus (baca-saja)	Status kontainer dari versi agen tertentu.	Yes
updated_at	string	Waktu pembaruan terakhir kontainer.	Yes

AgentContainerOperationError

Detail kesalahan operasi kontainer, jika ada.

Nama	Tipe	Deskripsi	Diperlukan
kode	string	Kode kesalahan operasi kontainer, jika ada.	Yes
pesan	string	Pesan kesalahan operasi kontainer, jika ada.	Yes
jenis	string	Jenis kesalahan operasi kontainer, jika ada.	Yes

AgentContainerOperationObject

Operasi kontainer untuk versi agen tertentu.

Nama	Tipe	Deskripsi	Diperlukan
agent_id	string	ID agen.	Yes
agent_version_id	string	ID versi agen.	Yes
container	AgentContainerObject	Detail kontainer dari versi agen tertentu.	Tidak.
└─ kontainer	ContainerDetails (baca-saja)	Informasi kontainer terperinci.	Tidak.
└─ dibuat_pada	string (baca-saja)	Waktu pembuatan kontainer.	Yes
└─ error_message	string (baca-saja)	Pesan kesalahan jika kontainer gagal beroperasi, jika ada.	Tidak.
└─ ID	string (baca-saja)	Pengidentifikasi kontainer.	Tidak.
└─ max_replicas	bilangan bulat	Jumlah maksimum replika untuk kontainer. Pengaturan awal adalah 1.	Tidak.
└─ min_replicas	bilangan bulat	Jumlah minimum replika untuk kontainer. Pengaturan awal adalah 1.	Tidak.
└─ objek	enum	Jenis objek, yang selalu 'agent.container'. Nilai yang mungkin: `agent.container`	Yes
└─ status	AgentContainerStatus (baca-saja)	Status kontainer dari versi agen tertentu.	Yes
└─ updated_at	string (baca-saja)	Waktu pembaruan terakhir kontainer.	Yes
galat	AgentContainerOperationError	Detail kesalahan operasi kontainer, jika ada.	Tidak.
└─ kode	string	Kode kesalahan operasi kontainer, jika ada.	Yes
└─ pesan	string	Pesan kesalahan operasi kontainer, jika ada.	Yes
└─ jenis	string	Jenis kesalahan operasi kontainer, jika ada.	Yes
id	string	ID operasi kontainer. Id ini adalah pengidentifikasi unik di seluruh sistem.	Yes
status	AgentContainerOperationStatus	Status operasi kontainer untuk versi agen tertentu.	Yes

AgentContainerOperationStatus

Status operasi kontainer untuk versi agen tertentu.

Harta benda	Nilai
Jenis	string
Nilai	`NotStarted` `InProgress` `Succeeded` `Failed`

AgentContainerStatus

Status kontainer dari versi agen tertentu.

Harta benda	Nilai
Jenis	string
Nilai	`Starting` `Running` `Stopping` `Stopped` `Failed` `Deleting` `Deleted` `Updating`

AgentDefinition

Diskriminator untuk AgentDefinition

Komponen ini menggunakan properti kind untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
`prompt`	PromptAgentDefinition
`workflow`	WorkflowAgentDefinition
`hosted`	HostedAgentDefinition
`container_app`	ContainerAppAgentDefinition

Nama	Tipe	Deskripsi	Diperlukan
jenis	AgentKind		Yes
rai_config	RaiConfig	Konfigurasi untuk fitur pemfilteran konten dan keamanan AI yang Bertanggung Jawab (RAI).	Tidak.
└─ rai_policy_name	string	Nama polis RAI yang akan diterapkan.	Yes

AgentKind

Harta benda	Nilai
Jenis	string
Nilai	`prompt` `hosted` `container_app` `workflow`

AgentObject

Nama	Tipe	Deskripsi	Diperlukan
id	string	Pengidentifikasi unik agen.	Yes
Nama	string	Nama agen. Batasan: maxLength: 63	Yes
objek	enum	Jenis objek, yang selalu 'agen'. Nilai yang mungkin: `agent`	Yes
versions	objek	Versi terbaru dari agen.	Yes
└─ terbaru	AgentVersionObject		Yes

AgentProtocol

Harta benda	Nilai
Jenis	string
Nilai	`activity_protocol` `responses`

Referensi Agen

Nama	Tipe	Deskripsi	Diperlukan
Nama	string	Nama agen. Batasan: maxLength: 256	Yes
jenis	enum	Nilai yang mungkin: `agent_reference`	Yes
versi	string	Pengidentifikasi versi agen.	Tidak.

AgentTaxonomyInput

Konfigurasi input untuk taksonomi evaluasi ketika jenis input adalah agen.

Nama	Tipe	Deskripsi	Diperlukan
riskCategories	array RiskCategory	Daftar kategori risiko untuk dievaluasi.	Yes
sasaran	Target	Kelas dasar untuk target dengan dukungan diskriminator.	Yes
└─ jenis	string	Jenis target.	Yes
jenis	enum	Jenis input taksonomi evaluasi. Nilai yang mungkin: `agent`	Yes

AgentTaxonomyInputUpdate

Konfigurasi input untuk taksonomi evaluasi ketika jenis input adalah agen.

Nama	Tipe	Deskripsi	Diperlukan
riskCategories	array RiskCategory	Daftar kategori risiko untuk dievaluasi.	Tidak.
sasaran	TargetUpdate	Kelas dasar untuk target dengan dukungan diskriminator.	Tidak.
└─ jenis	string	Jenis target.	Yes
jenis	enum	Jenis input taksonomi evaluasi. Nilai yang mungkin: `agent`	Yes

AgentVersionObject

Nama	Tipe	Deskripsi	Diperlukan
dibuat_pada	bilangan bulat	Stempel waktu Unix (detik) saat agen dibuat.	Yes
definisi	AgentDefinition		Yes
deskripsi	string	Deskripsi agen yang dapat dibaca manusia. Batasan: maxLength: 512	Tidak.
id	string	Pengidentifikasi unik versi agen.	Yes
metadata	objek (nullable)	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini bisa berguna untuk menyimpan informasi tambahan tentang objek dalam terstruktur pemformatan dan pengambilan kueri untuk 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 agen. Nama dapat digunakan untuk mengambil/memperbarui/menghapus agen. Batasan: maxLength: 256	Yes
objek	enum	Jenis objek, yang selalu 'agent.version'. Nilai yang mungkin: `agent.version`	Yes
versi	string	Pengidentifikasi versi agen. Agen tidak dapat diubah dan setiap pembaruan membuat versi baru sambil menjaga nama tetap sama.	Yes

AgenticIdentityPreviewCredentials

Definisi kredensial identitas agen

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	enum	Jenis kredensial Nilai yang mungkin: `AgenticIdentityToken_Preview`	Yes

ApiErrorResponse

Respons kesalahan untuk kegagalan API.

Nama	Tipe	Deskripsi	Diperlukan	Default
galat	OpenAI.Error		Yes

ApiKeyCredentials

Definisi Kredensial Kunci API

Nama	Tipe	Deskripsi	Diperlukan	Default
kunci	string (baca-saja)	Kunci API	Tidak.
jenis	enum	Jenis kredensial Nilai yang mungkin: `ApiKey`	Yes

AssetCredentialResponse

Mewakili referensi ke blob untuk dikonsumsi

Nama	Tipe	Deskripsi	Diperlukan
blobReference	BlobReference	Detail referensi blob.	Yes
└─ blobUri	string	Jalur URI blob bagi klien untuk mengunggah data. Contoh: `https://blob.windows.core.net/Container/Path`	Yes
└─ kredensial	SasCredential	Info kredensial untuk access akun storage.	Yes
└─ penyimpananAkunArmId	string	ID ARM dari akun storage yang akan digunakan.	Yes

AssetId

Pengidentifikasi aset yang disimpan.

Jenis: teks

AttackStrategy

Strategi untuk serangan.

Harta benda	Nilai
Deskripsi	Strategi untuk serangan.
Jenis	string
Nilai	`easy` `moderate` `difficult` `ascii_art` `ascii_smuggler` `atbash` `base64` `binary` `caesar` `character_space` `jailbreak` `ansi_attack` `character_swap` `suffix_append` `string_join` `unicode_confusable` `unicode_substitution` `diacritic` `flip` `leetspeak` `rot13` `morse` `url` `baseline` `indirect_jailbreak` `tense` `multi_turn` `crescendo`

Azure. Core.Foundations.Error

Objek kesalahan.

Nama	Tipe	Deskripsi	Diperlukan
kode	string	Salah satu sekumpulan kode kesalahan yang ditentukan server.	Yes
details	array Azure. Core.Foundations.Error	Array detail tentang kesalahan tertentu yang menyebabkan kesalahan yang dilaporkan ini.	Tidak.
innererror	Azure. Core.Foundations.InnerError	Objek yang berisi informasi yang lebih spesifik tentang kesalahan. Sesuai Azure pedoman REST API - https://aka.ms/AzureRestApiGuidelines#handling-errors.	Tidak.
└─ kode	string	Salah satu sekumpulan kode kesalahan yang ditentukan server.	Tidak.
└─ kesalahan batin	Azure. Core.Foundations.InnerError	Kesalahan dalam.	Tidak.
pesan	string	Representasi kesalahan yang dapat dibaca manusia.	Yes
sasaran	string	Target kesalahan.	Tidak.

Azure. Core.Foundations.ErrorResponse

Respons yang berisi detail kesalahan.

Nama	Tipe	Deskripsi	Diperlukan
galat	Azure. Core.Foundations.Error	Objek kesalahan.	Yes
└─ kode	string	Salah satu sekumpulan kode kesalahan yang ditentukan server.	Yes
└─ detail	array Azure. Core.Foundations.Error	Array detail tentang kesalahan tertentu yang menyebabkan kesalahan yang dilaporkan ini.	Tidak.
└─ kesalahan batin	Azure. Core.Foundations.InnerError	Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan.	Tidak.
└─ pesan	string	Representasi kesalahan yang dapat dibaca manusia.	Yes
└─ target	string	Target kesalahan.	Tidak.

Azure. Core.Foundations.InnerError

Objek yang berisi informasi yang lebih spesifik tentang kesalahan. Sesuai Azure pedoman REST API - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nama	Tipe	Deskripsi	Diperlukan
kode	string	Salah satu sekumpulan kode kesalahan yang ditentukan server.	Tidak.
innererror	Azure. Core.Foundations.InnerError	Objek yang berisi informasi yang lebih spesifik tentang kesalahan. Sesuai Azure pedoman REST API - https://aka.ms/AzureRestApiGuidelines#handling-errors.	Tidak.
└─ kode	string	Salah satu sekumpulan kode kesalahan yang ditentukan server.	Tidak.
└─ kesalahan batin	Azure. Core.Foundations.InnerError	Kesalahan dalam.	Tidak.

Azure. Core.Foundations.OperationState

Enum yang menjelaskan status operasi yang diizinkan.

Harta benda	Nilai
Deskripsi	Enum yang menjelaskan status operasi yang diizinkan.
Jenis	string
Nilai	`NotStarted` `Running` `Succeeded` `Failed` `Canceled`

Azure. Inti.uuid

Pengidentifikasi Unik Universal

Jenis: teks

Format: uuid

AzureAIAgentTarget

Mewakili target yang menentukan agen AI Azure.

Nama	Tipe	Deskripsi	Diperlukan
Nama	string	Pengidentifikasi unik agen Azure AI.	Yes
tool_descriptions	array ToolDescription	Parameter yang digunakan untuk mengontrol perilaku pengambilan sampel agen selama pembuatan teks.	Tidak.
jenis	enum	Jenis target, selalu `azure_ai_agent`. Nilai yang mungkin: `azure_ai_agent`	Yes
versi	string	Versi agen Azure AI.	Tidak.

AzureAIAgentTargetUpdate

Mewakili target yang menentukan agen AI Azure.

Nama	Tipe	Deskripsi	Diperlukan
Nama	string	Pengidentifikasi unik agen Azure AI.	Tidak.
tool_descriptions	array ToolDescription	Parameter yang digunakan untuk mengontrol perilaku pengambilan sampel agen selama pembuatan teks.	Tidak.
jenis	enum	Jenis target, selalu `azure_ai_agent`. Nilai yang mungkin: `azure_ai_agent`	Yes
versi	string	Versi agen Azure AI.	Tidak.

AzureAIDataSourceConfig

Nama	Tipe	Deskripsi	Diperlukan
skenario	enum	Skenario skema data. Nilai yang mungkin: `red_team`, `responses`, `traces_preview`, `synthetic_data_gen_preview`	Yes
skema	objek	Skema JSON objek keseluruhan untuk item sumber data yang dijalankan.	Yes
jenis	enum	Tipe objek, yang selalu `azure_ai_source`. Nilai yang mungkin: `azure_ai_source`	Yes

AzureAIModelTarget

Mewakili target yang menentukan model AI Azure untuk operasi yang memerlukan pemilihan model.

Nama	Tipe	Deskripsi	Diperlukan
model	string	Pengidentifikasi unik model Azure AI.	Tidak.
sampling_params	ModelSamplingParams	Mewakili sekumpulan parameter yang digunakan untuk mengontrol perilaku pengambilan sampel model bahasa selama pembuatan teks.	Tidak.
└─ max_completion_tokens	bilangan bulat	Jumlah maksimum token yang diizinkan dalam penyelesaian.	Yes
└─ benih	bilangan bulat	Benih acak untuk reproduksi.	Yes
└─ suhu	nomor/angka	Parameter suhu untuk pengambilan sampel.	Yes
└─ top_p	nomor/angka	Parameter top-p untuk pengambilan sampel nukleus.	Yes
jenis	enum	Jenis target, selalu `azure_ai_model`. Nilai yang mungkin: `azure_ai_model`	Yes

AzureAIModelTargetUpdate

Mewakili target yang menentukan model AI Azure untuk operasi yang memerlukan pemilihan model.

Nama	Tipe	Deskripsi	Diperlukan
model	string	Pengidentifikasi unik model Azure AI.	Tidak.
sampling_params	ModelSamplingParamsUpdate	Mewakili sekumpulan parameter yang digunakan untuk mengontrol perilaku pengambilan sampel model bahasa selama pembuatan teks.	Tidak.
└─ max_completion_tokens	bilangan bulat	Jumlah maksimum token yang diizinkan dalam penyelesaian.	Tidak.
└─ benih	bilangan bulat	Benih acak untuk reproduksi.	Tidak.
└─ suhu	nomor/angka	Parameter suhu untuk pengambilan sampel.	Tidak.
└─ top_p	nomor/angka	Parameter top-p untuk pengambilan sampel nukleus.	Tidak.
jenis	enum	Jenis target, selalu `azure_ai_model`. Nilai yang mungkin: `azure_ai_model`	Yes

AzureAIResponsesEvalRunDataSource

Mewakili sumber data untuk eksekusi evaluasi yang khusus untuk skenario Evaluasi Berkelanjutan.

Nama	Tipe	Deskripsi	Diperlukan
event_configuration_id	string	Nama konfigurasi peristiwa yang terkait dengan eksekusi evaluasi ini.	Yes
item_generation_params	ResponseRetrievalItemGenerationParams	Mewakili parameter untuk pembuatan item pengambilan respons.	Yes
└─ data_mapping	objek	Pemetaan dari bidang sumber ke bidang response_id, diperlukan untuk mengambil riwayat obrolan.	Yes
└─ max_num_turns	bilangan bulat	Jumlah maksimum giliran riwayat obrolan untuk dievaluasi.	Yes
└─ sumber	OpenAI.EvalJsonlFileContentSource atau OpenAI.EvalJsonlFileIdSource	Sumber dari mana konten JSONL dibaca.	Yes
└─ jenis	enum	Jenis parameter pembuatan item, selalu `response_retrieval`. Nilai yang mungkin: `response_retrieval`	Yes
max_runs_hourly	bilangan bulat	Jumlah maksimum eksekusi evaluasi yang diizinkan per jam.	Yes
jenis	enum	Jenis sumber data, selalu `azure_ai_responses`. Nilai yang mungkin: `azure_ai_responses`	Yes

Indeks Pencarian AzureAI

Definisi Indeks Azure AI Search

Nama	Tipe	Deskripsi	Diperlukan
id	string (baca-saja)	ID Aset, ID unik untuk aset	Tidak.
Nama	string (baca-saja)	Nama sumber daya	Yes
jenis	enum	Jenis indeks Nilai yang mungkin: `AzureSearch`	Yes
versi	string (baca-saja)	Versi sumber daya	Yes

AzureAISearchIndexUpdate

Definisi Indeks Azure AI Search

Nama	Tipe	Deskripsi	Diperlukan
deskripsi	string	Teks deskripsi aset.	Tidak.
tags	objek	Kamus tag. Tag dapat ditambahkan, dihapus, dan diperbarui.	Tidak.
jenis	enum	Jenis indeks Nilai yang mungkin: `AzureSearch`	Yes

AzureAISearchQueryType

Jenis kueri yang tersedia untuk alat Azure AI Search.

Harta benda	Nilai
Deskripsi	Jenis kueri yang tersedia untuk alat Azure AI Search.
Jenis	string
Nilai	`simple` `semantic` `vector` `vector_simple_hybrid` `vector_semantic_hybrid`

AzureAISearchTool

Informasi definisi input untuk alat Azure AI search seperti yang digunakan untuk mengonfigurasi agen.

Nama	Tipe	Deskripsi	Diperlukan
azure_ai_search	AzureAISearchToolResource	Sekumpulan sumber daya indeks yang digunakan oleh alat `azure_ai_search`.	Yes
└─ indeks	array AISearchIndexResource	Indeks yang melekat pada agen ini. Mungkin ada maksimal 1 indeks sumber daya yang dilampirkan ke agen. Batasan: maxItems: 1	Yes
jenis	enum	Jenis objek, yang selalu 'azure_ai_search'. Nilai yang mungkin: `azure_ai_search`	Yes

AzureAISearchToolResource

Sekumpulan sumber daya indeks yang digunakan oleh alat azure_ai_search.

Nama	Tipe	Deskripsi	Diperlukan	Default
Indeks	array AISearchIndexResource	Indeks yang melekat pada agen ini. Mungkin ada maksimal 1 indeks sumber daya yang dilampirkan ke agen.	Yes

AzureFunctionBinding

Struktur untuk menyimpan nama antrean storage dan URI.

Nama	Tipe	Deskripsi	Diperlukan
storage_queue	AzureFunctionStorageQueue	Struktur untuk menyimpan nama antrean storage dan URI.	Yes
└─ queue_name	string	Nama antrean storage fungsi Azure.	Yes
└─ queue_service_endpoint	string	URI ke layanan Antrean Azure Storage yang memungkinkan Anda memanipulasi antrean.	Yes
jenis	enum	Jenis pengikatan, yang selalu 'storage_queue'. Nilai yang mungkin: `storage_queue`	Yes

AzureFunctionDefinition

Definisi fungsi Azure.

Nama	Tipe	Deskripsi	Diperlukan
fungsi	objek	Definisi fungsi azure dan parameternya.	Yes
└─ deskripsi	string	Deskripsi tentang apa yang dilakukan fungsi, digunakan oleh model untuk memilih kapan dan bagaimana memanggil fungsi.	Tidak.
└─ nama	string	Nama fungsi yang akan dipanggil.	Yes
└─ parameter	objek	Parameter yang diterima fungsi, dijelaskan sebagai objek Skema JSON.	Yes
input_binding	AzureFunctionBinding	Struktur untuk menyimpan nama antrean storage dan URI.	Yes
└─ storage_queue	AzureFunctionStorageQueue	Storage queue.	Yes
└─ jenis	enum	Jenis pengikatan, yang selalu 'storage_queue'. Nilai yang mungkin: `storage_queue`	Yes
output_binding	AzureFunctionBinding	Struktur untuk menyimpan nama antrean storage dan URI.	Yes
└─ storage_queue	AzureFunctionStorageQueue	Storage queue.	Yes
└─ jenis	enum	Jenis pengikatan, yang selalu 'storage_queue'. Nilai yang mungkin: `storage_queue`	Yes

AzureFunctionStorageQueue

Struktur untuk menyimpan nama antrean storage dan URI.

Nama	Tipe	Deskripsi	Diperlukan	Default
queue_name	string	Nama antrean storage fungsi Azure.	Yes
queue_service_endpoint	string	URI ke layanan Antrean Azure Storage yang memungkinkan Anda memanipulasi antrean.	Yes

AzureFunctionTool

Informasi definisi input untuk Azure Function Tool, seperti yang digunakan untuk mengonfigurasi Agen.

Nama	Tipe	Deskripsi	Diperlukan
azure_function	AzureFunctionDefinition	Definisi fungsi Azure.	Yes
Fungsi └─	objek	Definisi fungsi azure dan parameternya.	Yes
└─ deskripsi	string	Deskripsi tentang apa yang dilakukan fungsi, digunakan oleh model untuk memilih kapan dan bagaimana memanggil fungsi.	Tidak.
└─ nama	string	Nama fungsi yang akan dipanggil.	Yes
└─ parameter	objek	Parameter yang diterima fungsi, dijelaskan sebagai objek Skema JSON.	Yes
└─ input_binding	AzureFunctionBinding	Antrean storage input. Pemicu storage antrean menjalankan fungsi saat pesan ditambahkan ke dalamnya.	Yes
└─ output_binding	AzureFunctionBinding	Antrean storage keluaran. Fungsi menulis output ke antrean ini ketika item input diproses.	Yes
jenis	enum	Jenis objek, yang selalu 'browser_automation'. Nilai yang mungkin: `azure_function`	Yes

AzureOpenAIModelConfiguration

Konfigurasi model Azure OpenAI. Versi API akan dipilih oleh layanan untuk mengkueri model.

Nama	Tipe	Deskripsi	Diperlukan	Default
modelDeploymentName	string	Nama penyebaran untuk model AOAI. Contoh: gpt-4o jika dalam AIServices atau berbasis `connection_name/deployment_name` koneksi (misalnya `my-aoai-connection/gpt-4o`).	Yes
jenis	enum	Nilai yang mungkin: `AzureOpenAIModel`	Yes

BaseCredentials

Kelas dasar untuk kredensial koneksi

Diskriminator untuk BaseCredentials

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
`ApiKey`	ApiKeyCredentials
`AAD`	EntraIDCredentials
`CustomKeys`	CustomCredential
`SAS`	SASCredentials
`None`	NoAuthenticationCredentials
`AgenticIdentityToken_Preview`	AgenticIdentityPreviewCredentials

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	CredentialType (baca-saja)	Jenis kredensial yang digunakan oleh koneksi	Yes

BingCustomSearchConfiguration

Konfigurasi pencarian kustom bing.

Nama	Tipe	Deskripsi	Diperlukan
jumlah	bilangan bulat	Jumlah hasil penelusuran yang akan ditampilkan dalam respons bing api	Tidak.
freshness	string	Filter hasil pencarian berdasarkan rentang waktu tertentu. Lihat nilai diterima di sini.	Tidak.
instance_name	string	Nama instans konfigurasi kustom yang diberikan untuk konfigurasi.	Yes
pasar	string	Pasar dari mana hasilnya berasal.	Tidak.
project_connection_id	string	ID koneksi Project untuk pembumian dengan pencarian bing	Yes
set_lang	string	Bahasa yang akan digunakan untuk string antarmuka pengguna saat memanggil Bing API.	Tidak.

BingCustomSearchPreviewTool

Informasi definisi input untuk alat pencarian kustom Bing seperti yang digunakan untuk mengonfigurasi agen.

Nama	Tipe	Deskripsi	Diperlukan
bing_custom_search_preview	BingCustomSearchToolParameters	Parameter alat pencarian kustom bing.	Yes
└─ search_configurations	array BingCustomSearchConfiguration	Koneksi project yang terpasang pada alat ini. Mungkin ada maksimal 1 koneksi sumber daya yang dilampirkan ke alat. Batasan: maxItems: 1	Yes
jenis	enum	Jenis objek, yang selalu 'bing_custom_search_preview'. Nilai yang mungkin: `bing_custom_search_preview`	Yes

BingCustomSearchToolParameters

Parameter alat pencarian kustom bing.

Nama	Tipe	Deskripsi	Diperlukan	Default
search_configurations	array BingCustomSearchConfiguration	Koneksi project yang terpasang pada alat ini. Mungkin ada maksimal 1 koneksi sumber daya yang dilampirkan ke alat.	Yes

BingGroundingSearchConfiguration

Konfigurasi pencarian untuk Bing Grounding

Nama	Tipe	Deskripsi	Diperlukan
jumlah	bilangan bulat	Jumlah hasil penelusuran yang akan ditampilkan dalam respons bing api	Tidak.
freshness	string	Filter hasil pencarian berdasarkan rentang waktu tertentu. Lihat nilai diterima di sini.	Tidak.
pasar	string	Pasar dari mana hasilnya berasal.	Tidak.
project_connection_id	string	ID koneksi Project untuk pembumian dengan pencarian bing	Yes
set_lang	string	Bahasa yang akan digunakan untuk string antarmuka pengguna saat memanggil Bing API.	Tidak.

BingGroundingSearchToolParameters

Parameter alat pencarian bing grounding.

Nama	Tipe	Deskripsi	Diperlukan	Default
search_configurations	array BingGroundingSearchConfiguration	Konfigurasi pencarian yang dilampirkan ke alat ini. Mungkin ada maksimal 1 sumber daya konfigurasi pencarian yang dilampirkan ke alat.	Yes

BingGroundingTool

Informasi definisi input untuk alat pencarian bing grounding seperti yang digunakan untuk mengonfigurasi agen.

Nama	Tipe	Deskripsi	Diperlukan
bing_grounding	BingGroundingSearchToolParameters	Parameter alat pencarian bing grounding.	Yes
└─ search_configurations	array BingGroundingSearchConfiguration	Konfigurasi pencarian yang dilampirkan ke alat ini. Mungkin ada maksimal 1 sumber daya konfigurasi pencarian yang dilampirkan ke alat. Batasan: maxItems: 1	Yes
jenis	enum	Jenis objek, yang selalu 'bing_grounding'. Nilai yang mungkin: `bing_grounding`	Yes

BlobReference

Detail referensi blob.

Nama	Tipe	Deskripsi	Diperlukan
gumpalanUri	string	Jalur URI blob bagi klien untuk mengunggah data. Contoh: `https://blob.windows.core.net/Container/Path`	Yes
credential	SasCredential	Definisi Kredensial SAS	Yes
└─ sasUri	string (baca-saja)	SAS uri	Yes
└─ jenis	enum	Jenis kredensial Nilai yang mungkin: `SAS`	Yes
storageAccountArmId	string	ID ARM dari akun storage yang akan digunakan.	Yes

BrowserAutomationPreviewTool

Informasi definisi input untuk Alat Otomatisasi Browser, seperti yang digunakan untuk mengonfigurasi Agen.

Nama	Tipe	Deskripsi	Diperlukan
browser_automation_preview	BrowserAutomationToolParameters	Definisi parameter input untuk Alat Otomatisasi Browser.	Yes
└─ koneksi	BrowserAutomationToolConnectionParameters	Parameter koneksi project yang terkait dengan Alat Otomatisasi Browser.	Yes
jenis	enum	Jenis objek, yang selalu 'browser_automation_preview'. Nilai yang mungkin: `browser_automation_preview`	Yes

BrowserAutomationToolConnectionParameters

Definisi parameter input untuk koneksi yang digunakan oleh Alat Otomatisasi Browser.

Nama	Tipe	Deskripsi	Diperlukan	Default
project_connection_id	string	ID koneksi project ke sumber daya Playwright Azure Anda.	Yes

BrowserAutomationToolParameters

Definisi parameter input untuk Alat Otomatisasi Browser.

Nama	Tipe	Deskripsi	Diperlukan	Default
koneksi	BrowserAutomationToolConnectionParameters	Definisi parameter input untuk koneksi yang digunakan oleh Alat Otomatisasi Browser.	Yes
└─ project_connection_id	string	ID koneksi project ke sumber daya Playwright Azure Anda.	Yes

CaptureStructuredOutputsTool

Alat untuk menangkap output terstruktur

Nama	Tipe	Deskripsi	Diperlukan
Keluaran	StructuredOutputDefinition	Output terstruktur yang dapat diproduksi oleh agen.	Yes
└─ deskripsi	string	Deskripsi output yang akan dipancarkan. Digunakan oleh model untuk menentukan kapan harus memancarkan output.	Yes
└─ nama	string	Nama output terstruktur.	Yes
└─ skema	objek	Skema JSON untuk output terstruktur.	Yes
└─ ketat	Boolean (dapat diberisi dengan null)	Apakah akan memberlakukan validasi yang ketat. Bawaan `true`.	Yes
jenis	enum	Jenis alat. Selalu `capture_structured_outputs`. Nilai yang mungkin: `capture_structured_outputs`	Yes

ChartCoordinate

Koordinat untuk bagan analisis.

Nama	Tipe	Deskripsi	Diperlukan
ukuran	bilangan bulat	Ukuran elemen bagan.	Yes
x	bilangan bulat	Koordinat sumbu X.	Yes
y	bilangan bulat	Koordinat sumbu Y.	Yes

ChatSummaryMemoryItem

Item memori yang berisi ringkasan yang diekstrak dari percakapan.

Nama	Tipe	Deskripsi	Diperlukan
isi	string	Isi memori.	Yes
jenis	enum	Jenis item memori. Nilai yang mungkin: `chat_summary`	Yes
memory_id	string	ID unik item memori.	Yes
cakupan	string	Namespace yang secara logis mengelompokkan dan mengisolasi memori, seperti ID pengguna.	Yes
updated_at	bilangan bulat	Waktu pembaruan terakhir item memori.	Yes

ClusterInsightResult

Wawasan dari analisis kluster.

Nama	Tipe	Deskripsi	Diperlukan
clusters	array InsightCluster	Daftar kluster yang diidentifikasi dalam wawasan.	Yes
koordinat	objek	Pemetaan ID opsional ke koordinat 2D yang digunakan oleh UX untuk visualisasi. Kunci peta adalah pengidentifikasi string (misalnya, id kluster atau id sampel) dan nilainya adalah koordinat dan ukuran visual untuk penyajian pada bagan 2D. Properti ini dihilangkan kecuali klien meminta koordinat (misalnya, dengan meneruskan `includeCoordinates=true` sebagai parameter kueri). Contoh: `<br> {<br> "cluster-1": { "x": 12, "y": 34, "size": 8 },<br> "sample-123": { "x": 18, "y": 22, "size": 4 }<br> }<br>` Koordinat hanya ditujukan untuk visualisasi sisi klien dan tidak ubah hasil wawasan kanonis.	Tidak.
summary	InsightSummary	Ringkasan analisis kluster kesalahan.	Yes
└─ metode	string	Metode yang digunakan untuk pengelompokan.	Yes
└─ sampleCount	bilangan bulat	Jumlah total sampel yang dianalisis.	Yes
└─ uniqueClusterCount	bilangan bulat	Jumlah total kluster unik.	Yes
└─ unikSubclusterCount	bilangan bulat	Jumlah total label subkluster unik.	Yes
└─ penggunaan	ClusterTokenUsage	Penggunaan token saat melakukan analisis pengelompokan	Yes

ClusterTokenUsage

Penggunaan token untuk analisis kluster

Nama	Tipe	Deskripsi	Diperlukan
inputTokenUsage	bilangan bulat	penggunaan token input	Yes
outputTokenUsage	bilangan bulat	Penggunaan token keluaran	Yes
totalTokenUsage	bilangan bulat	Total penggunaan token	Yes

CodeBasedEvaluatorDefinition

Definisi evaluator berbasis kode menggunakan kode python

Nama	Tipe	Deskripsi	Diperlukan
code_text	string	Teks kode sebaris untuk evaluator	Yes
data_schema	objek	Skema JSON (Draf 2020-12) untuk data input evaluator. Ini termasuk parameter seperti jenis, properti, diperlukan.	Tidak.
init_parameters	objek	Skema JSON (Draf 2020-12) untuk parameter input evaluator. Ini termasuk parameter seperti jenis, properti, diperlukan.	Tidak.
metrik	objek	Daftar metrik output yang dihasilkan oleh evaluator ini	Tidak.
jenis	enum	Nilai yang mungkin: `code`	Yes

CompletionMessageToolCallChunk

Detail panggilan alat dalam pesan.

Nama	Tipe	Deskripsi	Diperlukan
fungsi	FunctionToolCall	Detail panggilan alat fungsi.	Tidak.
└─ argumen-argumen	string	Argumen untuk memanggil fungsi dengan, seperti yang dihasilkan oleh model dalam format JSON.	Yes
└─ nama	string	Nama fungsi yang akan dipanggil.	Yes
id	string	Id untuk panggilan alat.	Yes
jenis	enum	Jenis panggilan alat, yang selalu "fungsi". Nilai yang mungkin: `function`	Yes

Koneksi

Respons dari daftar dan dapatkan operasi koneksi

Nama	Tipe	Deskripsi	Diperlukan
kredensial	BaseCredentials (baca-saja)	Kelas dasar untuk kredensial koneksi	Yes
└─ jenis	CredentialType (baca-saja)	Jenis kredensial yang digunakan oleh koneksi	Yes
id	string (baca-saja)	Pengidentifikasi unik untuk koneksi, yang dihasilkan oleh layanan	Yes
adalah default	boolean (baca-saja)	Apakah koneksi ditandai sebagai koneksi default dari jenisnya	Yes
metadata	objek (baca-saja)	Metadata koneksi	Yes
Nama	string (baca-saja)	Nama koneksi yang ramah, disediakan oleh pengguna.	Yes
sasaran	string (baca-saja)	URL koneksi yang akan digunakan untuk layanan ini	Yes
jenis	ConnectionType (baca-saja)	Tipe (atau kategori) koneksi	Yes

Jenis Koneksi

Tipe (atau kategori) koneksi

Harta benda	Nilai
Deskripsi	Tipe (atau kategori) koneksi
Jenis	string
Nilai	`AzureOpenAI` `AzureBlob` `AzureStorageAccount` `CognitiveSearch` `CosmosDB` `ApiKey` `AppConfig` `AppInsights` `CustomKeys` `RemoteTool_Preview`

ContainerAppAgentDefinition

Definisi agen aplikasi kontainer.

Nama	Tipe	Deskripsi	Diperlukan
container_app_resource_id	string	ID sumber daya Azure Container App yang menghosting agen ini. Tidak dapat diubah di seluruh versi.	Yes
container_protocol_versions	array ProtocolVersionRecord	Protokol yang didukung agen untuk komunikasi masuknya kontainer.	Yes
ingress_subdomain_suffix	string	Akhiran yang akan diterapkan ke subdomain aplikasi saat mengirim masuknya ke agen. Ini dapat berupa label (misalnya, '---saat ini'), revisi tertentu (misalnya, '--0000001'), atau kosong untuk menggunakan endpoint default untuk aplikasi penampung.	Yes
jenis	enum	Nilai yang mungkin: `container_app`	Yes
rai_config	RaiConfig	Konfigurasi untuk fitur pemfilteran konten dan keamanan AI yang Bertanggung Jawab (RAI).	Tidak.
└─ rai_policy_name	string	Nama polis RAI yang akan diterapkan.	Yes

ContainerDetails

Informasi terperinci tentang kontainer.

Nama	Tipe	Deskripsi	Diperlukan
health_state	string	Status kesehatan kontainer.	Yes
provisioning_error	string	Kesalahan provisi kontainer, jika ada.	Tidak.
provisioning_state	string	Status provisi kontainer.	Yes
replicas	array ContainerReplica	Daftar replika dalam kontainer.	Yes
state	string	Keadaan kontainer.	Yes
updated_on	string	Waktu pembaruan terakhir kontainer.	Yes

ContainerLogKind

Jenis log yang akan dialirkan dari kontainer.

Harta benda	Nilai
Jenis	string
Nilai	`console` `system`

ContainerReplica

Informasi tentang replika kontainer.

Nama	Tipe	Deskripsi	Diperlukan
container_state	string	Status kontainer replika.	Yes
Nama	string	Nama replika.	Yes
state	string	Status replika.	Yes

ContinuousEvaluationRuleAction

Tindakan aturan evaluasi untuk evaluasi berkelanjutan.

Nama	Tipe	Deskripsi	Diperlukan
evalId	string	Eval Id untuk menambahkan eksekusi evaluasi berkelanjutan.	Yes
maxHourlyRuns	bilangan bulat	Jumlah maksimum eksekusi evaluasi yang diizinkan per jam.	Tidak.
jenis	enum	Nilai yang mungkin: `continuousEvaluation`	Yes

CosmosDBIndex

Definisi Indeks Toko Vektor CosmosDB

Nama	Tipe	Deskripsi	Diperlukan
id	string (baca-saja)	ID Aset, ID unik untuk aset	Tidak.
Nama	string (baca-saja)	Nama sumber daya	Yes
jenis	enum	Jenis indeks Nilai yang mungkin: `CosmosDBNoSqlVectorStore`	Yes
versi	string (baca-saja)	Versi sumber daya	Yes

CosmosDBIndexUpdate

Definisi Indeks Toko Vektor CosmosDB

Nama	Tipe	Deskripsi	Diperlukan
deskripsi	string	Teks deskripsi aset.	Tidak.
tags	objek	Kamus tag. Tag dapat ditambahkan, dihapus, dan diperbarui.	Tidak.
jenis	enum	Jenis indeks Nilai yang mungkin: `CosmosDBNoSqlVectorStore`	Yes

CreateAgentFromManifestRequest

Nama	Tipe	Deskripsi	Diperlukan
deskripsi	string	Deskripsi agen yang dapat dibaca manusia. Batasan: maxLength: 512	Tidak.
manifest_id	string	ID manifes untuk mengimpor versi agen.	Yes
metadata	objek	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini bisa berguna untuk menyimpan informasi tambahan tentang objek dalam terstruktur pemformatan dan pengambilan kueri untuk 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 unik yang mengidentifikasi agen. Nama dapat digunakan untuk mengambil/memperbarui/menghapus agen. - Harus dimulai dan diakhir dengan karakter alfanumerik, - Dapat berisi tanda hubung di tengah - Tidak boleh melebihi 63 karakter. Batasan: maxLength: 63	Yes
parameter_values	objek	Input ke manifes yang akan menghasilkan Agen yang sepenuhnya terwujud.	Yes

CreateAgentRequest

Nama	Tipe	Deskripsi	Diperlukan
definisi	AgentDefinition		Yes
└─ jenis	AgentKind		Yes
└─ rai_config	RaiConfig	Konfigurasi untuk fitur pemfilteran konten dan keamanan AI yang Bertanggung Jawab (RAI).	Tidak.
deskripsi	string	Deskripsi agen yang dapat dibaca manusia. Batasan: maxLength: 512	Tidak.
metadata	objek	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini bisa berguna untuk menyimpan informasi tambahan tentang objek dalam terstruktur pemformatan dan pengambilan kueri untuk 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 unik yang mengidentifikasi agen. Nama dapat digunakan untuk mengambil/memperbarui/menghapus agen. - Harus dimulai dan diakhir dengan karakter alfanumerik, - Dapat berisi tanda hubung di tengah - Tidak boleh melebihi 63 karakter. Batasan: maxLength: 63	Yes

CreateAgentVersionFromManifestRequest

Nama	Tipe	Deskripsi	Diperlukan
deskripsi	string	Deskripsi agen yang dapat dibaca manusia. Batasan: maxLength: 512	Tidak.
manifest_id	string	ID manifes untuk mengimpor versi agen.	Yes
metadata	objek	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini bisa berguna untuk menyimpan informasi tambahan tentang objek dalam terstruktur pemformatan dan pengambilan kueri untuk objek melalui API atau dasbor. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter.	Tidak.
parameter_values	objek	Input ke manifes yang akan menghasilkan Agen yang sepenuhnya terwujud.	Yes

CreateAgentVersionRequest

Nama	Tipe	Deskripsi	Diperlukan
definisi	AgentDefinition		Yes
└─ jenis	AgentKind		Yes
└─ rai_config	RaiConfig	Konfigurasi untuk fitur pemfilteran konten dan keamanan AI yang Bertanggung Jawab (RAI).	Tidak.
deskripsi	string	Deskripsi agen yang dapat dibaca manusia. Batasan: maxLength: 512	Tidak.
metadata	objek	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini bisa berguna untuk menyimpan informasi tambahan tentang objek dalam terstruktur pemformatan dan pengambilan kueri untuk objek melalui API atau dasbor. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter.	Tidak.

MembuatPermintaanEvaluasi

Nama	Tipe	Deskripsi	Diperlukan
konfigurasi_sumber_data	OpenAI.CreateEvalCustomDataSourceConfig atau OpenAI.CreateEvalLogsDataSourceConfig atau OpenAI.CreateEvalStoredCompletionsDataSourceConfig atau AzureAIDataSourceConfig	Konfigurasi untuk sumber data yang digunakan untuk evaluasi berjalan. Menentukan skema data yang digunakan dalam evaluasi.	Yes
metadata	OpenAI.Metadata (dapat diberisi dengan null)	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini bisa berguna untuk menyimpan informasi tambahan tentang objek dalam terstruktur pemformatan dan pengambilan kueri untuk 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.
properties	objek	Set pasangan kunci-nilai 16 yang tidak dapat diubah yang dapat dilampirkan ke objek untuk menyimpan informasi tambahan. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter.	Tidak.
kriteria_pengujian	array OpenAI.EvalGraderLabelModel atau OpenAI.EvalGraderStringCheck atau OpenAI.EvalGraderTextSimilarity atau OpenAI.EvalGraderPython atau OpenAI.EvalGraderScoreModel atau EvalGraderAzureAIEvaluator	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

CreateEvalRunRequest

Nama	Tipe	Deskripsi	Diperlukan
sumber data	OpenAI.CreateEvalJsonlRunDataSource atau OpenAI.CreateEvalCompletionsRunDataSource atau OpenAI.CreateEvalResponsesRunDataSource atau EvalRunDataSource	Detail tentang sumber data eksekusi.	Yes
metadata	OpenAI.Metadata (dapat diberisi dengan null)	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini bisa berguna untuk menyimpan informasi tambahan tentang objek dalam terstruktur pemformatan dan pengambilan kueri untuk 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.
properties	objek	Set pasangan kunci-nilai 16 yang tidak dapat diubah yang dapat dilampirkan ke objek untuk menyimpan informasi tambahan. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter.	Tidak.

CredentialType

Jenis kredensial yang digunakan oleh koneksi

Harta benda	Nilai
Deskripsi	Jenis kredensial yang digunakan oleh koneksi
Jenis	string
Nilai	`ApiKey` `AAD` `SAS` `CustomKeys` `None` `AgenticIdentityToken_Preview`

CronTrigger

Pemicu berbasis cron.

Nama	Tipe	Deskripsi	Diperlukan	Default
endTime	string	Waktu berakhir untuk jadwal cron dalam format ISO 8601.	Tidak.
ekspresi	string	Cron yang menentukan frekuensi jadwal.	Yes
startTime	string	Waktu mulai untuk jadwal cron dalam format ISO 8601.	Tidak.
zona waktu	string	Zona waktu untuk jadwal cron.	Tidak.	UTC
jenis	enum	Nilai yang mungkin: `Cron`	Yes

CustomCredential

Definisi kredensial kustom

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	enum	Jenis kredensial Nilai yang mungkin: `CustomKeys`	Yes

Objek ini juga menerima properti jenis tambahan: string

DailyRecurrenceSchedule

Jadwal pengulangan harian.

Nama	Tipe	Deskripsi	Diperlukan	Default
hours	array bilangan bulat	Jam untuk jadwal pengulangan.	Yes
jenis	enum	Jenis kekambuhan harian. Nilai yang mungkin: `Daily`	Yes

DataSourceConfig

Kelas dasar untuk menjalankan sumber data dengan dukungan diskriminator.

Diskriminator untuk DataSourceConfig

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema

Nama	Tipe	Deskripsi	Diperlukan	Default
skema	objek	Skema JSON objek keseluruhan untuk item sumber data yang dijalankan.	Yes
jenis	string	Diskriminator jenis sumber data.	Yes

DatasetType

Enum untuk menentukan jenis data.

Harta benda	Nilai
Deskripsi	Enum untuk menentukan jenis data.
Jenis	string
Nilai	`uri_file` `uri_folder`

DatasetVersion

Definisi DatasetVersion

Diskriminator untuk DatasetVersion

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
`uri_file`	FileDatasetVersion
`uri_folder`	FolderDatasetVersion

Nama	Tipe	Deskripsi	Diperlukan
connectionName	string	Nama koneksi Akun Azure Storage. Diperlukan jika startPendingUploadVersion tidak dipanggil sebelum membuat Himpunan Data	Tidak.
dataUri	string	URI data (contoh) Batasan: minLength: 1, pola: `[a-zA-Z0-9_]`	Yes
id	string (baca-saja)	ID Aset, ID unik untuk aset	Tidak.
isReference	boolean (baca-saja)	Menunjukkan apakah himpunan data menyimpan referensi ke storage, atau himpunan data mengelola storage itu sendiri. Jika true, data yang mendasarinya tidak akan dihapus saat versi himpunan data dihapus	Tidak.
Nama	string (baca-saja)	Nama sumber daya	Yes
jenis	DatasetType	Enum untuk menentukan jenis data.	Yes
versi	string (baca-saja)	Versi sumber daya	Yes

DatasetVersionUpdate

Definisi DatasetVersion

Diskriminator untuk DatasetVersionUpdate

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
`uri_file`	FileDatasetVersionUpdate
`uri_folder`	FolderDatasetVersionUpdate

Nama	Tipe	Deskripsi	Diperlukan
deskripsi	string	Teks deskripsi aset.	Tidak.
tags	objek	Kamus tag. Tag dapat ditambahkan, dihapus, dan diperbarui.	Tidak.
jenis	DatasetType	Enum untuk menentukan jenis data.	Yes

Hari dalam Minggu

Hari dalam seminggu untuk jadwal pengulangan.

Harta benda	Nilai
Deskripsi	Hari dalam seminggu untuk jadwal pengulangan.
Jenis	string
Nilai	`Sunday` `Monday` `Tuesday` `Wednesday` `Thursday` `Friday` `Saturday`

DeleteAgentResponse

Objek agen yang dihapus

Nama	Tipe	Deskripsi	Diperlukan
dihapus	Boolean	Apakah agen berhasil dihapus.	Yes
Nama	string	Nama agen.	Yes
objek	enum	Jenis objek. Selalu 'agen.dihapus'. Nilai yang mungkin: `agent.deleted`	Yes

DeleteAgentVersionResponse

Objek versi agen yang dihapus

Nama	Tipe	Deskripsi	Diperlukan
dihapus	Boolean	Apakah agen berhasil dihapus.	Yes
Nama	string	Nama agen.	Yes
objek	enum	Jenis objek. Selalu 'agent.version.deleted'. Nilai yang mungkin: `agent.version.deleted`	Yes
versi	string	Pengidentifikasi versi agen.	Yes

DeleteEvalResponse

Objek evaluasi yang dihapus

Nama	Tipe	Deskripsi	Diperlukan
dihapus	Boolean	Apakah evaluasi berhasil dihapus.	Yes
eval_id	string	id evaluasi.	Yes
objek	enum	Jenis objek. Selalu 'eval.deleted'. Nilai yang mungkin: `eval.deleted`	Yes

DeleteEvalRunResponse

Objek eksekusi evaluasi yang dihapus.

Nama	Tipe	Deskripsi	Diperlukan
dihapus	Boolean	Apakah evaluasi berhasil dihapus.	Tidak.
objek	enum	Jenis objek. Selalu 'eval.deleted'. Nilai yang mungkin: `eval.deleted`	Tidak.
run_id	string	id evaluasi.	Tidak.

DeleteMemoryStoreResponse

Nama	Tipe	Deskripsi	Diperlukan
dihapus	Boolean	Apakah penyimpanan memori berhasil dihapus.	Yes
Nama	string	Nama penyimpanan memori.	Yes
objek	enum	Jenis objek. Selalu 'memory_store.deleted'. Nilai yang mungkin: `memory_store.deleted`	Yes

DeleteResponseResult

Hasil dari operasi respons penghapusan.

Nama	Tipe	Deskripsi	Diperlukan
dihapus	enum	Selalu kembalikan true Nilai yang mungkin: `True`	Yes
id	string	ID operasi.	Yes
objek	enum	Selalu kembalikan 'respons'. Nilai yang mungkin: `response`	Yes

Penyebaran

Definisi Penerapan Model

Diskriminator untuk Penyebaran

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
`ModelDeployment`	ModelDeployment

Nama	Tipe	Deskripsi	Diperlukan	Default
Nama	string (baca-saja)	Nama penyebaran	Yes
jenis	DeploymentType		Yes

Jenis Penerapan

Harta benda	Nilai
Jenis	string
Nilai	`ModelDeployment`

EntraIDCredentials

Definisi kredensial ID Entra

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	enum	Jenis kredensial Nilai yang mungkin: `AAD`	Yes

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
dibuat_pada	bilangan bulat	Tanda waktu Unix (dalam detik) saat evaluasi dibuat.	Yes
dibuat oleh	string	nama orang yang membuat eksekusi.	Tidak.
konfigurasi_sumber_data	OpenAI.CreateEvalCustomDataSourceConfig atau OpenAI.CreateEvalLogsDataSourceConfig atau OpenAI.CreateEvalStoredCompletionsDataSourceConfig atau AzureAIDataSourceConfig	Konfigurasi sumber data yang digunakan dalam menjalankan evaluasi.	Yes
id	string	Pengidentifikasi unik untuk evaluasi.	Yes
metadata	OpenAI.Metadata (dapat diberisi dengan null)	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini bisa berguna untuk menyimpan informasi tambahan tentang objek dalam terstruktur pemformatan dan pengambilan kueri untuk objek melalui API atau dasbor. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter.	Yes
modified_at	Integer		Tidak.
Nama	string	Nama evaluasi.	Yes
objek	enum	Jenis objek. Nilai yang mungkin: `eval`	Yes
properties	objek	Set pasangan kunci-nilai 16 yang tidak dapat diubah yang dapat dilampirkan ke objek untuk menyimpan informasi tambahan. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter.	Tidak.
kriteria_pengujian	array OpenAI.EvalGraderLabelModel atau OpenAI.EvalGraderStringCheck atau OpenAI.EvalGraderTextSimilarity atau OpenAI.EvalGraderPython atau OpenAI.EvalGraderScoreModel atau EvalGraderAzureAIEvaluator	Daftar kriteria pengujian.	Yes

EvalCsvFileIdSource

Mewakili referensi ke file CSV yang diunggah yang digunakan sebagai sumber untuk data evaluasi.

Nama	Tipe	Deskripsi	Diperlukan	Default
id	string	Pengidentifikasi file CSV yang diunggah.	Yes
jenis	enum	Jenis sumber, selalu `file_id`. Nilai yang mungkin: `file_id`	Yes

EvalCsvRunDataSource

Mewakili sumber data CSV untuk eksekusi evaluasi.

Nama	Tipe	Deskripsi	Diperlukan
sumber	EvalCsvFileIdSource	Mewakili referensi ke file CSV yang diunggah yang digunakan sebagai sumber untuk data evaluasi.	Yes
└─ ID	string	Pengidentifikasi file CSV yang diunggah.	Yes
└─ jenis	enum	Jenis sumber, selalu `file_id`. Nilai yang mungkin: `file_id`	Yes
jenis	enum	Jenis sumber data, selalu `csv`. Nilai yang mungkin: `csv`	Yes

EvalGraderAzureAIEvaluator

Nama	Tipe	Deskripsi	Diperlukan
data_mapping	objek	Model yang digunakan untuk evaluasi. Harus mendukung output terstruktur.	Tidak.
evaluator_name	string	Nama evaluator.	Yes
evaluator_version	string	Versi evaluator. Versi terbaru jika tidak ditentukan.	Tidak.
initialization_parameters	objek	Parameter inisialisasi untuk evaluasi. Harus mendukung output terstruktur.	Tidak.
Nama	string	Nama penilai.	Yes
jenis	enum	Tipe objek, yang selalu `azure_ai_evaluator`. Nilai yang mungkin: `azure_ai_evaluator`	Yes

EvalResult

Hasil evaluasi.

Nama	Tipe	Deskripsi	Diperlukan
Nama	string	Nama cek	Yes
Berlalu	Boolean	menunjukkan apakah pemeriksaan lulus atau gagal	Yes
skor	nomor/angka	skor	Yes
jenis	string	Jenis cek	Yes

EvalRun

Skema yang mewakili pelaksanaan evaluasi.

Nama	Tipe	Deskripsi	Diperlukan
dibuat_pada	bilangan bulat	Tanda waktu Unix (dalam detik) saat eksekusi evaluasi dibuat.	Yes
dibuat oleh	string	nama orang yang membuat eksekusi.	Tidak.
sumber data	OpenAI.CreateEvalJsonlRunDataSource atau OpenAI.CreateEvalCompletionsRunDataSource atau OpenAI.CreateEvalResponsesRunDataSource atau EvalRunDataSource	Informasi tentang sumber data eksekusi.	Yes
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	OpenAI.Metadata (dapat diberisi dengan null)	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini bisa berguna untuk menyimpan informasi tambahan tentang objek dalam terstruktur pemformatan dan pengambilan kueri untuk 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
modified_at	Integer		Tidak.
Nama	string	Nama pelaksanaan evaluasi.	Yes
objek	enum	Jenis objek. Selalu "eval.run". Nilai yang mungkin: `eval.run`	Yes
penggunaan_per_model	array OpenAI.EvalRunPerModelUsage	Statistik penggunaan untuk setiap model selama eksekusi evaluasi.	Yes
hasil_kriteria_pengujian	array OpenAI.EvalRunPerTestingCriteriaResults	Hasil per kriteria pengujian yang diterapkan selama jalannya evaluasi.	Yes
properties	objek	Set pasangan kunci-nilai 16 yang tidak dapat diubah yang dapat dilampirkan ke objek untuk menyimpan informasi tambahan. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter.	Tidak.
report_url	string	URL ke laporan jalannya evaluasi yang dihasilkan di dasbor UI.	Yes
jumlah_hasil	OpenAI.EvalRunResultCounts		Yes
└─ kesalahan	OpenAI.integer		Yes
└─ gagal	OpenAI.integer		Yes
└─ berhasil	OpenAI.integer		Yes
└─ jumlah	OpenAI.integer		Yes
status	string	Status jalannya evaluasi.	Yes

EvalRunDataSource

Kelas dasar untuk menjalankan sumber data dengan dukungan diskriminator.

Diskriminator untuk EvalRunDataSource

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
`azure_ai_traces_preview`	TracesPreviewEvalRunDataSource
`azure_ai_synthetic_data_gen_preview`	SyntheticDataGenerationPreviewEvalRunDataSource
`azure_ai_responses`	AzureAIResponsesEvalRunDataSource
`azure_ai_target_completions`	TargetCompletionEvalRunDataSource
`csv`	EvalCsvRunDataSource
`azure_ai_red_team`	RedTeamEvalRunDataSource

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	string	Diskriminator jenis sumber data.	Yes

EvalRunOutputItem

Skema yang mewakili elemen hasil dari proses evaluasi.

Nama	Tipe	Deskripsi	Diperlukan
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	OpenAI.integer		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 EvalRunOutputItemResult	Daftar hasil grader untuk item output ini.	Yes
run_id	string	Pengidentifikasi jalannya evaluasi yang terkait dengan item output ini.	Yes
sampel	OpenAI.EvalRunOutputItemSample		Yes
└─ kesalahan	OpenAI.EvalApiError	Objek yang mewakili respons kesalahan dari EVAL API.	Yes
└─ alasan_selesai	string		Yes
└─ masukan	array EvalRunOutputItemSampleInput		Yes
└─ max_completion_tokens	OpenAI.integer		Yes
└─ model	string		Yes
└─ keluaran	array EvalRunOutputItemSampleOutput		Yes
└─ benih	OpenAI.integer		Yes
└─ suhu	OpenAI.numeric		Yes
└─ top_p	OpenAI.numeric		Yes
└─ penggunaan	OpenAI.EvalRunOutputItemSampleUsage		Yes
status	string	Status jalannya evaluasi.	Yes

EvalRunOutputItemResult

Satu hasil grader untuk item output eksekusi evaluasi.

Nama	Tipe	Deskripsi	Diperlukan
label	string	Label yang terkait dengan metrik kriteria pengujian (misalnya, "pass", "fail", "good", "bad").	Tidak.
metric	string	Nama metrik (misalnya, "fluency", "f1_score").	Tidak.
Nama	string	Nama penilai.	Yes
Berlalu	Boolean	Apakah grader menganggap output sebagai pass.	Yes
properties	objek	Detail tambahan tentang metrik kriteria pengujian.	Tidak.
alasan	string	Alasan metrik kriteria pengujian.	Tidak.
sampel	objek (nullable)	Sampel opsional atau data perantara yang dihasilkan oleh grader.	Tidak.
skor	OpenAI.numeric		Yes
ambang	nomor/angka	Ambang batas yang digunakan untuk menentukan lulus/gagal untuk kriteria pengujian ini, jika bersifat numerik.	Tidak.
jenis	string	Jenis grader (misalnya, "string-check-grader").	Tidak.

Objek ini juga menerima properti tambahan.

EvalRunOutputItemSampleInput

Pesan dalam eksekusi evaluasi.

Nama	Tipe	Deskripsi	Diperlukan
isi	string		Yes
peran	string		Yes
tool_calls	array completionMessageToolCallChunk	Panggilan alat yang dilakukan dalam pesan, jika ada.	Yes

EvalRunOutputItemSampleOutput

Pesan dalam eksekusi evaluasi.

Nama	Tipe	Deskripsi	Diperlukan
isi	string		Tidak.
peran	string		Tidak.
tool_calls	array completionMessageToolCallChunk	Panggilan alat yang dilakukan dalam pesan, jika ada.	Yes

EvalRunResultCompareItem

Perbandingan metrik untuk perlakuan terhadap baseline.

Nama	Tipe	Deskripsi	Diperlukan
deltaEstimate	nomor/angka	Perkiraan perbedaan antara pengobatan dan baseline.	Yes
pValue	nomor/angka	Nilai P untuk efek pengobatan.	Yes
treatmentEffect	TreatmentEffectType	Jenis Efek Pengobatan.	Yes
treatmentRunId	string	ID eksekusi perlakuan.	Yes
treatmentRunSummary	EvalRunResultSummary	Statistik ringkasan metrik dalam eksekusi evaluasi.	Yes
└─ rata-rata	nomor/angka	Nilai rata-rata metrik dalam eksekusi evaluasi.	Yes
└─ runId	string	ID eksekusi evaluasi.	Yes
└─ sampleCount	bilangan bulat	Jumlah sampel dalam evaluasi yang dijalankan.	Yes
└─ standarDeviasi	nomor/angka	Standar deviasi metrik dalam evaluasi eksekusi.	Yes

EvalRunResultComparison

Hasil perbandingan untuk pengobatan berjalan dengan baseline.

Nama	Tipe	Deskripsi	Diperlukan
baselineRunSummary	EvalRunResultSummary	Statistik ringkasan metrik dalam eksekusi evaluasi.	Yes
└─ rata-rata	nomor/angka	Nilai rata-rata metrik dalam eksekusi evaluasi.	Yes
└─ runId	string	ID eksekusi evaluasi.	Yes
└─ sampleCount	bilangan bulat	Jumlah sampel dalam evaluasi yang dijalankan.	Yes
└─ standarDeviasi	nomor/angka	Standar deviasi metrik dalam evaluasi eksekusi.	Yes
compareItems	array EvalRunResultCompareItem	Daftar hasil perbandingan untuk setiap proses perawatan.	Yes
evaluator	string	Nama evaluator untuk kriteria pengujian ini.	Yes
metric	string	Metrik sedang dievaluasi.	Yes
testingCriteria	string	Nama kriteria pengujian.	Yes

EvalRunResultSummary

Statistik ringkasan metrik dalam eksekusi evaluasi.

Nama	Tipe	Deskripsi	Diperlukan
tengah	nomor/angka	Nilai rata-rata metrik dalam eksekusi evaluasi.	Yes
runId	string	ID eksekusi evaluasi.	Yes
sampleCount	bilangan bulat	Jumlah sampel dalam evaluasi yang dijalankan.	Yes
standardDeviation	nomor/angka	Standar deviasi metrik dalam evaluasi eksekusi.	Yes

EvaluationComparisonInsightRequest

Permintaan Perbandingan Evaluasi

Nama	Tipe	Deskripsi	Diperlukan
baselineRunId	string	ID eksekusi dasar untuk perbandingan.	Yes
evalId	string	Pengidentifikasi untuk evaluasi.	Yes
treatmentRunIds	array string	Daftar ID eksekusi perlakuan untuk perbandingan.	Yes
jenis	enum	Jenis permintaan. Nilai yang mungkin: `EvaluationComparison`	Yes

EvaluationComparisonInsightResult

Wawasan dari perbandingan evaluasi.

Nama	Tipe	Deskripsi	Diperlukan
Perbandingan	array EvalRunResultComparison	Hasil perbandingan untuk setiap perlakuan berjalan dengan baseline.	Yes
metode	string	Metode statistik yang digunakan untuk perbandingan.	Yes
jenis	enum	Jenis hasil wawasan. Nilai yang mungkin: `EvaluationComparison`	Yes

EvaluationResultSample

Contoh dari hasil evaluasi.

Nama	Tipe	Deskripsi	Diperlukan
correlationInfo	objek	Info tentang korelasi untuk sampel analisis.	Yes
evaluationResult	EvalResult	Hasil evaluasi.	Yes
└─ nama	string	Nama cek	Yes
└─ berhasil	Boolean	menunjukkan apakah pemeriksaan lulus atau gagal	Yes
└─ skor	nomor/angka	skor	Yes
└─ jenis	string	Jenis cek	Yes
features	objek	Fitur untuk membantu pemfilteran data tambahan di UX.	Yes
id	string	Pengidentifikasi unik untuk sampel analisis.	Yes
jenis	enum	Jenis Sampel Hasil Evaluasi Nilai yang mungkin: `EvaluationResultSample`	Yes

Aturan Evaluasi

Model aturan evaluasi.

Nama	Tipe	Deskripsi	Diperlukan
tindakan	EvaluationRuleAction	Model tindakan evaluasi.	Yes
└─ jenis	EvaluationRuleActionType	Jenis tindakan evaluasi.	Yes
deskripsi	string	Deskripsi untuk aturan evaluasi.	Tidak.
nama tampilan	string	Nama Tampilan untuk aturan evaluasi.	Tidak.
enabled	Boolean	Menunjukkan apakah aturan evaluasi diaktifkan. Nilai default adalah benar.	Yes
eventType	EvaluationRuleEventType	Jenis peristiwa aturan evaluasi.	Yes
filter	EvaluationRuleFilter	Model filter evaluasi.	Tidak.
└─ agenNama	string	Filter berdasarkan nama agen.	Yes
id	string (baca-saja)	Pengidentifikasi unik untuk aturan evaluasi.	Yes
sistem Data	objek (baca-saja)	Metadata sistem untuk aturan evaluasi.	Yes

EvaluationRuleAction

Model tindakan evaluasi.

Diskriminator untuk EvaluationRuleAction

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
`continuousEvaluation`	ContinuousEvaluationRuleAction
`humanEvaluationPreview`	HumanEvaluationPreviewRuleAction

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	EvaluationRuleActionType	Jenis tindakan evaluasi.	Yes

EvaluationRuleActionType

Jenis tindakan evaluasi.

Harta benda	Nilai
Deskripsi	Jenis tindakan evaluasi.
Jenis	string
Nilai	`continuousEvaluation` `humanEvaluationPreview`

EvaluationRuleEventType

Jenis peristiwa aturan evaluasi.

Harta benda	Nilai
Deskripsi	Jenis peristiwa aturan evaluasi.
Jenis	string
Nilai	`responseCompleted` `manual`

EvaluationRuleFilter

Model filter evaluasi.

Nama	Tipe	Deskripsi	Diperlukan	Default
agen Nama	string	Filter berdasarkan nama agen.	Yes

EvaluationRunClusterInsightRequest

Wawasan tentang kumpulan Hasil Evaluasi

Nama	Tipe	Deskripsi	Diperlukan
evalId	string	Id Evaluasi untuk wawasan.	Yes
modelKonfigurasi	InsightModelConfiguration	Konfigurasi model yang digunakan dalam pembuatan wawasan.	Tidak.
└─ modelDeploymentName	string	Penyebaran model yang akan dievaluasi. Menerima nama penyebaran saja atau dengan nama koneksi sebagai `{connectionName}/<modelDeploymentName>`.	Yes
runIds	array string	Daftar ID eksekusi evaluasi untuk wawasan.	Yes
jenis	enum	Jenis permintaan wawasan. Nilai yang mungkin: `EvaluationRunClusterInsight`	Yes

EvaluasiRunClusterInsightResult

Wawasan dari evaluasi menjalankan analisis kluster.

Nama	Tipe	Deskripsi	Diperlukan	Default
clusterInsight	ClusterInsightResult	Wawasan dari analisis kluster.	Yes
jenis	enum	Jenis hasil wawasan. Nilai yang mungkin: `EvaluationRunClusterInsight`	Yes

EvaluationScheduleTask

Tugas evaluasi untuk jadwal.

Nama	Tipe	Deskripsi	Diperlukan
konfigurasi	objek	Konfigurasi untuk tugas tersebut.	Tidak.
evalId	string	Pengidentifikasi grup evaluasi.	Yes
evalRun	objek	Muatan evaluasi jalankan.	Yes
jenis	enum	Nilai yang mungkin: `Evaluation`	Yes

EvaluasiTaxonomy

Pengertian Taksonomi Evaluasi

Nama	Tipe	Deskripsi	Diperlukan
id	string (baca-saja)	ID Aset, ID unik untuk aset	Tidak.
Nama	string (baca-saja)	Nama sumber daya	Yes
properties	objek	Properti tambahan untuk taksonomi evaluasi.	Tidak.
taxonomyCategories	array TaxonomyCategory	Daftar kategori taksonomi.	Tidak.
taxonomyInput	EvaluasiTaxonomyInput	Konfigurasi input untuk taksonomi evaluasi.	Yes
└─ jenis	EvaluationTaxonomyInputType	Jenis input taksonomi evaluasi.	Yes
versi	string (baca-saja)	Versi sumber daya	Yes

EvaluationTaxonomyCreateOrUpdate

Pengertian Taksonomi Evaluasi

Nama	Tipe	Deskripsi	Diperlukan
deskripsi	string	Teks deskripsi aset.	Tidak.
properties	objek	Properti tambahan untuk taksonomi evaluasi.	Tidak.
tags	objek	Kamus tag. Tag dapat ditambahkan, dihapus, dan diperbarui.	Tidak.
taxonomyCategories	array TaxonomyCategory	Daftar kategori taksonomi.	Tidak.
taxonomyInput	EvaluasiTaxonomyInput	Konfigurasi input untuk taksonomi evaluasi.	Yes
└─ jenis	EvaluationTaxonomyInputType	Jenis input taksonomi evaluasi.	Yes

EvaluasiTaxonomyInput

Konfigurasi input untuk taksonomi evaluasi.

Diskriminator untuk EvaluasiTaxonomyInput

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
`agent`	AgentTaxonomyInput

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	EvaluationTaxonomyInputType	Jenis input taksonomi evaluasi.	Yes

EvaluationTaxonomyInputType

Jenis input taksonomi evaluasi.

Harta benda	Nilai
Deskripsi	Jenis input taksonomi evaluasi.
Jenis	string
Nilai	`agent` `policy`

EvaluationTaxonomyInputUpdate

Konfigurasi input untuk taksonomi evaluasi.

Diskriminator untuk EvaluationTaxonomyInputUpdate

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
`agent`	AgentTaxonomyInputUpdate

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	EvaluationTaxonomyInputType	Jenis input taksonomi evaluasi.	Yes

EvaluationTaxonomyUpdate

Pengertian Taksonomi Evaluasi

Nama	Tipe	Deskripsi	Diperlukan
deskripsi	string	Teks deskripsi aset.	Tidak.
properties	objek	Properti tambahan untuk taksonomi evaluasi.	Tidak.
tags	objek	Kamus tag. Tag dapat ditambahkan, dihapus, dan diperbarui.	Tidak.
taxonomyCategories	array TaxonomyCategory	Daftar kategori taksonomi.	Tidak.
taxonomyInput	EvaluationTaxonomyInputUpdate	Konfigurasi input untuk taksonomi evaluasi.	Tidak.
└─ jenis	EvaluationTaxonomyInputType	Jenis input taksonomi evaluasi.	Yes

EvaluatorCategory

Kategori evaluator

Harta benda	Nilai
Deskripsi	Kategori evaluator
Jenis	string
Nilai	`quality` `safety` `agents`

EvaluatorDefinition

Konfigurasi evaluator dasar dengan diskriminator

Diskriminator untuk EvaluatorDefinition

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
`code`	CodeBasedEvaluatorDefinition
`prompt`	PromptBasedEvaluatorDefinition

Nama	Tipe	Deskripsi	Diperlukan
data_schema	objek	Skema JSON (Draf 2020-12) untuk data input evaluator. Ini termasuk parameter seperti jenis, properti, diperlukan.	Tidak.
init_parameters	objek	Skema JSON (Draf 2020-12) untuk parameter input evaluator. Ini termasuk parameter seperti jenis, properti, diperlukan.	Tidak.
metrik	objek	Daftar metrik output yang dihasilkan oleh evaluator ini	Tidak.
jenis	EvaluatorDefinitionType	Jenis definisi evaluator	Yes

EvaluatorDefinitionType

Jenis definisi evaluator

Harta benda	Nilai
Deskripsi	Jenis definisi evaluator
Jenis	string
Nilai	`prompt` `code` `prompt_and_code` `service` `openai_graders`

EvaluatorMetric

Metrik Evaluator

Nama	Tipe	Deskripsi	Diperlukan
desirable_direction	EvaluatorMetricDirection	Arah metrik yang menunjukkan apakah nilai yang lebih tinggi lebih baik, nilai yang lebih rendah lebih baik, atau netral	Tidak.
is_primary	Boolean	Menunjukkan apakah metrik ini utama ketika ada beberapa metrik.	Tidak.
max_value	nomor/angka	Nilai maksimum untuk metrik. Jika tidak ditentukan, diasumsikan tidak terbatas.	Tidak.
min_value	nomor/angka	Nilai minimum untuk metrik	Tidak.
jenis	EvaluatorMetricType	Jenis evaluator	Tidak.

EvaluatorMetricDirection

Arah metrik yang menunjukkan apakah nilai yang lebih tinggi lebih baik, nilai yang lebih rendah lebih baik, atau netral

Harta benda	Nilai
Deskripsi	Arah metrik yang menunjukkan apakah nilai yang lebih tinggi lebih baik, nilai yang lebih rendah lebih baik, atau netral
Jenis	string
Nilai	`increase` `decrease` `neutral`

EvaluatorMetricType

Jenis evaluator

Harta benda	Nilai
Deskripsi	Jenis evaluator
Jenis	string
Nilai	`ordinal` `continuous` `boolean`

EvaluatorType

Jenis evaluator

Harta benda	Nilai
Deskripsi	Jenis evaluator
Jenis	string
Nilai	`builtin` `custom`

EvaluatorVersion

Definisi Evaluator

Nama	Tipe	Deskripsi	Diperlukan
categories	array EvaluatorCategory	Kategori evaluator	Yes
dibuat_pada	string (baca-saja)	Tanggal/waktu pembuatan evaluator	Yes
dibuat oleh	string (baca-saja)	Pencipta evaluator	Yes
definisi	EvaluatorDefinition	Konfigurasi evaluator dasar dengan diskriminator	Yes
└─ data_schema	objek	Skema JSON (Draf 2020-12) untuk data input evaluator. Ini termasuk parameter seperti jenis, properti, diperlukan.	Tidak.
└─ init_parameters	objek	Skema JSON (Draf 2020-12) untuk parameter input evaluator. Ini termasuk parameter seperti jenis, properti, diperlukan.	Tidak.
└─ metrik	objek	Daftar metrik output yang dihasilkan oleh evaluator ini	Tidak.
└─ jenis	EvaluatorDefinitionType	Jenis definisi evaluator	Yes
display_name	string	Nama Tampilan untuk evaluator. Ini membantu menemukan evaluator dengan mudah di AI Foundry. Tidak perlu unik.	Tidak.
evaluator_type	EvaluatorType	Jenis evaluator	Yes
id	string (baca-saja)	ID Aset, ID unik untuk aset	Tidak.
metadata	objek	Metadata tentang evaluator	Tidak.
modified_at	string (baca-saja)	Tanggal/waktu evaluator yang terakhir diubah	Yes
Nama	string (baca-saja)	Nama sumber daya	Yes
versi	string (baca-saja)	Versi sumber daya	Yes

EvaluatorVersionBuat

Definisi Evaluator

Nama	Tipe	Deskripsi	Diperlukan
categories	array EvaluatorCategory	Kategori evaluator	Yes
definisi	EvaluatorDefinition	Konfigurasi evaluator dasar dengan diskriminator	Yes
└─ data_schema	objek	Skema JSON (Draf 2020-12) untuk data input evaluator. Ini termasuk parameter seperti jenis, properti, diperlukan.	Tidak.
└─ init_parameters	objek	Skema JSON (Draf 2020-12) untuk parameter input evaluator. Ini termasuk parameter seperti jenis, properti, diperlukan.	Tidak.
└─ metrik	objek	Daftar metrik output yang dihasilkan oleh evaluator ini	Tidak.
└─ jenis	EvaluatorDefinitionType	Jenis definisi evaluator	Yes
deskripsi	string	Teks deskripsi aset.	Tidak.
display_name	string	Nama Tampilan untuk evaluator. Ini membantu menemukan evaluator dengan mudah di AI Foundry. Tidak perlu unik.	Tidak.
evaluator_type	EvaluatorType	Jenis evaluator	Yes
metadata	objek	Metadata tentang evaluator	Tidak.
tags	objek	Kamus tag. Tag dapat ditambahkan, dihapus, dan diperbarui.	Tidak.

EvaluatorVersionUpdate

Definisi Evaluator

Nama	Tipe	Deskripsi	Diperlukan
categories	array EvaluatorCategory	Kategori evaluator	Tidak.
deskripsi	string	Teks deskripsi aset.	Tidak.
display_name	string	Nama Tampilan untuk evaluator. Ini membantu menemukan evaluator dengan mudah di AI Foundry. Tidak perlu unik.	Tidak.
metadata	objek	Metadata tentang evaluator	Tidak.
tags	objek	Kamus tag. Tag dapat ditambahkan, dihapus, dan diperbarui.	Tidak.

FabricDataAgentToolParameters

Parameter alat agen data fabric.

Nama	Tipe	Deskripsi	Diperlukan	Default
project_connections	array ToolProjectConnection	Koneksi project yang terpasang pada alat ini. Mungkin ada maksimal 1 koneksi sumber daya yang dilampirkan ke alat.	Tidak.

FileDatasetVersion

Definisi FileDatasetVersion

Nama	Tipe	Deskripsi	Diperlukan
connectionName	string	Nama koneksi Akun Azure Storage. Diperlukan jika startPendingUploadVersion tidak dipanggil sebelum membuat Himpunan Data	Tidak.
dataUri	string	URI data (contoh) Batasan: minLength: 1, pola: `[a-zA-Z0-9_]`	Yes
id	string (baca-saja)	ID Aset, ID unik untuk aset	Tidak.
isReference	boolean (baca-saja)	Menunjukkan apakah himpunan data menyimpan referensi ke storage, atau himpunan data mengelola storage itu sendiri. Jika true, data yang mendasarinya tidak akan dihapus saat versi himpunan data dihapus	Tidak.
Nama	string (baca-saja)	Nama sumber daya	Yes
jenis	enum	Jenis himpunan data Nilai yang mungkin: `uri_file`	Yes
versi	string (baca-saja)	Versi sumber daya	Yes

FileDatasetVersionUpdate

Definisi FileDatasetVersion

Nama	Tipe	Deskripsi	Diperlukan
deskripsi	string	Teks deskripsi aset.	Tidak.
tags	objek	Kamus tag. Tag dapat ditambahkan, dihapus, dan diperbarui.	Tidak.
jenis	enum	Jenis himpunan data Nilai yang mungkin: `uri_file`	Yes

FolderDatasetVersion

Definisi FileDatasetVersion

Nama	Tipe	Deskripsi	Diperlukan
connectionName	string	Nama koneksi Akun Azure Storage. Diperlukan jika startPendingUploadVersion tidak dipanggil sebelum membuat Himpunan Data	Tidak.
dataUri	string	URI data (contoh) Batasan: minLength: 1, pola: `[a-zA-Z0-9_]`	Yes
id	string (baca-saja)	ID Aset, ID unik untuk aset	Tidak.
isReference	boolean (baca-saja)	Menunjukkan apakah himpunan data menyimpan referensi ke storage, atau himpunan data mengelola storage itu sendiri. Jika true, data yang mendasarinya tidak akan dihapus saat versi himpunan data dihapus	Tidak.
Nama	string (baca-saja)	Nama sumber daya	Yes
jenis	enum	Jenis himpunan data Nilai yang mungkin: `uri_folder`	Yes
versi	string (baca-saja)	Versi sumber daya	Yes

FolderDatasetVersionUpdate

Definisi FileDatasetVersion

Nama	Tipe	Deskripsi	Diperlukan
deskripsi	string	Teks deskripsi aset.	Tidak.
tags	objek	Kamus tag. Tag dapat ditambahkan, dihapus, dan diperbarui.	Tidak.
jenis	enum	Jenis himpunan data Nilai yang mungkin: `uri_folder`	Yes

FunctionToolCall

Detail panggilan alat fungsi.

Nama	Tipe	Deskripsi	Diperlukan	Default
argumen	string	Argumen untuk memanggil fungsi dengan, seperti yang dihasilkan oleh model dalam format JSON.	Yes
Nama	string	Nama fungsi yang akan dipanggil.	Yes

HostedAgentDefinition

Definisi agen yang dihosting.

Nama	Tipe	Deskripsi	Diperlukan
container_protocol_versions	array ProtocolVersionRecord	Protokol yang didukung agen untuk komunikasi masuknya kontainer.	Yes
cpu	string	Konfigurasi CPU untuk agen yang dihosting.	Yes
environment_variables	objek	Variabel lingkungan untuk diatur dalam kontainer agen yang dihosting.	Tidak.
citra	string	ID gambar untuk agen, berlaku untuk agen yang dihosting berbasis gambar.	Tidak.
jenis	enum	Nilai yang mungkin: `hosted`	Yes
memori	string	Konfigurasi memori untuk agen yang dihosting.	Yes
rai_config	RaiConfig	Konfigurasi untuk fitur pemfilteran konten dan keamanan AI yang Bertanggung Jawab (RAI).	Tidak.
└─ rai_policy_name	string	Nama polis RAI yang akan diterapkan.	Yes
perangkat	array OpenAI.Tool	Array alat yang dapat dipanggil oleh model agen yang dihosting saat menghasilkan respons. Anda dapat menentukan alat mana yang akan digunakan dengan mengatur `tool_choice` parameter .	Tidak.

HourlyRecurrenceSchedule

Jadwal pengulangan per jam.

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

HumanEvaluationPreviewRuleAction

Tindakan aturan evaluasi untuk evaluasi manusia.

Nama	Tipe	Deskripsi	Diperlukan	Default
templatID	AssetId	Pengidentifikasi aset yang disimpan.	Yes
jenis	enum	Nilai yang mungkin: `humanEvaluationPreview`	Yes

Index

Definisi sumber daya indeks

Diskriminator untuk Indeks

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
`AzureSearch`	AzureAISearchIndex
`ManagedAzureSearch`	ManagedAzureAISearchIndex
`CosmosDBNoSqlVectorStore`	CosmosDBIndex

Nama	Tipe	Deskripsi	Diperlukan
id	string (baca-saja)	ID Aset, ID unik untuk aset	Tidak.
Nama	string (baca-saja)	Nama sumber daya	Yes
jenis	IndexType		Yes
versi	string (baca-saja)	Versi sumber daya	Yes

IndexType

Harta benda	Nilai
Jenis	string
Nilai	`AzureSearch` `CosmosDBNoSqlVectorStore` `ManagedAzureSearch`

IndexUpdate

Definisi sumber daya indeks

Diskriminator untuk IndexUpdate

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
`AzureSearch`	AzureAISearchIndexUpdate
`ManagedAzureSearch`	ManagedAzureAISearchIndexUpdate
`CosmosDBNoSqlVectorStore`	CosmosDBIndexUpdate

Nama	Tipe	Deskripsi	Diperlukan
deskripsi	string	Teks deskripsi aset.	Tidak.
tags	objek	Kamus tag. Tag dapat ditambahkan, dihapus, dan diperbarui.	Tidak.
jenis	IndexType		Yes

Wawasan

Isi respons untuk wawasan kluster.

Nama	Tipe	Deskripsi	Diperlukan
nama tampilan	string	Nama tampilan yang mudah digunakan untuk wawasan.	Yes
id	string (baca-saja)	Pengidentifikasi unik untuk laporan wawasan.	Yes
metadata	InsightsMetadata (baca-saja)	Metadata tentang wawasan.	Yes
└─ selesaiPada	string	Stempel waktu saat wawasan selesai.	Tidak.
└─ createAt	string	Stempel waktu saat wawasan dibuat.	Yes
permintaan	InsightRequest	Permintaan laporan wawasan.	Yes
└─ jenis	InsightType	Jenis permintaan.	Yes
hasil	InsightResult (baca-saja)	Hasil wawasan.	Tidak.
└─ jenis	InsightType	Jenis hasil wawasan.	Yes
state	Azure. Core.Foundations.OperationState (baca-saja)	Enum yang menjelaskan status operasi yang diizinkan.	Yes

InsightCluster

Kelompok sampel analisis.

Nama	Tipe	Deskripsi	Diperlukan
deskripsi	string	Deskripsi kluster analisis.	Yes
id	string	ID kluster analisis.	Yes
label	string	Label untuk kluster	Yes
Sampel	array InsightSample	Daftar sampel yang termasuk dalam kluster ini. Kosong jika sampel adalah bagian dari subkluster.	Tidak.
subKluster	array InsightCluster	Daftar subkluster dalam kluster ini. Kosong jika tidak ada subkluster.	Tidak.
saran	string	Saran untuk kluster	Yes
suggestionTitle	string	Judul saran untuk kluster	Yes
weight	bilangan bulat	Bobot kluster analisis. Ini menunjukkan jumlah sampel dalam kluster.	Yes

InsightModelConfiguration

Konfigurasi model yang digunakan dalam pembuatan wawasan.

Nama	Tipe	Deskripsi	Diperlukan	Default
modelDeploymentName	string	Penyebaran model yang akan dievaluasi. Menerima nama penyebaran saja atau dengan nama koneksi sebagai `{connectionName}/<modelDeploymentName>`.	Yes

InsightRequest

Permintaan laporan wawasan.

Diskriminator untuk InsightRequest

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
`EvaluationRunClusterInsight`	EvaluationRunClusterInsightRequest
`AgentClusterInsight`	AgentClusterInsightRequest
`EvaluationComparison`	EvaluationComparisonInsightRequest

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	InsightType	Permintaan wawasan.	Yes

InsightResult

Hasil wawasan.

Diskriminator untuk InsightResult

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
`EvaluationComparison`	EvaluationComparisonInsightResult
`EvaluationRunClusterInsight`	EvaluasiRunClusterInsightResult
`AgentClusterInsight`	AgentClusterInsightResult

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	InsightType	Permintaan wawasan.	Yes

InsightSample

Sampel dari analisis.

Diskriminator untuk InsightSample

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
`EvaluationResultSample`	EvaluationResultSample

Nama	Tipe	Deskripsi	Diperlukan
correlationInfo	objek	Info tentang korelasi untuk sampel analisis.	Yes
features	objek	Fitur untuk membantu pemfilteran data tambahan di UX.	Yes
id	string	Pengidentifikasi unik untuk sampel analisis.	Yes
jenis	SampleType	Jenis sampel yang digunakan dalam analisis.	Yes

InsightScheduleTask

Tugas wawasan untuk jadwal.

Nama	Tipe	Deskripsi	Diperlukan
konfigurasi	objek	Konfigurasi untuk tugas tersebut.	Tidak.
wawasan	Wawasan	Isi respons untuk wawasan kluster.	Yes
└─ displayName	string	Nama tampilan yang mudah digunakan untuk wawasan.	Yes
└─ ID	string (baca-saja)	Pengidentifikasi unik untuk laporan wawasan.	Yes
└─ metadata	InsightsMetadata (baca-saja)	Metadata tentang laporan wawasan.	Yes
└─ permintaan	InsightRequest	Permintaan analisis wawasan.	Yes
└─ hasil	InsightResult (baca-saja)	Hasil laporan wawasan.	Tidak.
└─ status	Azure. Core.Foundations.OperationState (baca-saja)	Keadaan wawasan saat ini.	Yes
jenis	enum	Nilai yang mungkin: `Insight`	Yes

InsightSummary

Ringkasan analisis kluster kesalahan.

Nama	Tipe	Deskripsi	Diperlukan
metode	string	Metode yang digunakan untuk pengelompokan.	Yes
sampleCount	bilangan bulat	Jumlah total sampel yang dianalisis.	Yes
uniqueClusterCount	bilangan bulat	Jumlah total kluster unik.	Yes
uniqueSubclusterCount	bilangan bulat	Jumlah total label subkluster unik.	Yes
usage	ClusterTokenUsage	Penggunaan token untuk analisis kluster	Yes
└─ inputTokenUsage	bilangan bulat	penggunaan token input	Yes
└─ outputTokenUsage	bilangan bulat	Penggunaan token keluaran	Yes
└─ totalTokenUsage	bilangan bulat	Total penggunaan token	Yes

InsightType

Permintaan wawasan.

Harta benda	Nilai
Deskripsi	Permintaan wawasan.
Jenis	string
Nilai	`EvaluationRunClusterInsight` `AgentClusterInsight` `EvaluationComparison`

InsightsMetadata

Metadata tentang wawasan.

Nama	Tipe	Deskripsi	Diperlukan	Default
completedAt	string	Stempel waktu saat wawasan selesai.	Tidak.
createAt	string	Stempel waktu saat wawasan dibuat.	Yes

ItemGenerationParams

Mewakili sekumpulan parameter yang digunakan untuk mengontrol operasi pembuatan item.

Diskriminator untuk ItemGenerationParams

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
`red_team`	RedTeamItemGenerationParams
`red_team_seed_prompts`	RedTeamSeedPromptsItemGenerationParams
`red_team_taxonomy`	RedTeamTaxonomyItemGenerationParams
`response_retrieval`	ResponseRetrievalItemGenerationParams

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	ItemGenerationParamsType	Jenis parameter untuk pembuatan item tim merah.	Yes

ItemGenerationParamsType

Jenis parameter untuk pembuatan item tim merah.

Harta benda	Nilai
Deskripsi	Jenis parameter untuk pembuatan item tim merah.
Jenis	string
Nilai	`red_team` `response_retrieval` `red_team_seed_prompts` `red_team_taxonomy` `synthetic_data_gen_preview`

ManagedAzureAISearchIndex

Definisi Indeks Azure AI Search Terkelola

Nama	Tipe	Deskripsi	Diperlukan
id	string (baca-saja)	ID Aset, ID unik untuk aset	Tidak.
Nama	string (baca-saja)	Nama sumber daya	Yes
jenis	enum	Jenis indeks Nilai yang mungkin: `ManagedAzureSearch`	Yes
versi	string (baca-saja)	Versi sumber daya	Yes

ManagedAzureAISearchIndexUpdate

Definisi Indeks Azure AI Search Terkelola

Nama	Tipe	Deskripsi	Diperlukan
deskripsi	string	Teks deskripsi aset.	Tidak.
tags	objek	Kamus tag. Tag dapat ditambahkan, dihapus, dan diperbarui.	Tidak.
jenis	enum	Jenis indeks Nilai yang mungkin: `ManagedAzureSearch`	Yes

MemoryItem

Item memori tunggal disimpan di penyimpanan memori, berisi konten dan metadata.

Diskriminator untuk MemoryItem

Komponen ini menggunakan properti kind untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
`user_profile`	UserProfileMemoryItem
`chat_summary`	ChatSummaryMemoryItem

Nama	Tipe	Deskripsi	Diperlukan
isi	string	Isi memori.	Yes
jenis	MemoryItemKind	Jenis item memori.	Yes
memory_id	string	ID unik item memori.	Yes
cakupan	string	Namespace yang secara logis mengelompokkan dan mengisolasi memori, seperti ID pengguna.	Yes
updated_at	bilangan bulat	Waktu pembaruan terakhir item memori.	Yes

MemoryItemKind

Jenis item memori.

Harta benda	Nilai
Deskripsi	Jenis item memori.
Jenis	string
Nilai	`user_profile` `chat_summary`

MemoryOperation

Mewakili operasi memori tunggal (membuat, memperbarui, atau menghapus) yang dilakukan pada item memori.

Nama	Tipe	Deskripsi	Diperlukan
jenis	MemoryOperationKind	Jenis operasi memori.	Yes
memory_item	MemoryItem	Item memori tunggal disimpan di penyimpanan memori, berisi konten dan metadata.	Yes
└─ konten	string	Isi memori.	Yes
└─ jenis	MemoryItemKind	Jenis item memori.	Yes
└─ memory_id	string	ID unik item memori.	Yes
└─ cakupan	string	Namespace yang secara logis mengelompokkan dan mengisolasi memori, seperti ID pengguna.	Yes
└─ updated_at	bilangan bulat	Waktu pembaruan terakhir item memori.	Yes

MemoryOperationKind

Jenis operasi memori.

Harta benda	Nilai
Deskripsi	Jenis operasi memori.
Jenis	string
Nilai	`create` `update` `delete`

MemorySearchItem

Item memori yang diambil dari pencarian memori.

Nama	Tipe	Deskripsi	Diperlukan
memory_item	MemoryItem	Item memori tunggal disimpan di penyimpanan memori, berisi konten dan metadata.	Yes
└─ konten	string	Isi memori.	Yes
└─ jenis	MemoryItemKind	Jenis item memori.	Yes
└─ memory_id	string	ID unik item memori.	Yes
└─ cakupan	string	Namespace yang secara logis mengelompokkan dan mengisolasi memori, seperti ID pengguna.	Yes
└─ updated_at	bilangan bulat	Waktu pembaruan terakhir item memori.	Yes

MemorySearchOptions

Opsi pencarian memori.

Nama	Tipe	Deskripsi	Diperlukan	Default
max_memories	bilangan bulat	Jumlah maksimum item memori yang akan dikembalikan.	Tidak.

MemorySearchPreviewTool

Alat untuk mengintegrasikan ingatan ke dalam agen.

Nama	Tipe	Deskripsi	Diperlukan	Default
memory_store_name	string	Nama penyimpanan memori yang akan digunakan.	Yes
cakupan	string	Namespace yang digunakan untuk mengelompokkan dan mengisolasi ingatan, seperti ID pengguna. Membatasi memori mana yang dapat diambil atau diperbarui. Gunakan variabel `{{$userId}}` khusus untuk menjangkau memori ke pengguna yang login saat ini.	Yes
search_options	MemorySearchOptions	Opsi pencarian memori.	Tidak.
└─ max_memories	bilangan bulat	Jumlah maksimum item memori yang akan dikembalikan.	Tidak.
jenis	enum	Jenis alat. Selalu `memory_search_preview`. Nilai yang mungkin: `memory_search_preview`	Yes
update_delay	bilangan bulat	Waktu menunggu sebelum memperbarui ingatan setelah tidak aktif (detik). Default 300.	Tidak.	300

MemorySearchToolCallItemParam

Nama	Tipe	Deskripsi	Diperlukan	Default
results	array MemorySearchItem	Hasil dikembalikan dari pencarian memori.	Tidak.
jenis	enum	Nilai yang mungkin: `memory_search_call`	Yes

MemorySearchToolCallItemResource

Nama	Tipe	Deskripsi	Diperlukan
agent_reference	AgentReference		Tidak.
└─ nama	string	Nama agen. Batasan: maxLength: 256	Yes
└─ jenis	enum	Nilai yang mungkin: `agent_reference`	Yes
└─ versi	string	Pengidentifikasi versi agen.	Tidak.
response_id	string	Respons tempat item dibuat.	Tidak.
results	array MemorySearchItem	Hasil dikembalikan dari pencarian memori.	Tidak.
status	enum	Status panggilan alat pencarian memori. Salah satu dari `in_progress`, `searching`, , `completedincomplete` atau `failed`, Nilai yang mungkin: `in_progress`, , `searchingcompleted`, `incomplete`,`failed`	Yes
jenis	enum	Nilai yang mungkin: `memory_search_call`	Yes

MemoryStoreDefaultDefinition

Implementasi penyimpanan memori default.

Nama	Tipe	Deskripsi	Diperlukan	Default
chat_model	string	Nama atau pengidentifikasi penyebaran model penyelesaian obrolan yang digunakan untuk pemrosesan memori.	Yes
embedding_model	string	Nama atau pengidentifikasi penyebaran model penyematan yang digunakan untuk pemrosesan memori.	Yes
jenis	enum	Jenis penyimpanan memori. Nilai yang mungkin: `default`	Yes
options	MemoryStoreDefaultOptions	Konfigurasi penyimpanan memori default.	Tidak.
└─ chat_summary_enabled	Boolean	Apakah akan mengaktifkan ekstraksi dan storage ringkasan obrolan. Nilai default adalah benar.	Yes	Benar
└─ user_profile_details	string	Kategori atau jenis informasi profil pengguna tertentu untuk diekstrak dan disimpan.	Tidak.
└─ user_profile_enabled	Boolean	Apakah akan mengaktifkan ekstraksi dan storage profil pengguna. Nilai default adalah benar.	Yes	Benar

MemoryStoreDefaultOptions

Konfigurasi penyimpanan memori default.

Nama	Tipe	Deskripsi	Diperlukan	Default
chat_summary_enabled	Boolean	Apakah akan mengaktifkan ekstraksi dan storage ringkasan obrolan. Nilai default adalah benar.	Yes	Benar
user_profile_details	string	Kategori atau jenis informasi profil pengguna tertentu untuk diekstrak dan disimpan.	Tidak.
user_profile_enabled	Boolean	Apakah akan mengaktifkan ekstraksi dan storage profil pengguna. Nilai default adalah benar.	Yes	Benar

MemoryStoreDefinition

Definisi dasar untuk konfigurasi penyimpanan memori.

Diskriminator untuk MemoryStoreDefinition

Komponen ini menggunakan properti kind untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
`default`	MemoryStoreDefaultDefinition

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	MemoryStoreKind	Jenis implementasi penyimpanan memori yang akan digunakan.	Yes

MemoryStoreDeleteScopeResponse

Respons untuk menghapus memori dari cakupan.

Nama	Tipe	Deskripsi	Diperlukan
dihapus	Boolean	Apakah operasi penghapusan berhasil.	Yes
Nama	string	Nama penyimpanan memori.	Yes
objek	enum	Jenis objek. Selalu 'memory_store.scope.deleted'. Nilai yang mungkin: `memory_store.scope.deleted`	Yes
cakupan	string	Ruang lingkup dari mana kenangan dihapus.	Yes

MemoryStoreKind

Jenis implementasi penyimpanan memori yang akan digunakan.

Harta benda	Nilai
Deskripsi	Jenis implementasi penyimpanan memori yang akan digunakan.
Jenis	string
Nilai	`default`

MemoryStoreObject

Penyimpanan memori yang dapat menyimpan dan mengambil memori pengguna.

Nama	Tipe	Deskripsi	Diperlukan
dibuat_pada	bilangan bulat	Stempel waktu Unix (detik) saat penyimpanan memori dibuat.	Yes
definisi	MemoryStoreDefinition	Definisi dasar untuk konfigurasi penyimpanan memori.	Yes
└─ jenis	MemoryStoreKind	Jenis penyimpanan memori.	Yes
deskripsi	string	Deskripsi penyimpanan memori yang dapat dibaca manusia. Batasan: maxLength: 512	Tidak.
id	string	Pengidentifikasi unik penyimpanan memori.	Yes
metadata	objek	Metadata nilai kunci arbitrer untuk dikaitkan dengan penyimpanan memori.	Tidak.
Nama	string	Nama penyimpanan memori. Batasan: maxLength: 256	Yes
objek	enum	Jenis objek, yang selalu 'memory_store'. Nilai yang mungkin: `memory_store`	Yes
updated_at	bilangan bulat	Stempel waktu Unix (detik) saat penyimpanan memori terakhir diperbarui.	Yes

MemoryStoreOperationUsage

Statistik penggunaan operasi penyimpanan memori.

Nama	Tipe	Deskripsi	Diperlukan
embedding_tokens	bilangan bulat	Jumlah token penyematan.	Yes
input_tokens	OpenAI.integer		Yes
input_tokens_details	OpenAI.ResponseUsageInputTokensDetails		Yes
└─ token_yang_di-cache	OpenAI.integer		Yes
output_tokens	OpenAI.integer		Yes
output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails		Yes
└─ token_penalaran	OpenAI.integer		Yes
total_tokens	OpenAI.integer		Yes

MemoryStoreSearchResponse

Respons pencarian memori.

Nama	Tipe	Deskripsi	Diperlukan
Kenangan	array MemorySearchItem	Item memori terkait ditemukan selama operasi pencarian.	Yes
search_id	string	ID unik permintaan pencarian ini. Gunakan nilai ini sebagai previous_search_id dalam permintaan berikutnya untuk melakukan pencarian bertahap.	Yes
usage	MemoryStoreOperationUsage	Statistik penggunaan operasi penyimpanan memori.	Yes
└─ embedding_tokens	bilangan bulat	Jumlah token penyematan.	Yes
└─ token_masukan	OpenAI.integer	Jumlah token input.	Yes
└─ detil_token_masukan	OpenAI.ResponseUsageInputTokensDetails	Perincian terperinci dari token input.	Yes
└─ output_tokens	OpenAI.integer	Jumlah token output.	Yes
└─ output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails	Perincian terperinci dari token output.	Yes
└─ jumlah_token	OpenAI.integer	Jumlah total token yang digunakan.	Yes

MemoryStoreUpdateCompletedResult

Hasil pembaruan memori.

Nama	Tipe	Deskripsi	Diperlukan
memory_operations	array MemoryOperation	Daftar operasi memori individual yang dilakukan selama pembaruan.	Yes
usage	MemoryStoreOperationUsage	Statistik penggunaan operasi penyimpanan memori.	Yes
└─ embedding_tokens	bilangan bulat	Jumlah token penyematan.	Yes
└─ token_masukan	OpenAI.integer	Jumlah token input.	Yes
└─ detil_token_masukan	OpenAI.ResponseUsageInputTokensDetails	Perincian terperinci dari token input.	Yes
└─ output_tokens	OpenAI.integer	Jumlah token output.	Yes
└─ output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails	Perincian terperinci dari token output.	Yes
└─ jumlah_token	OpenAI.integer	Jumlah total token yang digunakan.	Yes

MemoryStoreUpdateResponse

Menyediakan status operasi pembaruan penyimpanan memori.

Nama	Tipe	Deskripsi	Diperlukan
galat	OpenAI.Error		Tidak.
└─ tambahan Info	objek		Tidak.
└─ kode	string (dapat diakses NULL)		Yes
└─ debugInfo	objek		Tidak.
└─ detail	array OpenAI.Error		Tidak.
└─ pesan	string		Yes
└─ param	string (dapat diakses NULL)		Tidak.
└─ jenis	string		Tidak.
hasil	MemoryStoreUpdateCompletedResult	Hasil pembaruan memori.	Tidak.
└─ memory_operations	array MemoryOperation	Daftar operasi memori individual yang dilakukan selama pembaruan.	Yes
└─ penggunaan	MemoryStoreOperationUsage	Statistik penggunaan yang terkait dengan operasi pembaruan memori.	Yes
status	MemoryStoreUpdateStatus	Status operasi pembaruan penyimpanan memori.	Yes
superseded_by	string	update_id operasi digantikan oleh ketika status "digantikan".	Tidak.
update_id	string	ID unik permintaan pembaruan ini. Gunakan nilai ini sebagai previous_update_id dalam permintaan berikutnya untuk melakukan pembaruan bertahap.	Yes

MemoryStoreUpdateStatus

Status operasi pembaruan penyimpanan memori.

Harta benda	Nilai
Jenis	string
Nilai	`queued` `in_progress` `completed` `failed` `superseded`

MicrosoftFabricPreviewTool

Informasi definisi input untuk alat Microsoft Fabric seperti yang digunakan untuk mengonfigurasi agen.

Nama	Tipe	Deskripsi	Diperlukan
fabric_dataagent_preview	FabricDataAgentToolParameters	Parameter alat agen data fabric.	Yes
└─ project_connections	array ToolProjectConnection	Koneksi project yang terpasang pada alat ini. Mungkin ada maksimal 1 koneksi sumber daya yang dilampirkan ke alat. Batasan: maxItems: 1	Tidak.
jenis	enum	Jenis objek, yang selalu 'fabric_dataagent_preview'. Nilai yang mungkin: `fabric_dataagent_preview`	Yes

ModelDeployment

Definisi Penerapan Model

Nama	Tipe	Deskripsi	Diperlukan
capabilities	objek (baca-saja)	Kemampuan model yang disebarkan	Yes
connectionName	string (baca-saja)	Nama koneksi dari mana penyebaran berasal	Tidak.
modelName	string (baca-saja)	Nama khusus Publisher dari model yang disebarkan	Yes
modelPublisher	string (baca-saja)	Nama publisher model yang disebarkan	Yes
modelVersion	string (baca-saja)	Versi khusus Publisher dari model yang disebarkan	Yes
Nama	string (baca-saja)	Nama penyebaran	Yes
sku	Sku (baca-saja)	Informasi Sku	Yes
└─ kapasitas	bilangan bulat	Kapasitas Sku	Yes
└─ keluarga	string	Keluarga Sku	Yes
└─ nama	string	Nama Sku	Yes
└─ ukuran	string	Ukuran Sku	Yes
└─ tingkat	string	Tingkat Sku	Yes
jenis	enum	Jenis penyebaran Nilai yang mungkin: `ModelDeployment`	Yes

ModelSamplingParams

Mewakili sekumpulan parameter yang digunakan untuk mengontrol perilaku pengambilan sampel model bahasa selama pembuatan teks.

Nama	Tipe	Deskripsi	Diperlukan
max_completion_tokens	bilangan bulat	Jumlah maksimum token yang diizinkan dalam penyelesaian.	Yes
seed	bilangan bulat	Benih acak untuk reproduksi.	Yes
suhu	nomor/angka	Parameter suhu untuk pengambilan sampel.	Yes
top_p	nomor/angka	Parameter top-p untuk pengambilan sampel nukleus.	Yes

ModelSamplingParamsUpdate

Mewakili sekumpulan parameter yang digunakan untuk mengontrol perilaku pengambilan sampel model bahasa selama pembuatan teks.

Nama	Tipe	Deskripsi	Diperlukan
max_completion_tokens	bilangan bulat	Jumlah maksimum token yang diizinkan dalam penyelesaian.	Tidak.
seed	bilangan bulat	Benih acak untuk reproduksi.	Tidak.
suhu	nomor/angka	Parameter suhu untuk pengambilan sampel.	Tidak.
top_p	nomor/angka	Parameter top-p untuk pengambilan sampel nukleus.	Tidak.

MonthlyRecurrenceSchedule

Jadwal pengulangan bulanan.

Nama	Tipe	Deskripsi	Diperlukan	Default
daysOfMonth	array bilangan bulat	Hari dalam sebulan untuk jadwal pengulangan.	Yes
jenis	enum	Jenis kekambuhan bulanan. Nilai yang mungkin: `Monthly`	Yes

NoAuthenticationCredentials

Kredensial yang tidak memerlukan autentikasi

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	enum	Jenis kredensial Nilai yang mungkin: `None`	Yes

OAuthConsentRequestOutputItem

Permintaan dari layanan agar pengguna melakukan persetujuan OAuth.

Nama	Tipe	Deskripsi	Diperlukan
agent_reference	AgentReference		Tidak.
└─ nama	string	Nama agen. Batasan: maxLength: 256	Yes
└─ jenis	enum	Nilai yang mungkin: `agent_reference`	Yes
└─ versi	string	Pengidentifikasi versi agen.	Tidak.
consent_link	string	Tautan yang dapat digunakan pengguna untuk melakukan persetujuan OAuth.	Yes
id	string		Yes
response_id	string	Respons tempat item dibuat.	Tidak.
server_label	string	Label server untuk permintaan persetujuan OAuth.	Yes
jenis	enum	Nilai yang mungkin: `oauth_consent_request`	Yes

OneTimeTrigger

Pemicu satu kali.

Nama	Tipe	Deskripsi	Diperlukan	Default
zona waktu	string	Zona waktu untuk pemicu satu kali.	Tidak.	UTC
triggerAt	string	Tanggal dan waktu untuk pemicu satu kali dalam format ISO 8601.	Yes
jenis	enum	Nilai yang mungkin: `OneTime`	Yes

OpenAI.Annotation

Anotasi yang berlaku untuk rentang teks output.

Diskriminator untuk OpenAI.Anotasi

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
`file_citation`	OpenAI.FileCitationBody
`url_citation`	OpenAI.UrlCitationBody
`container_file_citation`	OpenAI.ContainerFileCitationBody
`file_path`	OpenAI.FilePath

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	OpenAI.AnnotationType		Yes

OpenAI.AnnotationType

Harta benda	Nilai
Jenis	string
Nilai	`file_citation` `url_citation` `container_file_citation` `file_path`

OpenAI.ApplyPatchCallOutputStatus

Harta benda	Nilai
Jenis	string
Nilai	`completed` `failed`

OpenAI.ApplyPatchCallOutputStatusParam

Nilai hasil yang dilaporkan untuk output panggilan alat apply_patch.

Harta benda	Nilai
Jenis	string
Nilai	`completed` `failed`

OpenAI.ApplyPatchCallStatus

Harta benda	Nilai
Jenis	string
Nilai	`in_progress` `completed`

OpenAI.ApplyPatchCallStatusParam

Nilai status yang dilaporkan untuk panggilan alat apply_patch.

Harta benda	Nilai
Jenis	string
Nilai	`in_progress` `completed`

OpenAI.ApplyPatchCreateFileOperation

Instruksi yang menjelaskan cara membuat file melalui alat apply_patch.

Nama	Tipe	Deskripsi	Diperlukan
Diff	string	Diff untuk diterapkan.	Yes
path	string	Jalur file yang akan dibuat.	Yes
jenis	enum	Buat file baru dengan diff yang disediakan. Nilai yang mungkin: `create_file`	Yes

OpenAI.ApplyPatchCreateFileOperationParam

Instruksi untuk membuat file baru melalui alat apply_patch.

Nama	Tipe	Deskripsi	Diperlukan
Diff	string	Konten diff terpadu untuk diterapkan saat membuat file. Batasan: maxLength: 10485760	Yes
path	string	Jalur file yang akan dibuat relatif terhadap akar ruang kerja. Batasan: minLength: 1	Yes
jenis	enum	Jenis operasi. Selalu `create_file`. Nilai yang mungkin: `create_file`	Yes

OpenAI.ApplyPatchDeleteFileOperation

Instruksi yang menjelaskan cara menghapus file melalui alat apply_patch.

Nama	Tipe	Deskripsi	Diperlukan	Default
path	string	Jalur file yang akan dihapus.	Yes
jenis	enum	Hapus file yang ditentukan. Nilai yang mungkin: `delete_file`	Yes

OpenAI.ApplyPatchDeleteFileOperationParam

Instruksi untuk menghapus file yang ada melalui alat apply_patch.

Nama	Tipe	Deskripsi	Diperlukan	Default
path	string	Jalur file yang akan dihapus relatif terhadap akar ruang kerja. Batasan: minLength: 1	Yes
jenis	enum	Jenis operasi. Selalu `delete_file`. Nilai yang mungkin: `delete_file`	Yes

OpenAI.ApplyPatchFileOperation

Salah satu operasi create_file, delete_file, atau update_file diterapkan melalui apply_patch.

Diskriminator untuk OpenAI.ApplyPatchFileOperation

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
`create_file`	OpenAI.ApplyPatchCreateFileOperation
`delete_file`	OpenAI.ApplyPatchDeleteFileOperation
`update_file`	OpenAI.ApplyPatchUpdateFileOperation

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	OpenAI.ApplyPatchFileOperationType		Yes

OpenAI.ApplyPatchFileOperationType

Harta benda	Nilai
Jenis	string
Nilai	`create_file` `delete_file` `update_file`

OpenAI.ApplyPatchOperationParam

Salah satu operasi create_file, delete_file, atau update_file yang dipasok ke alat apply_patch.

Diskriminator untuk OpenAI.ApplyPatchOperationParam

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
`create_file`	OpenAI.ApplyPatchCreateFileOperationParam
`delete_file`	OpenAI.ApplyPatchDeleteFileOperationParam
`update_file`	OpenAI.ApplyPatchUpdateFileOperationParam

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	OpenAI.ApplyPatchOperationParamType		Yes

OpenAI.ApplyPatchOperationParamType

Harta benda	Nilai
Jenis	string
Nilai	`create_file` `delete_file` `update_file`

OpenAI.ApplyPatchToolParam

Mengizinkan asisten membuat, menghapus, atau memperbarui file menggunakan perbedaan terpadu.

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	enum	Jenis alat. Selalu `apply_patch`. Nilai yang mungkin: `apply_patch`	Yes

OpenAI.ApplyPatchUpdateFileOperation

Instruksi yang menjelaskan cara memperbarui file melalui alat apply_patch.

Nama	Tipe	Deskripsi	Diperlukan
Diff	string	Diff untuk diterapkan.	Yes
path	string	Jalur file yang akan diperbarui.	Yes
jenis	enum	Perbarui file yang ada dengan diff yang disediakan. Nilai yang mungkin: `update_file`	Yes

OpenAI.ApplyPatchUpdateFileOperationParam

Instruksi untuk memperbarui file yang ada melalui alat apply_patch.

Nama	Tipe	Deskripsi	Diperlukan
Diff	string	Konten diff terpadu untuk diterapkan ke file yang ada. Batasan: maxLength: 10485760	Yes
path	string	Jalur file yang akan diperbarui relatif terhadap akar ruang kerja. Batasan: minLength: 1	Yes
jenis	enum	Jenis operasi. Selalu `update_file`. Nilai yang mungkin: `update_file`	Yes

OpenAI.ApproximateLocation

Nama	Tipe	Deskripsi	Diperlukan
kota	string (dapat diakses NULL)		Tidak.
country	string (dapat diakses NULL)		Tidak.
region	string (dapat diakses NULL)		Tidak.
zona waktu	string (dapat diakses NULL)		Tidak.
jenis	enum	Jenis perkiraan lokasi. Selalu `approximate`. Nilai yang mungkin: `approximate`	Yes

OpenAI.ChatCompletionTool

Alat fungsi yang dapat digunakan untuk menghasilkan respons.

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

OpenAI.ChatModel

Harta benda Nilai

Jenis string

Nilai gpt-5.2
gpt-5.2-2025-12-11
gpt-5.2-chat-latest
gpt-5.2-pro
gpt-5.2-pro-2025-12-11
gpt-5.1
gpt-5.1-2025-11-13
gpt-5.1-codex
gpt-5.1-mini
gpt-5.1-chat-latest
gpt-5
gpt-5-mini
gpt-5-nano
gpt-5-2025-08-07
gpt-5-mini-2025-08-07
gpt-5-nano-2025-08-07
gpt-5-chat-latest
gpt-4.1
gpt-4.1-mini
gpt-4.1-nano
gpt-4.1-2025-04-14
gpt-4.1-mini-2025-04-14
gpt-4.1-nano-2025-04-14
o4-mini
o4-mini-2025-04-16
o3
o3-2025-04-16
o3-mini
o3-mini-2025-01-31
o1
o1-2024-12-17
o1-preview
o1-preview-2024-09-12
o1-mini
o1-mini-2024-09-12
gpt-4o
gpt-4o-2024-11-20
gpt-4o-2024-08-06
gpt-4o-2024-05-13
gpt-4o-audio-preview
gpt-4o-audio-preview-2024-10-01
gpt-4o-audio-preview-2024-12-17
gpt-4o-audio-preview-2025-06-03
gpt-4o-mini-audio-preview
gpt-4o-mini-audio-preview-2024-12-17
gpt-4o-search-preview
gpt-4o-mini-search-preview
gpt-4o-search-preview-2025-03-11
gpt-4o-mini-search-preview-2025-03-11
chatgpt-4o-latest
codex-mini-latest
gpt-4o-mini
gpt-4o-mini-2024-07-18
gpt-4-turbo
gpt-4-turbo-2024-04-09
gpt-4-0125-preview
gpt-4-turbo-preview
gpt-4-1106-preview
gpt-4-vision-preview
gpt-4
gpt-4-0314
gpt-4-0613
gpt-4-32k
gpt-4-32k-0314
gpt-4-32k-0613
gpt-3.5-turbo
gpt-3.5-turbo-16k
gpt-3.5-turbo-0301
gpt-3.5-turbo-0613
gpt-3.5-turbo-1106
gpt-3.5-turbo-0125
gpt-3.5-turbo-16k-0613

OpenAI.ClickButtonType

Harta benda	Nilai
Jenis	string
Nilai	`left` `right` `wheel` `back` `forward`

OpenAI.ClickParam

Sebuah tindakan klik.

Nama	Tipe	Deskripsi	Diperlukan
tombol	OpenAI.ClickButtonType		Yes
jenis	enum	Menentukan jenis peristiwa. Untuk tindakan klik, properti ini selalu `click`. Nilai yang mungkin: `click`	Yes
x	OpenAI.integer		Yes
y	OpenAI.integer		Yes

OpenAI.CodeInterpreterContainerAuto

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

Nama	Tipe	Deskripsi	Diperlukan
file_ids	array string	Daftar opsional file yang diunggah untuk tersedia untuk kode Anda.	Tidak.
batas_memori	OpenAI.ContainerMemoryLimit (dapat diberisi dengan null)		Tidak.
jenis	enum	Selalu `auto`. Nilai yang mungkin: `auto`	Yes

OpenAI.CodeInterpreterOutputImage

Output gambar dari penerjemah kode.

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	enum	Jenis output. Selalu `image`. 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 `logs`. Nilai yang mungkin: `logs`	Yes

OpenAI.CodeInterpreterTool

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

Nama	Tipe	Deskripsi	Diperlukan	Default
container	string atau OpenAI.CodeInterpreterContainerAuto	Kontainer penerjemah kode. Dapat berupa ID kontainer atau objek yang menentukan ID file yang diunggah untuk tersedia untuk kode Anda, bersama dengan pengaturan opsional `memory_limit` . Jika tidak disediakan, layanan mengasumsikan otomatis.	Tidak.
jenis	enum	Jenis alat penerjemah kode. Selalu `code_interpreter`. Nilai yang mungkin: `code_interpreter`	Yes

OpenAI.CompactResource

Nama	Tipe	Deskripsi	Diperlukan
dibuat_pada	bilangan bulat	Tanda waktu Unix (dalam detik) saat percakapan yang dikompresi dibuat.	Yes
id	string	Pengidentifikasi unik untuk respons yang dikompresi.	Yes
objek	enum	Jenis objek. Selalu `response.compaction`. Nilai yang mungkin: `response.compaction`	Yes
output	array OpenAI.OutputItem	Daftar item output yang dikompresi. Ini adalah daftar semua pesan pengguna, diikuti oleh satu item pemadatan.	Yes
usage	OpenAI.ResponseUsage	Merinci detail penggunaan token termasuk token input, token output, perincian token output, dan total token yang digunakan.	Yes
└─ token_masukan	OpenAI.integer	Jumlah token input.	Yes
└─ detil_token_masukan	OpenAI.ResponseUsageInputTokensDetails	Perincian terperinci dari token input.	Yes
└─ output_tokens	OpenAI.integer	Jumlah token output.	Yes
└─ output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails	Perincian terperinci dari token output.	Yes
└─ jumlah_token	OpenAI.integer	Jumlah total token yang digunakan.	Yes

OpenAI.CompactResponseMethodPublicBody

Nama	Tipe	Deskripsi	Diperlukan
Masukan	string atau array OpenAI.InputItem		Tidak.
instructions	string (dapat diakses NULL)		Tidak.
model	OpenAI.ModelIdsCompaction	ID model yang digunakan untuk menghasilkan respons, seperti `gpt-5` atau `o3`. OpenAI menawarkan berbagai model dengan kemampuan, karakteristik performa, dan titik harga yang berbeda. Lihat panduan model untuk menelusuri dan membandingkan model yang tersedia.	Yes
previous_response_id	string (dapat diakses NULL)		Tidak.

OpenAI.ComparisonFilter

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

Nama	Tipe	Deskripsi	Diperlukan
kunci	string	Kunci pembanding terhadap nilai.	Yes
jenis	enum	Menentukan operator perbandingan: `eq`, , `ne`, `gtgteltlteinnin` - `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 - `in`:In - `nin`: tidak dalam Nilai yang mungkin: `eq`, , `negt`, `gte`, `lt`,`lte`	Yes
nilai	string atau OpenAI.numeric atau boolean atau array OpenAI.ComparisonFilterValueItems	Nilai untuk dibandingkan dengan kunci atribut; mendukung jenis string, angka, atau boolean.	Yes

OpenAI.ComparisonFilterValueItems

Jenis: string atau OpenAI.numeric

OpenAI.CompoundFilter

Gabungkan beberapa filter menggunakan and atau or.

Nama	Tipe	Deskripsi	Diperlukan	Default
filters	array OpenAI.ComparisonFilter atau objek	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.ClickParam
`double_click`	OpenAI.DoubleClickAction
`drag`	OpenAI.Drag
`keypress`	OpenAI.KeyPressAction
`move`	OpenAI.Move
`screenshot`	OpenAI.Screenshot
`scroll`	OpenAI.Scroll
`type`	OpenAI.Type
`wait`	OpenAI.Wait

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	OpenAI.ComputerActionType		Yes

OpenAI.ComputerActionType

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

OpenAI.ComputerCallSafetyCheckParam

Pemeriksaan keamanan tertunda untuk panggilan komputer.

Nama	Tipe	Deskripsi	Diperlukan
kode	string (dapat diakses NULL)		Tidak.
id	string	ID pemeriksaan keamanan yang tertunda.	Yes
pesan	string (dapat diakses NULL)		Tidak.

OpenAI.ComputerEnvironment

Harta benda	Nilai
Jenis	string
Nilai	`windows` `mac` `linux` `ubuntu` `browser`

OpenAI.ComputerScreenshotContent

Cuplikan layar komputer.

Nama	Tipe	Deskripsi	Diperlukan
file_id	string (dapat diakses NULL)		Yes
image_url	string		Yes
jenis	enum	Menentukan jenis peristiwa. Untuk cuplikan layar komputer, properti ini selalu diatur ke `computer_screenshot`. Nilai yang mungkin: `computer_screenshot`	Yes

OpenAI.ComputerScreenshotImage

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

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

OpenAI.AlatPratinjauPenggunaanKomputer

Alat yang mengontrol komputer virtual.

Nama	Tipe	Deskripsi	Diperlukan
tinggi_tampilan	OpenAI.integer		Yes
lebar_tampilan	OpenAI.integer		Yes
environment	OpenAI.ComputerEnvironment		Yes
jenis	enum	Jenis alat penggunaan komputer. Selalu `computer_use_preview`. Nilai yang mungkin: `computer_use_preview`	Yes

OpenAI.ContainerFileCitationBody

Kutipan untuk file kontainer yang digunakan untuk menghasilkan respons model.

Nama	Tipe	Deskripsi	Diperlukan
container_id	string	ID file kontainer.	Yes
end_index	OpenAI.integer		Yes
file_id	string	ID file.	Yes
filename	string	Nama file dari file kontainer yang dikutip.	Yes
start_index	OpenAI.integer		Yes
jenis	enum	Jenis kutipan file kontainer. Selalu `container_file_citation`. Nilai yang mungkin: `container_file_citation`	Yes

OpenAI.ContainerMemoryLimit

Harta benda	Nilai
Jenis	string
Nilai	`1g` `4g` `16g` `64g`

OpenAI.ConversationItem

Satu item dalam percakapan. Kumpulan jenis yang mungkin sama dengan output jenis objek Respons.

Diskriminator untuk OpenAI.ConversationItem

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
`message`	OpenAI.ConversationItemMessage
`function_call`	OpenAI.ConversationItemFunctionToolCallResource
`function_call_output`	OpenAI.ConversationItemFunctionToolCallOutputResource
`file_search_call`	OpenAI.ConversationItemFileSearchToolCall
`web_search_call`	OpenAI.ConversationItemWebSearchToolCall
`image_generation_call`	OpenAI.ConversationItemImageGenToolCall
`computer_call`	OpenAI.ConversationItemComputerToolCall
`computer_call_output`	OpenAI.ConversationItemComputerToolCallOutputResource
`reasoning`	OpenAI.ConversationItemReasoningItem
`code_interpreter_call`	OpenAI.ConversationItemCodeInterpreterToolCall
`local_shell_call`	OpenAI.ConversationItemLocalShellToolCall
`local_shell_call_output`	OpenAI.ConversationItemLocalShellToolCallOutput
`shell_call`	OpenAI.ConversationItemFunctionShellCall
`shell_call_output`	OpenAI.ConversationItemFunctionShellCallOutput
`apply_patch_call`	OpenAI.ConversationItemApplyPatchToolCall
`apply_patch_call_output`	OpenAI.ConversationItemApplyPatchToolCallOutput
`mcp_list_tools`	OpenAI.ConversationItemMcpListTools
`mcp_approval_request`	OpenAI.ConversationItemMcpApprovalRequest
`mcp_approval_response`	OpenAI.ConversationItemMcpApprovalResponseResource
`mcp_call`	OpenAI.ConversationItemMcpToolCall
`custom_tool_call`	OpenAI.ConversationItemCustomToolCall
`custom_tool_call_output`	OpenAI.ConversationItemCustomToolCallOutput

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	OpenAI.ConversationItemType		Yes

OpenAI.ConversationItemApplyPatchToolCall

Panggilan alat yang menerapkan perbedaan file dengan membuat, menghapus, atau memperbarui file.

Nama	Tipe	Deskripsi	Diperlukan
call_id	string	ID unik dari panggilan alat patch terapkan yang dihasilkan oleh model.	Yes
dibuat oleh	string	ID entitas yang membuat panggilan alat ini.	Tidak.
id	string	ID unik dari panggilan alat terapkan patch. Diisi saat item ini dikembalikan melalui API.	Yes
operasi	OpenAI.ApplyPatchFileOperation	Salah satu operasi create_file, delete_file, atau update_file diterapkan melalui apply_patch.	Yes
└─ jenis	OpenAI.ApplyPatchFileOperationType		Yes
status	OpenAI.ApplyPatchCallStatus		Yes
jenis	enum	Jenis item. Selalu `apply_patch_call`. Nilai yang mungkin: `apply_patch_call`	Yes

OpenAI.ConversationItemApplyPatchToolCallOutput

Output yang dipancarkan oleh panggilan alat patch terapkan.

Nama	Tipe	Deskripsi	Diperlukan
call_id	string	ID unik dari panggilan alat patch terapkan yang dihasilkan oleh model.	Yes
dibuat oleh	string	ID entitas yang membuat output panggilan alat ini.	Tidak.
id	string	ID unik dari output panggilan alat terapkan patch. Diisi saat item ini dikembalikan melalui API.	Yes
output	string (dapat diakses NULL)		Tidak.
status	OpenAI.ApplyPatchCallOutputStatus		Yes
jenis	enum	Jenis item. Selalu `apply_patch_call_output`. Nilai yang mungkin: `apply_patch_call_output`	Yes

OpenAI.ConversationItemCodeInterpreterToolCall

Panggilan alat untuk menjalankan kode.

Nama	Tipe	Deskripsi	Diperlukan
kode	string (dapat diakses NULL)		Yes
container_id	string	ID kontainer yang digunakan untuk menjalankan kode.	Yes
id	string	ID unik dari panggilan alat penerjemah kode.	Yes
Keluaran	array OpenAI.CodeInterpreterOutputLogs atau OpenAI.CodeInterpreterOutputImage		Yes
status	enum	Status panggilan alat penerjemah kode. Nilai yang valid adalah `in_progress`, `completed`, `incomplete`, `interpreting`, dan `failed`. Nilai yang mungkin: `in_progress`, , `completedincomplete`, `interpreting`,`failed`	Yes
jenis	enum	Jenis panggilan alat penerjemah kode. Selalu `code_interpreter_call`. Nilai yang mungkin: `code_interpreter_call`	Yes

OpenAI.ConversationItemComputerToolCall

Panggilan alat ke alat penggunaan komputer. Lihat panduan penggunaan komputer komputer untuk informasi lebih lanjut.

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

OpenAI.ConversationItemComputerToolCallOutputResource

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

OpenAI.ConversationItemCustomToolCall

Panggilan ke alat kustom yang dibuat oleh model.

Nama	Tipe	Deskripsi	Diperlukan
call_id	string	Pengidentifikasi yang digunakan untuk memetakan panggilan alat kustom ini ke output panggilan alat.	Yes
id	string	ID unik dari panggilan alat khusus di platform OpenAI.	Tidak.
Masukan	string	Input untuk panggilan alat kustom yang dihasilkan oleh model.	Yes
Nama	string	Nama perangkat kustom yang dipanggil.	Yes
jenis	enum	Jenis panggilan alat kustom. Selalu `custom_tool_call`. Nilai yang mungkin: `custom_tool_call`	Yes

OpenAI.ConversationItemCustomToolCallOutput

Output dari panggilan alat kustom dari kode Anda, dikirim kembali ke model.

Nama	Tipe	Deskripsi	Diperlukan
call_id	string	ID panggilan, digunakan untuk memetakan output panggilan alat kustom ini ke panggilan alat kustom.	Yes
id	string	ID unik dari output panggilan alat khusus di platform OpenAI.	Tidak.
output	string atau array OpenAI.FunctionAndCustomToolCallOutput	Output dari panggilan alat kustom yang dihasilkan oleh kode Anda. Dapat berupa string atau daftar konten output.	Yes
jenis	enum	Jenis output panggilan alat kustom. Selalu `custom_tool_call_output`. Nilai yang mungkin: `custom_tool_call_output`	Yes

OpenAI.ConversationItemFileSearchToolCall

Hasil panggilan alat pencarian file. Lihat panduan pencarian file file untuk informasi selengkapnya.

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

OpenAI.ConversationItemFunctionShellCall

Panggilan alat yang menjalankan satu atau beberapa perintah shell di lingkungan terkelola.

Nama	Tipe	Deskripsi	Diperlukan
tindakan	OpenAI.FunctionShellAction	Jalankan perintah shell.	Yes
└─ perintah	array string		Yes
└─ max_output_length	OpenAI.integer (dapat diakses dengan null)		Yes
└─ timeout_ms	OpenAI.integer (dapat diakses dengan null)		Yes
call_id	string	ID unik panggilan alat shell yang dihasilkan oleh model.	Yes
dibuat oleh	string	ID entitas yang membuat panggilan alat ini.	Tidak.
id	string	ID unik panggilan alat shell. Diisi saat item ini dikembalikan melalui API.	Yes
status	OpenAI.LocalShellCallStatus		Yes
jenis	enum	Jenis item. Selalu `shell_call`. Nilai yang mungkin: `shell_call`	Yes

OpenAI.ConversationItemFunctionShellCallOutput

Output panggilan alat shell yang dipancarkan.

Nama	Tipe	Deskripsi	Diperlukan
call_id	string	ID unik panggilan alat shell yang dihasilkan oleh model.	Yes
dibuat oleh	string	Pengidentifikasi aktor yang membuat item.	Tidak.
id	string	ID unik dari output panggilan shell. Diisi saat item ini dikembalikan melalui API.	Yes
max_output_length	OpenAI.integer (dapat diakses dengan null)		Yes
output	array OpenAI.FunctionShellCallOutputContent	Array konten output panggilan shell	Yes
jenis	enum	Jenis output panggilan shell. Selalu `shell_call_output`. Nilai yang mungkin: `shell_call_output`	Yes

OpenAI.ConversationItemFunctionToolCallOutputResource

Nama	Tipe	Deskripsi	Diperlukan
call_id	string	ID unik dari panggilan alat fungsional yang dihasilkan oleh model.	Yes
id	string	ID unik dari keluaran panggilan peranti fungsi. Diisi ketika item ini dikembalikan melalui API.	Tidak.
output	string atau array OpenAI.FunctionAndCustomToolCallOutput	Output dari panggilan fungsi yang dihasilkan oleh kode Anda. Dapat berupa string atau daftar konten output.	Yes
status	enum	Status barang tersebut. Salah satu dari `in_progress`, `completed`, atau `incomplete`. Diisi saat item dikembalikan melalui API. Nilai yang mungkin: `in_progress`, `completed`, `incomplete`	Tidak.
jenis	enum	Jenis keluaran panggilan fungsi perangkat. Selalu `function_call_output`. Nilai yang mungkin: `function_call_output`	Yes

OpenAI.ConversationItemFunctionToolCallResource

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

OpenAI.ConversationItemImageGenToolCall

Permintaan pembuatan gambar yang dibuat oleh model.

Nama	Tipe	Deskripsi	Diperlukan
id	string	ID unik panggilan pembuatan gambar.	Yes
hasil	string (dapat diakses NULL)		Yes
status	enum	Status panggilan pembuatan gambar. Nilai yang mungkin: `in_progress`, `completed`, `generating`, `failed`	Yes
jenis	enum	Jenis panggilan pembuatan gambar. Selalu `image_generation_call`. Nilai yang mungkin: `image_generation_call`	Yes

OpenAI.ConversationItemList

Daftar item Percakapan.

Nama	Tipe	Deskripsi	Diperlukan
data	array OpenAI.ConversationItem	Daftar item percakapan.	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.ConversationItemLocalShellToolCall

Panggilan alat untuk menjalankan perintah pada shell lokal.

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

OpenAI.ConversationItemLocalShellToolCallOutput

Output panggilan alat shell lokal.

Nama	Tipe	Deskripsi	Diperlukan
id	string	ID unik dari panggilan alat shell lokal yang dihasilkan oleh model.	Yes
output	string	String JSON dari output panggilan alat shell lokal.	Yes
status	enum	Nilai yang mungkin: `in_progress`, `completed`, `incomplete`	Tidak.
jenis	enum	Jenis output panggilan alat shell lokal. Selalu `local_shell_call_output`. Nilai yang mungkin: `local_shell_call_output`	Yes

OpenAI.ConversationItemMcpApprovalRequest

Permintaan persetujuan dari manusia untuk penggunaan alat.

Nama	Tipe	Deskripsi	Diperlukan
argumen	string	String argumen JSON untuk alat ini.	Yes
id	string	ID unik permintaan persetujuan.	Yes
Nama	string	Nama alat yang akan dijalankan.	Yes
server_label	string	Label server MCP yang membuat permintaan.	Yes
jenis	enum	Jenis item. Selalu `mcp_approval_request`. Nilai yang mungkin: `mcp_approval_request`	Yes

OpenAI.ConversationItemMcpApprovalResponseResource

Respons terhadap permintaan persetujuan MCP.

Nama	Tipe	Deskripsi	Diperlukan
approval_request_id	string	ID permintaan persetujuan yang dijawab.	Yes
approve	Boolean	Apakah permintaan disetujui.	Yes
id	string	ID unik respons persetujuan	Yes
alasan	string (dapat diakses NULL)		Tidak.
jenis	enum	Jenis item. Selalu `mcp_approval_response`. Nilai yang mungkin: `mcp_approval_response`	Yes

OpenAI.ConversationItemMcpListTools

Daftar alat yang tersedia di server MCP.

Nama	Tipe	Deskripsi	Diperlukan
galat	string (dapat diakses NULL)		Tidak.
id	string	ID unik daftar.	Yes
server_label	string	Label MCP server.	Yes
perangkat	array OpenAI.MCPListToolsToolsTool	Alat yang tersedia di server.	Yes
jenis	enum	Jenis item. Selalu `mcp_list_tools`. Nilai yang mungkin: `mcp_list_tools`	Yes

OpenAI.ConversationItemMcpToolCall

Pemanggilan alat di server MCP.

Nama	Tipe	Deskripsi	Diperlukan
approval_request_id	string (dapat diakses NULL)		Tidak.
argumen	string	String JSON dari argumen yang dikirimkan ke alat.	Yes
galat	string (dapat diakses NULL)		Tidak.
id	string	ID unik panggilan alat.	Yes
Nama	string	Nama alat yang dijalankan.	Yes
output	string (dapat diakses NULL)		Tidak.
server_label	string	Label server MCP yang menjalankan alat.	Yes
status	OpenAI.MCPToolCallStatus		Tidak.
jenis	enum	Jenis item. Selalu `mcp_call`. Nilai yang mungkin: `mcp_call`	Yes

OpenAI.ConversationItemMessage

Pesan ke atau dari model.

Nama	Tipe	Deskripsi	Diperlukan
isi	array OpenAI.MessageContent	Konten pesan	Yes
id	string	ID unik pesan.	Yes
peran	OpenAI.MessageRole		Yes
status	OpenAI.MessageStatus		Yes
jenis	enum	Jenis pesan. Selalu setel ke `message`. Nilai yang mungkin: `message`	Yes

OpenAI.ConversationItemReasoningItem

Deskripsi rantai pemikiran yang digunakan oleh model penalaran saat menghasilkan respons. Pastikan untuk menyertakan item ini dalam Anda ke Responses API untuk perputaran berikutnya jika Anda mengelola konteks>

Nama	Tipe	Deskripsi	Diperlukan
isi	array OpenAI.ReasoningTextContent	Konten teks penalaran.	Tidak.
encrypted_content	string (dapat diakses NULL)		Tidak.
id	string	Pengidentifikasi unik dari konten alasan.	Yes
status	enum	Status barang tersebut. Salah satu dari `in_progress`, `completed`, atau `incomplete`. Diisi saat item dikembalikan melalui API. Nilai yang mungkin: `in_progress`, `completed`, `incomplete`	Tidak.
summary	array OpenAI.Summary	Konten ringkasan penalaran.	Yes
jenis	enum	Jenis objek. Selalu `reasoning`. Nilai yang mungkin: `reasoning`	Yes

OpenAI.ConversationItemType

Harta benda Nilai

Jenis string

Nilai message
function_call
function_call_output
file_search_call
web_search_call
image_generation_call
computer_call
computer_call_output
reasoning
code_interpreter_call
local_shell_call
local_shell_call_output
shell_call
shell_call_output
apply_patch_call
apply_patch_call_output
mcp_list_tools
mcp_approval_request
mcp_approval_response
mcp_call
custom_tool_call
custom_tool_call_output

OpenAI.ConversationItemWebSearchToolCall

Hasil panggilan alat pencarian web. Lihat panduan pencarian web untuk informasi selengkapnya.

Nama	Tipe	Deskripsi	Diperlukan
tindakan	OpenAI.WebSearchActionSearch atau OpenAI.WebSearchActionOpenPage atau OpenAI.WebSearchActionFind	Objek yang menjelaskan tindakan spesifik yang diambil dalam panggilan pencarian web ini. Mencakup detail tentang bagaimana model menggunakan web (pencarian, open_page, temukan).	Yes
id	string	ID unik dari panggilan alat pencarian web.	Yes
status	enum	Status panggilan alat pencarian web. Nilai yang mungkin: `in_progress`, `searching`, `completed`, `failed`	Yes
jenis	enum	Jenis panggilan alat pencarian web. Selalu `web_search_call`. Nilai yang mungkin: `web_search_call`	Yes

OpenAI.ConversationParam

Percakapan tempat respons ini berada. Item dari percakapan ini sebelumnya ditujukan untuk input_items permintaan respons ini. Item input dan item output dari respons ini secara otomatis ditambahkan ke percakapan ini setelah respons ini selesai.

Jenis: string atau OpenAI.ConversationParam-2

OpenAI.ConversationParam-2

Percakapan tempat respons ini berada.

Nama	Tipe	Deskripsi	Diperlukan	Default
id	string	ID unik percakapan.	Yes

OpenAI.ConversationReference

Percakapan tempat respons ini berada. Item input dan item output dari respons ini secara otomatis ditambahkan ke percakapan ini.

Nama	Tipe	Deskripsi	Diperlukan	Default
id	string	ID unik percakapan yang dikaitkan dengan respons ini.	Yes

OpenAI.ConversationResource

Nama	Tipe	Deskripsi	Diperlukan
dibuat_pada	bilangan bulat	Waktu di mana percakapan dibuat, diukur dalam hitungan detik sejak epoch Unix.	Yes
id	string	ID unik percakapan.	Yes
metadata	OpenAI.Metadata	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini bisa berguna untuk menyimpan informasi tambahan tentang objek dalam terstruktur pemformatan dan pengambilan kueri untuk objek melalui API atau dasbor. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter.	Yes
objek	enum	Tipe objek, yang selalu `conversation`. Nilai yang mungkin: `conversation`	Yes

OpenAI.CreateChatCompletionRequestResponseFormat

Objek yang menentukan format yang harus dihasilkan model. Pengaturan untuk { "type": "json_schema", "json_schema": {...} } mengaktifkan Output Terstruktur yang memastikan model akan cocok dengan skema JSON yang Anda berikan. Pelajari lebih lanjut di panduan Structured Outputs. 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.

Diskriminator untuk OpenAI.CreateChatCompletionRequestResponseFormat

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
`text`	OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText
`json_object`	OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	OpenAI.CreateChatCompletionRequestResponseFormatType		Yes

OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject

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 pesan sistem atau 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.CreateChatCompletionRequestResponseFormatResponseFormatText

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

Harta benda	Nilai
Jenis	string
Nilai	`text` `json_schema` `json_object`

OpenAI.CreateConversationBody

Nama	Tipe	Deskripsi	Diperlukan	Default
items	array OpenAI.InputItem		Tidak.
metadata	OpenAI.Metadata (dapat diberisi dengan null)	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini bisa berguna untuk menyimpan informasi tambahan tentang objek dalam terstruktur pemformatan dan pengambilan kueri untuk objek melalui API atau dasbor. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter.	Tidak.

OpenAI.CreateEvalCompletionsRunDataSource

Objek CompletionsRunDataSource yang menjelaskan konfigurasi pengambilan sampel model.

Nama	Tipe	Deskripsi	Diperlukan
pesan_masuk	OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesTemplate atau OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference	Digunakan saat pengambilan sampel dari model. Menentukan struktur pesan yang diteruskan ke model. Dapat menjadi referensi ke lintasan bawaan (yaitu, `item.input_trajectory`), atau templat dengan referensi variabel ke `item` namespace layanan.	Tidak.
model	string	Nama model yang digunakan untuk menghasilkan penyelesaian (misalnya "o3-mini").	Tidak.
sampling_params	OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams		Tidak.
sumber	OpenAI.EvalJsonlFileContentSource atau OpenAI.EvalJsonlFileIdSource atau OpenAI.EvalStoredCompletionsSource	Menentukan apa yang mengisi `item` namespace layanan dalam sumber data eksekusi ini.	Yes
jenis	enum	Jenis sumber data eksekusi. Selalu `completions`. Nilai yang mungkin: `completions`	Yes

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference

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

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesTemplate

Nama	Tipe	Deskripsi	Diperlukan	Default
pola acu	array OpenAI.EasyInputMessage atau OpenAI.EvalItem		Yes
jenis	enum	Nilai yang mungkin: `template`	Yes

OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams

Nama	Tipe	Deskripsi	Diperlukan	Default
max_completion_tokens	OpenAI.integer		Tidak.
upaya penalaran	OpenAI.ReasoningEffort	Membatasi upaya penalaran untuk model penalaran. Nilai yang saat ini didukung adalah `none`, `minimal`, `low`, `medium`, `high`, dan `xhigh`. Mengurangi upaya penalaran dapat menghasilkan respons yang lebih cepat dan lebih sedikit token yang digunakan penalaran dalam sebuah respons. - `gpt-5.1` default ke `none`, yang tidak melakukan penalaran. Nilai penalaran yang didukung untuk `gpt-5.1` adalah `none`, `low`, `medium`, dan `high`. Panggilan alat didukung untuk semua nilai penalaran dalam gpt-5.1. - Semua model sebelum `gpt-5.1` default ke `medium` upaya penalaran, dan tidak mendukung `none`. - Model `gpt-5-pro` default ke (dan hanya mendukung) `high` upaya penalaran. - `xhigh` didukung untuk semua model setelah `gpt-5.1-codex-max`.	Tidak.
response_format	OpenAI.ResponseFormatText atau OpenAI.ResponseFormatJsonSchema atau OpenAI.ResponseFormatJsonObject		Tidak.
seed	OpenAI.integer		Tidak.	42
suhu	OpenAI.numeric		Tidak.	1
perangkat	array OpenAI.ChatCompletionTool		Tidak.
top_p	OpenAI.numeric		Tidak.	1

OpenAI.CreateEvalCustomDataSourceConfig

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
sertakan_skema_contoh	Boolean	Apakah evaluasi akan mengharapkan Anda mengisi namespace sampel (yaitu, dengan menghasilkan respons dari sumber data Anda)	Tidak.
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.CreateEvalJsonlRunDataSource

Objek JsonlRunDataSource yang menentukan file JSONL yang cocok dengan penilaian

Nama	Tipe	Deskripsi	Diperlukan	Default
sumber	OpenAI.EvalJsonlFileContentSource atau OpenAI.EvalJsonlFileIdSource	Menentukan apa yang mengisi `item` namespace layanan di sumber data.	Yes
jenis	enum	Jenis sumber data. Selalu `jsonl`. Nilai yang mungkin: `jsonl`	Yes

OpenAI.CreateEvalLogsDataSourceConfig

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	Filter metadata untuk sumber data log.	Tidak.
jenis	enum	Jenis sumber data. Selalu `logs`. Nilai yang mungkin: `logs`	Yes

OpenAI.CreateEvalResponsesRunDataSource

Objek ResponsesRunDataSource yang menjelaskan konfigurasi pengambilan sampel model.

Nama	Tipe	Deskripsi	Diperlukan
pesan_masuk	OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate atau OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference	Digunakan saat pengambilan sampel dari model. Menentukan struktur pesan yang diteruskan ke model. Dapat menjadi referensi ke lintasan bawaan (yaitu, `item.input_trajectory`), atau templat dengan referensi variabel ke `item` namespace layanan.	Tidak.
model	string	Nama model yang digunakan untuk menghasilkan penyelesaian (misalnya "o3-mini").	Tidak.
sampling_params	OpenAI.CreateEvalResponsesRunDataSourceSamplingParams		Tidak.
sumber	OpenAI.EvalJsonlFileContentSource atau OpenAI.EvalJsonlFileIdSource atau OpenAI.EvalResponsesSource	Menentukan apa yang mengisi `item` namespace layanan dalam sumber data eksekusi ini.	Yes
jenis	enum	Jenis sumber data eksekusi. Selalu `responses`. Nilai yang mungkin: `responses`	Yes

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference

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

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate

Nama	Tipe	Deskripsi	Diperlukan	Default
pola acu	array objek atau OpenAI.EvalItem		Yes
jenis	enum	Nilai yang mungkin: `template`	Yes

OpenAI.CreateEvalResponsesRunDataSourceSamplingParams

Nama	Tipe	Deskripsi	Diperlukan	Default
max_completion_tokens	OpenAI.integer		Tidak.
upaya penalaran	OpenAI.ReasoningEffort	Membatasi upaya penalaran untuk model penalaran. Nilai yang saat ini didukung adalah `none`, `minimal`, `low`, `medium`, `high`, dan `xhigh`. Mengurangi upaya penalaran dapat menghasilkan respons yang lebih cepat dan lebih sedikit token yang digunakan penalaran dalam sebuah respons. - `gpt-5.1` default ke `none`, yang tidak melakukan penalaran. Nilai penalaran yang didukung untuk `gpt-5.1` adalah `none`, `low`, `medium`, dan `high`. Panggilan alat didukung untuk semua nilai penalaran dalam gpt-5.1. - Semua model sebelum `gpt-5.1` default ke `medium` upaya penalaran, dan tidak mendukung `none`. - Model `gpt-5-pro` default ke (dan hanya mendukung) `high` upaya penalaran. - `xhigh` didukung untuk semua model setelah `gpt-5.1-codex-max`.	Tidak.
seed	OpenAI.integer		Tidak.	42
suhu	OpenAI.numeric		Tidak.	1
kirim pesan teks	OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText		Tidak.
perangkat	array OpenAI.Tool		Tidak.
top_p	OpenAI.numeric		Tidak.	1

OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText

Nama	Tipe	Deskripsi	Diperlukan	Default
format	OpenAI.TextResponseFormatConfiguration	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. Pelajari selengkapnya di Format defaultnya adalah `{ "type": "text" }` tanpa opsi tambahan. Tidak disarankan untuk model gpt-4o dan yang lebih baru:* Pengaturan ke `{ "type": "json_object" }` memungkinkan mode JSON yang lebih lama, yang memastikan pesan yang dihasilkan model adalah JSON yang valid. Menggunakan `json_schema` lebih diperuntukkan bagi model yang mendukungnya.	Tidak.

OpenAI.CreateEvalStoredCompletionsDataSourceConfig

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

Model yang valid:

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

Nama	Tipe	Deskripsi	Diperlukan	Default
hyperparameter	OpenAI.CreateFineTuningJobRequestHyperparameters		Tidak.
└─ batch_size	string atau OpenAI.integer		Tidak.	auto
└─ pengali_kecepatan_pembelajaran	string atau OpenAI.numeric		Tidak.
└─ n_epochs	string atau OpenAI.integer		Tidak.	auto
integrasi	array OpenAI.CreateFineTuningJobRequestIntegrations	Daftar integrasi yang akan diaktifkan untuk pekerjaan penyempurnaan Anda.	Tidak.
metadata	OpenAI.Metadata (dapat diberisi dengan null)	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini bisa berguna untuk menyimpan informasi tambahan tentang objek dalam terstruktur pemformatan dan pengambilan kueri untuk 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. Anda dapat memilih salah satu c0.	Yes
seed	OpenAI.integer (dapat diakses dengan null)		Tidak.
Akhiran	string (dapat diakses NULL)	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`. Batasan: minLength: 1, maxLength: 64	Tidak.
file_pelatihan	string	ID file yang diunggah yang berisi data pelatihan. Lihat mengunggah file untuk cara mengunggah file. 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 . Lihat panduan penyetelan fine-tuning untuk detail selengkapnya.	Yes
validation_file	string (dapat diakses NULL)	ID file yang diunggah yang berisi data validasi. Jika Anda menyediakan file ini, data digunakan untuk menghasilkan validasi metrik secara berkala selama penyempurnaan. Metrik ini dapat dilihat di 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`. Lihat panduan penyetelan fine-tuning untuk detail selengkapnya.	Tidak.

OpenAI.CreateFineTuningJobRequestHyperparameters

Nama	Tipe	Diperlukan
ukuran_paket	string atau OpenAI.integer	Tidak.
pengganda tingkat pembelajaran	string atau OpenAI.numeric	Tidak.
n_epok	string atau OpenAI.integer	Tidak.

OpenAI.CreateFineTuningJobRequestIntegrations

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	enum	Nilai yang mungkin: `wandb`	Yes
wandb	OpenAI.CreateFineTuningJobRequestIntegrationsWandb		Yes

OpenAI.CreateFineTuningJobRequestIntegrationsWandb

Nama	Tipe	Diperlukan
entitas	string (dapat diakses NULL)	Tidak.
Nama	string (dapat diakses NULL)	Tidak.
project	string	Yes
tags	array string	Tidak.

OpenAI.CreateResponseStreamingResponse

OpenAI.CustomGrammarFormatParam

Tata bahasa yang ditentukan oleh pengguna.

Nama	Tipe	Deskripsi	Diperlukan
definisi	string	Definisi tata bahasa.	Yes
syntax	OpenAI.GrammarSyntax1		Yes
jenis	enum	Format tata bahasa. Selalu `grammar`. Nilai yang mungkin: `grammar`	Yes

OpenAI.CustomTextFormatParam

Teks bentuk bebas tanpa batasan.

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	enum	Format teks tanpa batasan. Selalu `text`. Nilai yang mungkin: `text`	Yes

OpenAI.CustomToolParam

Alat kustom yang memproses input menggunakan format tertentu. Pelajari alat kustom

Nama	Tipe	Deskripsi	Diperlukan
deskripsi	string	Deskripsi opsional alat kustom, digunakan untuk memberikan lebih banyak konteks.	Tidak.
format	OpenAI.CustomToolParamFormat	Format input untuk alat khusus. Default adalah teks tidak dibatasi.	Tidak.
└─ jenis	OpenAI.CustomToolParamFormatType		Yes
Nama	string	Nama alat khusus, digunakan untuk mengidentifikasinya dalam panggilan alat.	Yes
jenis	enum	Jenis alat khusus. Selalu `custom`. Nilai yang mungkin: `custom`	Yes

OpenAI.CustomToolParamFormat

Format input untuk alat khusus. Default adalah teks tidak dibatasi.

Diskriminator untuk OpenAI.CustomToolParamFormat

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
`text`	OpenAI.CustomTextFormatParam
`grammar`	OpenAI.CustomGrammarFormatParam

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	OpenAI.CustomToolParamFormatType		Yes

OpenAI.CustomToolParamFormatType

Harta benda	Nilai
Jenis	string
Nilai	`text` `grammar`

OpenAI.DeletedConversationResource

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

OpenAI.DetailEnum

Harta benda	Nilai
Jenis	string
Nilai	`low` `high` `auto`

OpenAI.DoubleClickAction

Tindakan klik ganda.

Nama	Tipe	Deskripsi	Diperlukan
jenis	enum	Menentukan jenis peristiwa. Untuk tindakan klik ganda, properti ini selalu diatur ke `double_click`. Nilai yang mungkin: `double_click`	Yes
x	OpenAI.integer		Yes
y	OpenAI.integer		Yes

OpenAI.Drag

Aksi menyeret

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

OpenAI.DragPoint

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

Nama	Tipe	Deskripsi	Diperlukan	Default
x	OpenAI.integer		Yes
y	OpenAI.integer		Yes

OpenAI.EasyInputMessage

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

Nama	Tipe	Deskripsi	Diperlukan
isi	string atau OpenAI.InputMessageContentList	Input teks, gambar, atau audio ke model, digunakan untuk menghasilkan respons. Juga dapat berisi respons asisten sebelumnya.	Yes
peran	enum	Peran dalam memasukkan pesan. Salah satu dari `user`, `assistant`, `system`, atau `developer`. Nilai yang mungkin: `user`, `assistant`, `system`, `developer`	Yes
status	enum	Status dari item. Salah satu dari `in_progress`, `completed`, atau `incomplete`. Diisi saat item dikembalikan melalui API. Nilai yang mungkin: `in_progress`, `completed`, `incomplete`	Tidak.
jenis	enum	Jenis input pesan. Selalu `message`. Nilai yang mungkin: `message`	Yes

OpenAI.Error

Nama	Tipe	Diperlukan
informasi tambahan	objek	Tidak.
kode	string (dapat diakses NULL)	Yes
debugInfo	objek	Tidak.
details	array OpenAI.Error	Tidak.
pesan	string	Yes
param	string (dapat diakses NULL)	Tidak.
jenis	string	Tidak.

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

Nama	Tipe	Deskripsi	Diperlukan
Masukan	array OpenAI.EvalItem		Yes
labels	array string	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 string	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.EvalGraderPython

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

OpenAI.EvalGraderScoreModel

Nama	Tipe	Deskripsi	Diperlukan	Default
Masukan	array OpenAI.EvalItem	Pesan input yang dievaluasi oleh grader. Mendukung teks, teks output, gambar input, dan blok konten audio input, dan mungkin menyertakan string templat.	Yes
model	string	Model yang digunakan untuk evaluasi.	Yes
Nama	string	Nama penilai.	Yes
ambang_lulus	OpenAI.numeric		Tidak.
rentang	array OpenAI.numeric	Rentang skor. Secara default menjadi `[0, 1]`.	Tidak.
sampling_params	OpenAI.EvalGraderScoreModelSamplingParams		Tidak.
└─ max_completions_tokens	OpenAI.integer (dapat diakses dengan null)		Tidak.
└─ upaya_penalaran	OpenAI.ReasoningEffort	Membatasi upaya penalaran untuk model penalaran. Nilai yang saat ini didukung adalah `none`, `minimal`, `low`, `medium`, `high`, dan `xhigh`. Mengurangi upaya penalaran dapat menghasilkan respons yang lebih cepat dan lebih sedikit token yang digunakan penalaran dalam sebuah respons. - `gpt-5.1` default ke `none`, yang tidak melakukan penalaran. Nilai penalaran yang didukung untuk `gpt-5.1` adalah `none`, `low`, `medium`, dan `high`. Panggilan alat didukung untuk semua nilai penalaran dalam gpt-5.1. - Semua model sebelum `gpt-5.1` default ke `medium` upaya penalaran, dan tidak mendukung `none`. - Model `gpt-5-pro` default ke (dan hanya mendukung) `high` upaya penalaran. - `xhigh` didukung untuk semua model setelah `gpt-5.1-codex-max`.	Tidak.
└─ benih	OpenAI.integer (dapat diakses dengan null)		Tidak.
└─ suhu	OpenAI.numeric (nullable)		Tidak.
└─ top_p	OpenAI.numeric (nullable)		Tidak.	1
jenis	enum	Tipe objek, yang selalu `score_model`. Nilai yang mungkin: `score_model`	Yes

OpenAI.EvalGraderScoreModelSamplingParams

Nama	Tipe	Deskripsi	Diperlukan	Default
max_completions_tokens	OpenAI.integer (dapat diakses dengan null)		Tidak.
upaya penalaran	OpenAI.ReasoningEffort	Membatasi upaya penalaran untuk model penalaran. Nilai yang saat ini didukung adalah `none`, `minimal`, `low`, `medium`, `high`, dan `xhigh`. Mengurangi upaya penalaran dapat menghasilkan respons yang lebih cepat dan lebih sedikit token yang digunakan penalaran dalam sebuah respons. - `gpt-5.1` default ke `none`, yang tidak melakukan penalaran. Nilai penalaran yang didukung untuk `gpt-5.1` adalah `none`, `low`, `medium`, dan `high`. Panggilan alat didukung untuk semua nilai penalaran dalam gpt-5.1. - Semua model sebelum `gpt-5.1` default ke `medium` upaya penalaran, dan tidak mendukung `none`. - Model `gpt-5-pro` default ke (dan hanya mendukung) `high` upaya penalaran. - `xhigh` didukung untuk semua model setelah `gpt-5.1-codex-max`.	Tidak.
seed	OpenAI.integer (dapat diakses dengan null)		Tidak.
suhu	OpenAI.numeric (nullable)		Tidak.
top_p	OpenAI.numeric (nullable)		Tidak.	1

OpenAI.EvalGraderStringCheck

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

Nama	Tipe	Deskripsi	Diperlukan
metrik evaluasi	enum	Metrik evaluasi yang akan digunakan. Salah satu dari `cosine`, `fuzzy_match`, `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5` atau `rouge_l`. Nilai yang mungkin: `cosine`, , `fuzzy_matchbleu`, `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	OpenAI.numeric		Yes
referensi	string	Teks yang sedang dinilai.	Yes
jenis	enum	Jenis grader. Nilai yang mungkin: `text_similarity`	Yes

OpenAI.EvalItem

Nama	Tipe	Deskripsi	Diperlukan
isi	OpenAI.EvalItemContent	Input ke model - dapat berisi string templat. Mendukung teks, teks output, gambar input, dan audio input, baik sebagai item tunggal atau array item.	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.EvalItemContent

Input ke model - dapat berisi string templat. Mendukung teks, teks output, gambar input, dan audio input, baik sebagai item tunggal atau array item.

Jenis: OpenAI.EvalItemContentItem atau OpenAI.EvalItemContentArray

Input ke model - dapat berisi string templat. Mendukung teks, teks output, gambar input, dan audio input, baik sebagai item tunggal atau array item.

OpenAI.EvalItemContentArray

Daftar input, yang masing-masing dapat berupa teks input, teks output, gambar input, atau objek audio input.

Array dari: OpenAI.EvalItemContentItem

OpenAI.EvalItemContentItem

Satu item konten: teks input, teks output, gambar input, atau audio input.

Jenis: OpenAI.EvalItemContentText atau OpenAI.EvalItemContentItemObject

Satu item konten: teks input, teks output, gambar input, atau audio input.

OpenAI.EvalItemContentItemObject

Satu item konten: teks input, teks output, gambar input, atau audio input.

Diskriminator untuk OpenAI.EvalItemContentItemObject

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
`output_text`	OpenAI.EvalItemContentOutputText
`input_image`	OpenAI.EvalItemInputImage
`input_audio`	OpenAI.InputAudio
`input_text`	OpenAI.EvalItemContentItemObjectInputTextContent

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	OpenAI.EvalItemContentItemObjectType		Yes

OpenAI.EvalItemContentItemObjectInputTextContent

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

Harta benda	Nilai
Jenis	string
Nilai	`input_text` `output_text` `input_image` `input_audio`

OpenAI.EvalItemContentOutputText

Teks output dari model.

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

Input teks ke model.

Jenis: teks

OpenAI.EvalItemInputImage

Blok input gambar yang digunakan dalam array konten EvalItem.

Nama	Tipe	Deskripsi	Diperlukan
detail	string	Tingkat detail gambar yang akan dikirim ke model. Salah satu dari `high`, `low`, atau `auto`. Secara default menjadi `auto`.	Tidak.
image_url	string	URL input gambar.	Yes
jenis	enum	Jenis input gambar. Selalu `input_image`. Nilai yang mungkin: `input_image`	Yes

OpenAI.EvalJsonlFileContentSource

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

OpenAI.EvalJsonlFileContentSourceContent

Nama	Tipe	Deskripsi	Diperlukan	Default
item	objek		Yes
sampel	objek		Tidak.

OpenAI.EvalJsonlFileIdSource

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

Objek EvalResponsesSource yang menjelaskan konfigurasi sumber data eksekusi.

Nama	Tipe	Deskripsi	Diperlukan
dibuat_setelah	OpenAI.integer (dapat diakses dengan null)		Tidak.
dibuat_sebelum	OpenAI.integer (dapat diakses dengan null)		Tidak.
instructions_search	string (dapat diakses NULL)		Tidak.
metadata	objek (nullable)		Tidak.
model	string (dapat diakses NULL)		Tidak.
upaya penalaran	OpenAI.ReasoningEffort (dapat diberilang)	Membatasi upaya penalaran untuk model penalaran. Nilai yang saat ini didukung adalah `none`, `minimal`, `low`, `medium`, `high`, dan `xhigh`. Mengurangi upaya penalaran dapat menghasilkan respons yang lebih cepat dan lebih sedikit token yang digunakan penalaran dalam sebuah respons. - `gpt-5.1` default ke `none`, yang tidak melakukan penalaran. Nilai penalaran yang didukung untuk `gpt-5.1` adalah `none`, `low`, `medium`, dan `high`. Panggilan alat didukung untuk semua nilai penalaran dalam gpt-5.1. - Semua model sebelum `gpt-5.1` default ke `medium` upaya penalaran, dan tidak mendukung `none`. - Model `gpt-5-pro` default ke (dan hanya mendukung) `high` upaya penalaran. - `xhigh` didukung untuk semua model setelah `gpt-5.1-codex-max`.	Tidak.
suhu	OpenAI.numeric (nullable)		Tidak.
perangkat	array string		Tidak.
top_p	OpenAI.numeric (nullable)		Tidak.
jenis	enum	Jenis sumber data eksekusi. Selalu `responses`. Nilai yang mungkin: `responses`	Yes
users	array string		Tidak.

OpenAI.EvalRunOutputItemSample

Nama	Tipe	Deskripsi	Diperlukan
galat	OpenAI.EvalApiError	Objek yang mewakili respons kesalahan dari EVAL API.	Yes
alasan_selesai	string		Yes
Masukan	array EvalRunOutputItemSampleInput		Yes
max_completion_tokens	OpenAI.integer		Yes
model	string		Yes
output	array EvalRunOutputItemSampleOutput		Yes
seed	OpenAI.integer		Yes
suhu	OpenAI.numeric		Yes
top_p	OpenAI.numeric		Yes
usage	OpenAI.EvalRunOutputItemSampleUsage		Yes

OpenAI.EvalRunOutputItemSampleUsage

Nama	Tipe	Diperlukan
cached_tokens	OpenAI.integer	Yes
completion_tokens	OpenAI.integer	Yes
prompt_tokens	OpenAI.integer	Yes
total_tokens	OpenAI.integer	Yes

OpenAI.EvalRunPerModelUsage

Nama	Tipe	Diperlukan
cached_tokens	OpenAI.integer	Yes
completion_tokens	OpenAI.integer	Yes
invocation_count	OpenAI.integer	Yes
nama_model	string	Yes
prompt_tokens	OpenAI.integer	Yes
total_tokens	OpenAI.integer	Yes

OpenAI.EvalRunPerTestingCriteriaResults

Nama	Tipe	Diperlukan
gagal	OpenAI.integer	Yes
Berlalu	OpenAI.integer	Yes
kriteria_pengujian	string	Yes

OpenAI.EvalRunResultCounts

Nama	Tipe	Diperlukan
kesalahan	OpenAI.integer	Yes
gagal	OpenAI.integer	Yes
Berlalu	OpenAI.integer	Yes
seluruh	OpenAI.integer	Yes

OpenAI.EvalStoredCompletionsSource

Konfigurasi StoredCompletionsRunDataSource yang menjelaskan serangkaian filter

Nama	Tipe	Deskripsi	Diperlukan
dibuat_setelah	OpenAI.integer (dapat diakses dengan null)		Tidak.
dibuat_sebelum	OpenAI.integer (dapat diakses dengan null)		Tidak.
limit	OpenAI.integer (dapat diakses dengan null)		Tidak.
metadata	OpenAI.Metadata (dapat diberisi dengan null)	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini bisa berguna untuk menyimpan informasi tambahan tentang objek dalam terstruktur pemformatan dan pengambilan kueri untuk objek melalui API atau dasbor. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter.	Tidak.
model	string (dapat diakses NULL)		Tidak.
jenis	enum	Jenis sumber. Selalu `stored_completions`. Nilai yang mungkin: `stored_completions`	Yes

OpenAI.FileCitationBody

Kutipan ke file.

Nama	Tipe	Deskripsi	Diperlukan
file_id	string	ID file.	Yes
filename	string	Nama file file yang dikutip.	Yes
indeks	OpenAI.integer		Yes
jenis	enum	Jenis kutipan dari file Selalu `file_citation`. Nilai yang mungkin: `file_citation`	Yes

OpenAI.FilePath

Jalur ke file.

Nama	Tipe	Deskripsi	Diperlukan
file_id	string	ID file.	Yes
indeks	OpenAI.integer		Yes
jenis	enum	Jenis jalur file. Selalu `file_path`. Nilai yang mungkin: `file_path`	Yes

OpenAI.FileSearchTool

Alat yang mencari konten yang relevan dari file yang diunggah.

Nama	Tipe	Deskripsi	Diperlukan
filters	OpenAI.Filters (dapat diubah untuk null)		Tidak.
jumlah_maksimum_hasil	OpenAI.integer		Tidak.
opsi_peringkat	OpenAI.RankingOptions		Tidak.
└─ hybrid_search	OpenAI.HybridSearchOptions	Bobot yang mengontrol bagaimana gabungan peringkat timbal balik menyeimbangkan kecocokan penyematan semantik versus pencocokan kata kunci yang jarang saat pencarian hibrid diaktifkan.	Tidak.
└─ peringkat	OpenAI.RankerVersionType	Ranker yang digunakan untuk pencarian file.	Tidak.
└─ ambang_batas_skornya	OpenAI.numeric	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 string	ID dari penyimpanan vektor yang akan dicari.	Yes

OpenAI.FileSearchToolCallResults

Nama	Tipe	Deskripsi	Diperlukan
attributes	OpenAI.VectorStoreFileAttributes (dapat diberisi dengan null)	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini bisa berguna untuk menyimpan informasi tambahan tentang objek dalam terstruktur pemformatan dan pengambilan kueri untuk objek melalui API atau dasbor. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan maksimum panjang 512 karakter, boolean, atau angka.	Tidak.
file_id	string		Tidak.
filename	string		Tidak.
skor	nomor/angka		Tidak.
kirim pesan teks	string		Tidak.

OpenAI.Filters

Jenis: OpenAI.ComparisonFilter atau OpenAI.CompoundFilter

OpenAI.FineTuneDPOHyperparameters

Hyperparameter yang digunakan untuk pekerjaan penyempurnaan DPO.

Nama	Tipe	Deskripsi	Diperlukan
ukuran_paket	string atau OpenAI.integer	Jumlah contoh di setiap batch. Ukuran batch yang lebih besar berarti parameter model diperbarui lebih jarang, tetapi dengan varian yang lebih rendah.	Tidak.
beta	string atau OpenAI.numeric	Nilai beta untuk metode DPO. Nilai beta yang lebih tinggi akan meningkatkan bobot penalti antara kebijakan dan model referensi.	Tidak.
pengganda tingkat pembelajaran	string atau OpenAI.numeric	Faktor penskalaan untuk tingkat pembelajaran. Laju pembelajaran yang lebih kecil mungkin berguna untuk menghindari overfitting.	Tidak.
n_epok	string atau OpenAI.integer	Jumlah epoch yang diperlukan untuk melatih model. Epoch mengacu pada satu siklus penuh melalui himpunan data pelatihan.	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
dpo	OpenAI.FineTuneDPOMethod	Konfigurasi untuk metode penyempurnaan DPO.	Tidak.
Penguatan	OpenAI.FineTuneReinforcementMethod	Konfigurasi untuk metode penyempurnaan penguatan.	Tidak.
Diawasi	OpenAI.FineTuneSupervisedMethod	Konfigurasi untuk metode penyempurnaan yang diawasi.	Tidak.
jenis	enum	Jenis metode. `supervised`Apakah , , `dpo`atau `reinforcement`. Nilai yang mungkin: `supervised`, `dpo`, `reinforcement`	Yes

OpenAI.FineTuneReinforcementHyperparameters

Hyperparameter yang digunakan untuk pekerjaan penyempurnaan penguatan.

Nama	Tipe	Deskripsi	Diperlukan
ukuran_paket	string atau OpenAI.integer	Jumlah contoh di setiap batch. Ukuran batch yang lebih besar berarti parameter model diperbarui lebih jarang, tetapi dengan varian yang lebih rendah.	Tidak.
compute_multiplier	string atau OpenAI.numeric	Pengali pada jumlah komputasi yang digunakan untuk menjelajahi ruang pencarian selama pelatihan.	Tidak.
eval_interval	string atau OpenAI.integer	Jumlah langkah pelatihan antara sesi evaluasi.	Tidak.
eval_samples	string atau OpenAI.integer	Jumlah sampel evaluasi yang akan dihasilkan per langkah pelatihan.	Tidak.
pengganda tingkat pembelajaran	string atau OpenAI.numeric	Faktor penskalaan untuk tingkat pembelajaran. Laju pembelajaran yang lebih kecil mungkin berguna untuk menghindari overfitting.	Tidak.
n_epok	string atau OpenAI.integer	Jumlah epoch yang diperlukan untuk melatih model. Epoch mengacu pada satu siklus penuh melalui himpunan data pelatihan.	Tidak.
upaya penalaran	enum	Tingkat upaya penalaran. Nilai yang mungkin: `default`, `low`, `medium`, `high`	Tidak.

OpenAI.FineTuneReinforcementMethod

Konfigurasi untuk metode penyempurnaan penguatan.

Nama	Tipe	Deskripsi	Diperlukan	Default
Grader	OpenAI.GraderStringCheck atau OpenAI.GraderTextSimilarity atau OpenAI.GraderPython atau OpenAI.GraderScoreModel atau OpenAI.GraderMulti	Grader yang digunakan untuk pekerjaan penyempurnaan.	Yes
hyperparameter	OpenAI.FineTuneReinforcementHyperparameters	Hyperparameter yang digunakan untuk pekerjaan penyempurnaan penguatan.	Tidak.

OpenAI.FineTuneSupervisedHyperparameters

Hyperparameter yang digunakan untuk pekerjaan penyempurnaan.

Nama	Tipe	Deskripsi	Diperlukan
ukuran_paket	string atau OpenAI.integer	Jumlah contoh di setiap batch. Ukuran batch yang lebih besar berarti parameter model diperbarui lebih jarang, tetapi dengan varian yang lebih rendah.	Tidak.
pengganda tingkat pembelajaran	string atau OpenAI.numeric	Faktor penskalaan untuk tingkat pembelajaran. Laju pembelajaran yang lebih kecil mungkin berguna untuk menghindari overfitting.	Tidak.
n_epok	string atau OpenAI.integer	Jumlah epoch yang diperlukan untuk melatih model. Epoch mengacu pada satu siklus penuh melalui himpunan data pelatihan.	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

Nama	Tipe	Deskripsi	Diperlukan
jenis	enum	Jenis integrasi yang diaktifkan untuk pekerjaan penyempurnaan Nilai yang mungkin: `wandb`	Yes
wandb	OpenAI.FineTuningIntegrationWandb		Yes
└─ entitas	string (dapat diakses NULL)		Tidak.
└─ nama	string (dapat diakses NULL)		Tidak.
└─ project	string		Yes
└─ tag	array string		Tidak.

OpenAI.FineTuningIntegrationWandb

Nama	Tipe	Diperlukan
entitas	string (dapat diakses NULL)	Tidak.
Nama	string (dapat diakses NULL)	Tidak.
project	string	Yes
tags	array string	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	OpenAI.FineTuningJobError (dapat diubah untuk null)		Yes
└─ kode	string		Yes
└─ pesan	string		Yes
└─ param	string (dapat diakses NULL)		Yes
perkiraan selesai	bilangan bulat		Tidak.
fine_tuned_model	string (dapat diakses NULL)		Yes
selesai_pada	bilangan bulat		Yes
hyperparameter	OpenAI.FineTuningJobHyperparameters		Yes
└─ batch_size	string atau OpenAI.integer		Tidak.	auto
└─ pengali_kecepatan_pembelajaran	string atau OpenAI.numeric		Tidak.
└─ n_epochs	string atau OpenAI.integer		Tidak.	auto
id	string	Pengidentifikasi objek, yang dapat dirujuk di titik akhir API.	Yes
integrasi	array OpenAI.FineTuningIntegration		Tidak.
metadata	OpenAI.Metadata (dapat diberisi dengan null)	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini bisa berguna untuk menyimpan informasi tambahan tentang objek dalam terstruktur pemformatan dan pengambilan kueri untuk 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	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 string	ID file hasil yang dikompilasi untuk pekerjaan penyempurnaan. Anda dapat mengambil hasilnya dengan Files API.	Yes
seed	OpenAI.integer		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	OpenAI.integer (dapat diakses dengan null)		Yes
file_pelatihan	string	ID file yang digunakan untuk pelatihan. Anda dapat mengambil data pelatihan dengan Files API.	Yes
validation_file	string (dapat diakses NULL)		Yes

OpenAI.FineTuningJobCheckpoint

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

Nama	Tipe	Deskripsi	Diperlukan
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	OpenAI.FineTuningJobCheckpointMetrics		Yes
└─ kehilangan_valid_penuh	OpenAI.numeric		Tidak.
└─ akurasi_rata-rata_token_valid_lengkap	OpenAI.numeric		Tidak.
└─ langkah	OpenAI.numeric		Tidak.
└─ kehilangan_latihan	OpenAI.numeric		Tidak.
└─ train_mean_token_accuracy (akurasi_rata-rata_token_latihan)	OpenAI.numeric		Tidak.
└─ kerugian_valid	OpenAI.numeric		Tidak.
└─ akurasi rata-rata token valid	OpenAI.numeric		Tidak.
objek	enum	Jenis objek, yang selalu "fine_tuning.job.checkpoint". Nilai yang mungkin: `fine_tuning.job.checkpoint`	Yes
langkah_nomor	OpenAI.integer		Yes

OpenAI.FineTuningJobCheckpointMetrics

Nama	Tipe	Diperlukan
full_valid_loss	OpenAI.numeric	Tidak.
full_valid_mean_token_accuracy	OpenAI.numeric	Tidak.
langkah	OpenAI.numeric	Tidak.
train_loss	OpenAI.numeric	Tidak.
train_mean_token_accuracy	OpenAI.numeric	Tidak.
valid_loss	OpenAI.numeric	Tidak.
valid_mean_token_accuracy	OpenAI.numeric	Tidak.

OpenAI.FineTuningJobError

Nama	Tipe	Diperlukan
kode	string	Yes
pesan	string	Yes
param	string (dapat diakses NULL)	Yes

OpenAI.FineTuningJobEvent

Menyempurnakan objek peristiwa pekerjaan

Nama	Tipe	Deskripsi	Diperlukan
dibuat_pada	bilangan bulat	Tanda waktu Unix (dalam detik) saat pekerjaan penyempurnaan dibuat.	Yes
data	OpenAI.FineTuningJobEventData		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.FineTuningJobEventData

Jenis: objek

OpenAI.FineTuningJobHyperparameters

Nama	Tipe	Diperlukan
ukuran_paket	string atau OpenAI.integer	Tidak.
pengganda tingkat pembelajaran	string atau OpenAI.numeric	Tidak.
n_epok	string atau OpenAI.integer	Tidak.

OpenAI.FunctionAndCustomToolCallOutput

Diskriminator untuk OpenAI.FunctionAndCustomToolCallOutput

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
`input_text`	OpenAI.FunctionAndCustomToolCallOutputInputTextContent
`input_image`	OpenAI.FunctionAndCustomToolCallOutputInputImageContent
`input_file`	OpenAI.FunctionAndCustomToolCallOutputInputFileContent

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	OpenAI.FunctionAndCustomToolCallOutputType		Yes

OpenAI.FunctionAndCustomToolCallOutputInputFileContent

Sebuah file input ke model.

Nama	Tipe	Deskripsi	Diperlukan
file_data	string	Konten file yang akan dikirim ke model.	Tidak.
file_id	string (dapat diakses NULL)		Tidak.
file_url	string	URL 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.FunctionAndCustomToolCallOutputInputImageContent

Input gambar ke model. Pelajari tentang input image.

Nama	Tipe	Deskripsi	Diperlukan
detail	OpenAI.ImageDetail		Yes
file_id	string (dapat diakses NULL)		Tidak.
image_url	string		Tidak.
jenis	enum	Jenis item input. Selalu `input_image`. Nilai yang mungkin: `input_image`	Yes

OpenAI.FunctionAndCustomToolCallOutputInputTextContent

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

Harta benda	Nilai
Jenis	string
Nilai	`input_text` `input_image` `input_file`

OpenAI.FunctionCallItemStatus

Harta benda	Nilai
Jenis	string
Nilai	`in_progress` `completed` `incomplete`

OpenAI.FunctionObject

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

OpenAI.FunctionParameters

Parameter yang diterima fungsi, dijelaskan sebagai objek Skema JSON. Lihat guide untuk contoh, dan JSON Schema reference untuk dokumentasi tentang format. Menghilangkan parameters mendefinisikan fungsi dengan daftar parameter kosong.

Jenis: objek

OpenAI.FunctionShellAction

Jalankan perintah shell.

Nama	Tipe	Diperlukan
Perintah	array string	Yes
max_output_length	OpenAI.integer (dapat diakses dengan null)	Yes
batas_waktu_ms	OpenAI.integer (dapat diakses dengan null)	Yes

OpenAI.FunctionShellActionParam

Perintah dan batas yang menjelaskan cara menjalankan panggilan alat shell.

Nama	Tipe	Deskripsi	Diperlukan
Perintah	array string	Perintah shell yang diperintahkan agar lingkungan eksekusi berjalan.	Yes
max_output_length	OpenAI.integer (dapat diakses dengan null)		Tidak.
batas_waktu_ms	OpenAI.integer (dapat diakses dengan null)		Tidak.

OpenAI.FunctionShellCallItemStatus

Nilai status yang dilaporkan untuk panggilan alat shell.

Harta benda	Nilai
Jenis	string
Nilai	`in_progress` `completed` `incomplete`

OpenAI.FunctionShellCallOutputContent

Konten output panggilan alat shell yang dipancarkan.

Nama	Tipe	Deskripsi	Diperlukan
dibuat oleh	string	Pengidentifikasi aktor yang membuat item.	Tidak.
hasil	OpenAI.FunctionShellCallOutputOutcome	Mewakili hasil keluar (dengan kode keluar) atau hasil waktu habis untuk gugus output panggilan shell.	Yes
└─ jenis	OpenAI.FunctionShellCallOutputOutcomeType		Yes
stderr	string	Output kesalahan standar yang ditangkap.	Yes
stdout	string	Output standar yang ditangkap.	Yes

OpenAI.FunctionShellCallOutputContentParam

Menangkap stdout dan stderr untuk sebagian dari output panggilan alat shell.

Nama	Tipe	Deskripsi	Diperlukan
hasil	OpenAI.FunctionShellCallOutputOutcomeParam	Hasil keluar atau batas waktu yang terkait dengan panggilan shell ini.	Yes
└─ jenis	OpenAI.FunctionShellCallOutputOutcomeParamType		Yes
stderr	string	Output stderr yang ditangkap untuk panggilan shell. Batasan: maxLength: 10485760	Yes
stdout	string	Output stdout yang diambil untuk panggilan shell. Batasan: maxLength: 10485760	Yes

OpenAI.FunctionShellCallOutputExitOutcome

Menunjukkan bahwa perintah shell selesai dan mengembalikan kode keluar.

Nama	Tipe	Deskripsi	Diperlukan	Default
exit_code	OpenAI.integer		Yes
jenis	enum	Jenis hasil. Selalu `exit`. Nilai yang mungkin: `exit`	Yes

OpenAI.FunctionShellCallOutputExitOutcomeParam

Menunjukkan bahwa perintah shell selesai dan mengembalikan kode keluar.

Nama	Tipe	Deskripsi	Diperlukan	Default
exit_code	OpenAI.integer		Yes
jenis	enum	Jenis hasil. Selalu `exit`. Nilai yang mungkin: `exit`	Yes

OpenAI.FunctionShellCallOutputOutcome

Mewakili hasil keluar (dengan kode keluar) atau hasil waktu habis untuk gugus output panggilan shell.

Diskriminator untuk OpenAI.FunctionShellCallOutputOutcome

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
`timeout`	OpenAI.FunctionShellCallOutputTimeoutOutcome
`exit`	OpenAI.FunctionShellCallOutputExitOutcome

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	OpenAI.FunctionShellCallOutputOutcomeType		Yes

OpenAI.FunctionShellCallOutputOutcomeParam

Hasil keluar atau batas waktu yang terkait dengan panggilan shell ini.

Diskriminator untuk OpenAI.FunctionShellCallOutputOutcomeParam

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
`timeout`	OpenAI.FunctionShellCallOutputTimeoutOutcomeParam
`exit`	OpenAI.FunctionShellCallOutputExitOutcomeParam

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	OpenAI.FunctionShellCallOutputOutcomeParamType		Yes

OpenAI.FunctionShellCallOutputOutcomeParamType

Harta benda	Nilai
Jenis	string
Nilai	`timeout` `exit`

OpenAI.FunctionShellCallOutputOutcomeType

Harta benda	Nilai
Jenis	string
Nilai	`timeout` `exit`

OpenAI.FunctionShellCallOutputTimeoutOutcome

Menunjukkan bahwa panggilan shell melebihi batas waktu yang dikonfigurasi.

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	enum	Jenis hasil. Selalu `timeout`. Nilai yang mungkin: `timeout`	Yes

OpenAI.FunctionShellCallOutputTimeoutOutcomeParam

Menunjukkan bahwa panggilan shell melebihi batas waktu yang dikonfigurasi.

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	enum	Jenis hasil. Selalu `timeout`. Nilai yang mungkin: `timeout`	Yes

OpenAI.FunctionShellToolParam

Alat yang memungkinkan model untuk menjalankan perintah shell.

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

OpenAI.FunctionTool

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

Nama	Tipe	Deskripsi	Diperlukan
deskripsi	string (dapat diakses NULL)		Tidak.
Nama	string	Nama fungsi yang akan dipanggil.	Yes
parameter	objek (nullable)		Yes
tegas	Boolean (dapat diberisi dengan null)		Yes
jenis	enum	Jenis alat bantu fungsi. Selalu `function`. Nilai yang mungkin: `function`	Yes

OpenAI.GraderLabelModel

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

Nama	Tipe	Deskripsi	Diperlukan
Masukan	array OpenAI.EvalItem		Yes
labels	array string	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 string	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
calculate_output	string	Rumus untuk menghitung output berdasarkan hasil grader.	Yes
grader	OpenAI.GraderStringCheck atau OpenAI.GraderTextSimilarity atau OpenAI.GraderPython atau OpenAI.GraderScoreModel atau OpenAI.GraderLabelModel		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
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 OpenAI.EvalItem	Pesan input yang dievaluasi oleh grader. Mendukung teks, teks output, gambar input, dan blok konten audio input, dan mungkin menyertakan string templat.	Yes
model	string	Model yang digunakan untuk evaluasi.	Yes
Nama	string	Nama penilai.	Yes
rentang	array OpenAI.numeric	Rentang skor. Secara default menjadi `[0, 1]`.	Tidak.
sampling_params	OpenAI.EvalGraderScoreModelSamplingParams		Tidak.
└─ max_completions_tokens	OpenAI.integer (dapat diakses dengan null)		Tidak.
└─ upaya_penalaran	OpenAI.ReasoningEffort	Membatasi upaya penalaran untuk model penalaran. Nilai yang saat ini didukung adalah `none`, `minimal`, `low`, `medium`, `high`, dan `xhigh`. Mengurangi upaya penalaran dapat menghasilkan respons yang lebih cepat dan lebih sedikit token yang digunakan penalaran dalam sebuah respons. - `gpt-5.1` default ke `none`, yang tidak melakukan penalaran. Nilai penalaran yang didukung untuk `gpt-5.1` adalah `none`, `low`, `medium`, dan `high`. Panggilan alat didukung untuk semua nilai penalaran dalam gpt-5.1. - Semua model sebelum `gpt-5.1` default ke `medium` upaya penalaran, dan tidak mendukung `none`. - Model `gpt-5-pro` default ke (dan hanya mendukung) `high` upaya penalaran. - `xhigh` didukung untuk semua model setelah `gpt-5.1-codex-max`.	Tidak.
└─ benih	OpenAI.integer (dapat diakses dengan null)		Tidak.
└─ suhu	OpenAI.numeric (nullable)		Tidak.
└─ top_p	OpenAI.numeric (nullable)		Tidak.	1
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
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
metrik evaluasi	enum	Metrik evaluasi yang akan digunakan. Salah satu dari `cosine`, `fuzzy_match`, `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5` atau `rouge_l`. Nilai yang mungkin: `cosine`, , `fuzzy_matchbleu`, `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.GrammarSyntax1

Harta benda	Nilai
Jenis	string
Nilai	`lark` `regex`

OpenAI.HybridSearchOptions

Nama	Tipe	Deskripsi	Diperlukan	Default
embedding_weight	OpenAI.numeric		Yes
text_weight	OpenAI.numeric		Yes

OpenAI.ImageDetail

Harta benda	Nilai
Jenis	string
Nilai	`low` `high` `auto`

OpenAI.ImageGenTool

Alat yang menghasilkan gambar menggunakan model gambar GPT.

Model yang valid:

gpt-image-1
gpt-image-1-mini

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.
input_fidelity	OpenAI.InputFidelity (dapat diubah tanpa null)	Kontrol berapa banyak upaya yang akan dilakukan model untuk mencocokkan gaya dan fitur, terutama fitur wajah, dari gambar input. Parameter ini hanya didukung untuk `gpt-image-1`. Tidak didukung untuk `gpt-image-1-mini`. Mendukung `high` dan `low`. Secara default menjadi `low`.	Tidak.
masukan_topeng_gambar	OpenAI.ImageGenToolInputImageMask		Tidak.
└─ file_id	string		Tidak.
└─ alamat_gambar	string		Tidak.
model	string (lihat model yang valid di bawah)		Tidak.
moderation	enum	Tingkat moderasi untuk gambar yang dihasilkan. Standar: `auto`. Nilai yang mungkin: `auto`, `low`	Tidak.
kompresi keluaran	OpenAI.integer		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	OpenAI.integer		Tidak.
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.ImageGenToolInputImageMask

Nama	Tipe	Deskripsi	Diperlukan	Default
file_id	string		Tidak.
image_url	string		Tidak.

OpenAI.IncludeEnum

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

web_search_call.action.sources: Sertakan sumber panggilan alat pencarian web.
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:

web_search_call.action.sources: Sertakan sumber panggilan alat pencarian web.
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). | | Jenis | string | | Nilai | file_search_call.results
web_search_call.results
web_search_call.action.sources
message.input_image.image_url
computer_call_output.output.image_url
code_interpreter_call.outputs
reasoning.encrypted_content
message.output_text.logprobs
memory_search_call.results |

OpenAI.InputAudio

Masukan audio ke dalam model.

Nama	Tipe	Deskripsi	Diperlukan	Default
input_audio	OpenAI.InputAudioInputAudio		Yes
jenis	enum	Jenis item input. Selalu `input_audio`. Nilai yang mungkin: `input_audio`	Yes

OpenAI.InputAudioInputAudio

Nama	Tipe	Deskripsi	Diperlukan	Default
data	string		Yes
format	enum	Nilai yang mungkin: `mp3`, `wav`	Yes

OpenAI.InputContent

Diskriminator untuk OpenAI.InputContent

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
`input_text`	OpenAI.InputContentInputTextContent
`input_image`	OpenAI.InputContentInputImageContent
`input_file`	OpenAI.InputContentInputFileContent

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	OpenAI.InputContentType		Yes

OpenAI.InputContentInputFileContent

Sebuah file input ke model.

Nama	Tipe	Deskripsi	Diperlukan
file_data	string	Konten file yang akan dikirim ke model.	Tidak.
file_id	string (dapat diakses NULL)		Tidak.
file_url	string	URL 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.InputContentInputImageContent

Input gambar ke model. Pelajari tentang input image.

Nama	Tipe	Deskripsi	Diperlukan
detail	OpenAI.ImageDetail		Yes
file_id	string (dapat diakses NULL)		Tidak.
image_url	string		Tidak.
jenis	enum	Jenis item input. Selalu `input_image`. Nilai yang mungkin: `input_image`	Yes

OpenAI.InputContentInputTextContent

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

Harta benda	Nilai
Jenis	string
Nilai	`input_text` `input_image` `input_file`

OpenAI.InputFidelity

Kontrol berapa banyak upaya yang akan dilakukan model untuk mencocokkan gaya dan fitur, terutama fitur wajah, dari gambar input. Parameter ini hanya didukung untuk gpt-image-1. Tidak didukung untuk gpt-image-1-mini. Mendukung high dan low. Secara default menjadi low.

Harta benda	Nilai
Jenis	string
Nilai	`high` `low`

OpenAI.InputFileContent

Sebuah file input ke model.

Nama	Tipe	Deskripsi	Diperlukan
file_data	string	Konten file yang akan dikirim ke model.	Tidak.
file_id	string (dapat diakses NULL)		Tidak.
file_url	string	URL 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.InputFileContentParam

Sebuah file input ke model.

Nama	Tipe	Deskripsi	Diperlukan
file_data	string (dapat diakses NULL)		Tidak.
file_id	string (dapat diakses NULL)		Tidak.
file_url	string		Tidak.
filename	string (dapat diakses NULL)		Tidak.
jenis	enum	Jenis item input. Selalu `input_file`. Nilai yang mungkin: `input_file`	Yes

OpenAI.InputImageContent

Input gambar ke model. Pelajari tentang input image.

Nama	Tipe	Deskripsi	Diperlukan
detail	OpenAI.ImageDetail		Yes
file_id	string (dapat diakses NULL)		Tidak.
image_url	string		Tidak.
jenis	enum	Jenis item input. Selalu `input_image`. Nilai yang mungkin: `input_image`	Yes

OpenAI.InputImageContentParamAutoParam

Input gambar ke model. Pelajari tentang input gambar

Nama	Tipe	Deskripsi	Diperlukan
detail	OpenAI.DetailEnum (dapat diakses oleh null)		Tidak.
file_id	string (dapat diakses NULL)		Tidak.
image_url	string		Tidak.
jenis	enum	Jenis item input. Selalu `input_image`. Nilai yang mungkin: `input_image`	Yes

OpenAI.InputItem

Item yang mewakili bagian dari konteks untuk respons yang akan dihasilkan oleh model. Dapat berisi input teks, gambar, dan audio, serta respons asisten dan output panggilan alat sebelumnya.

Diskriminator untuk OpenAI.InputItem

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
`message`	OpenAI.EasyInputMessage
`item_reference`	OpenAI.ItemReferenceParam
`output_message`	OpenAI.InputItemOutputMessage
`file_search_call`	OpenAI.InputItemFileSearchToolCall
`computer_call`	OpenAI.InputItemComputerToolCall
`computer_call_output`	OpenAI.InputItemComputerCallOutputItemParam
`web_search_call`	OpenAI.InputItemWebSearchToolCall
`function_call`	OpenAI.InputItemFunctionToolCall
`function_call_output`	OpenAI.InputItemFunctionCallOutputItemParam
`reasoning`	OpenAI.InputItemReasoningItem
`compaction`	OpenAI.InputItemCompactionSummaryItemParam
`image_generation_call`	OpenAI.InputItemImageGenToolCall
`code_interpreter_call`	OpenAI.InputItemCodeInterpreterToolCall
`local_shell_call`	OpenAI.InputItemLocalShellToolCall
`local_shell_call_output`	OpenAI.InputItemLocalShellToolCallOutput
`shell_call`	OpenAI.InputItemFunctionShellCallItemParam
`shell_call_output`	OpenAI.InputItemFunctionShellCallOutputItemParam
`apply_patch_call`	OpenAI.InputItemApplyPatchToolCallItemParam
`apply_patch_call_output`	OpenAI.InputItemApplyPatchToolCallOutputItemParam
`mcp_list_tools`	OpenAI.InputItemMcpListTools
`mcp_approval_request`	OpenAI.InputItemMcpApprovalRequest
`mcp_approval_response`	OpenAI.InputItemMcpApprovalResponse
`mcp_call`	OpenAI.InputItemMcpToolCall
`custom_tool_call_output`	OpenAI.InputItemCustomToolCallOutput
`custom_tool_call`	OpenAI.InputItemCustomToolCall

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	OpenAI.InputItemType		Yes

OpenAI.InputItemApplyPatchToolCallItemParam

Panggilan alat yang mewakili permintaan untuk membuat, menghapus, atau memperbarui file menggunakan tambalan diff.

Nama	Tipe	Deskripsi	Diperlukan
call_id	string	ID unik dari panggilan alat patch terapkan yang dihasilkan oleh model. Batasan: minLength: 1, maxLength: 64	Yes
id	string (dapat diakses NULL)		Tidak.
operasi	OpenAI.ApplyPatchOperationParam	Salah satu operasi create_file, delete_file, atau update_file yang dipasok ke alat apply_patch.	Yes
└─ jenis	OpenAI.ApplyPatchOperationParamType		Yes
status	OpenAI.ApplyPatchCallStatusParam	Nilai status yang dilaporkan untuk panggilan alat apply_patch.	Yes
jenis	enum	Jenis item. Selalu `apply_patch_call`. Nilai yang mungkin: `apply_patch_call`	Yes

OpenAI.InputItemApplyPatchToolCallOutputItemParam

Output streaming yang dipancarkan oleh panggilan alat patch terap.

Nama	Tipe	Deskripsi	Diperlukan
call_id	string	ID unik dari panggilan alat patch terapkan yang dihasilkan oleh model. Batasan: minLength: 1, maxLength: 64	Yes
id	string (dapat diakses NULL)		Tidak.
output	string (dapat diakses NULL)		Tidak.
status	OpenAI.ApplyPatchCallOutputStatusParam	Nilai hasil yang dilaporkan untuk output panggilan alat apply_patch.	Yes
jenis	enum	Jenis item. Selalu `apply_patch_call_output`. Nilai yang mungkin: `apply_patch_call_output`	Yes

OpenAI.InputItemCodeInterpreterToolCall

Panggilan alat untuk menjalankan kode.

Nama	Tipe	Deskripsi	Diperlukan
kode	string (dapat diakses NULL)		Yes
container_id	string	ID kontainer yang digunakan untuk menjalankan kode.	Yes
id	string	ID unik dari panggilan alat penerjemah kode.	Yes
Keluaran	array OpenAI.CodeInterpreterOutputLogs atau OpenAI.CodeInterpreterOutputImage		Yes
status	enum	Status panggilan alat penerjemah kode. Nilai yang valid adalah `in_progress`, `completed`, `incomplete`, `interpreting`, dan `failed`. Nilai yang mungkin: `in_progress`, , `completedincomplete`, `interpreting`,`failed`	Yes
jenis	enum	Jenis panggilan alat penerjemah kode. Selalu `code_interpreter_call`. Nilai yang mungkin: `code_interpreter_call`	Yes

OpenAI.InputItemCompactionSummaryItemParam

Item pemadatan yang dihasilkan oleh v1/responses/compact API.

Nama	Tipe	Deskripsi	Diperlukan
encrypted_content	string	Konten terenkripsi dari ringkasan pemadatan. Batasan: maxLength: 10485760	Yes
id	string (dapat diakses NULL)		Tidak.
jenis	enum	Jenis item. Selalu `compaction`. Nilai yang mungkin: `compaction`	Yes

OpenAI.InputItemComputerCallOutputItemParam

Keluaran dari pengoperasian alat komputer.

Nama	Tipe	Deskripsi	Diperlukan
acknowledged_safety_checks	array OpenAI.ComputerCallSafetyCheckParam		Tidak.
call_id	string	ID panggilan alat komputer yang menghasilkan output. Batasan: minLength: 1, maxLength: 64	Yes
id	string (dapat diakses NULL)		Tidak.
output	OpenAI.ComputerScreenshotImage	Gambar cuplikan layar komputer yang digunakan dengan alat untuk penggunaan komputer.	Yes
status	OpenAI.FunctionCallItemStatus (dapat diubah ke null)		Tidak.
jenis	enum	Jenis output panggilan alat komputer. Selalu `computer_call_output`. Nilai yang mungkin: `computer_call_output`	Yes

OpenAI.InputItemComputerToolCall

Panggilan alat ke alat penggunaan komputer. Lihat panduan penggunaan komputer komputer untuk informasi lebih lanjut.

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

OpenAI.InputItemCustomToolCall

Panggilan ke alat kustom yang dibuat oleh model.

Nama	Tipe	Deskripsi	Diperlukan
call_id	string	Pengidentifikasi yang digunakan untuk memetakan panggilan alat kustom ini ke output panggilan alat.	Yes
id	string	ID unik dari panggilan alat khusus di platform OpenAI.	Tidak.
Masukan	string	Input untuk panggilan alat kustom yang dihasilkan oleh model.	Yes
Nama	string	Nama perangkat kustom yang dipanggil.	Yes
jenis	enum	Jenis panggilan alat kustom. Selalu `custom_tool_call`. Nilai yang mungkin: `custom_tool_call`	Yes

OpenAI.InputItemCustomToolCallOutput

Output dari panggilan alat kustom dari kode Anda, dikirim kembali ke model.

Nama	Tipe	Deskripsi	Diperlukan
call_id	string	ID panggilan, digunakan untuk memetakan output panggilan alat kustom ini ke panggilan alat kustom.	Yes
id	string	ID unik dari output panggilan alat khusus di platform OpenAI.	Tidak.
output	string atau array OpenAI.FunctionAndCustomToolCallOutput	Output dari panggilan alat kustom yang dihasilkan oleh kode Anda. Dapat berupa string atau daftar konten output.	Yes
jenis	enum	Jenis output panggilan alat kustom. Selalu `custom_tool_call_output`. Nilai yang mungkin: `custom_tool_call_output`	Yes

OpenAI.InputItemFileSearchToolCall

Hasil panggilan alat pencarian file. Lihat panduan pencarian file file untuk informasi selengkapnya.

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

OpenAI.InputItemFunctionCallOutputItemParam

Output dari pemanggilan fungsi alat.

Nama	Tipe	Deskripsi	Diperlukan
call_id	string	ID unik dari panggilan alat fungsional yang dihasilkan oleh model. Batasan: minLength: 1, maxLength: 64	Yes
id	string (dapat diakses NULL)		Tidak.
output	string atau array OpenAI.InputTextContentParam atau OpenAI.InputImageContentParamAutoParam atau OpenAI.InputFileContentParam	Keluaran teks, gambar, atau file dari panggilan alat fungsi.	Yes
status	OpenAI.FunctionCallItemStatus (dapat diubah ke null)		Tidak.
jenis	enum	Jenis keluaran panggilan fungsi perangkat. Selalu `function_call_output`. Nilai yang mungkin: `function_call_output`	Yes

OpenAI.InputItemFunctionShellCallItemParam

Alat yang mewakili permintaan untuk mengeksekusi satu atau beberapa perintah shell.

Nama	Tipe	Deskripsi	Diperlukan
tindakan	OpenAI.FunctionShellActionParam	Perintah dan batas yang menjelaskan cara menjalankan panggilan alat shell.	Yes
└─ perintah	array string	Perintah shell yang diperintahkan agar lingkungan eksekusi berjalan.	Yes
└─ max_output_length	OpenAI.integer (dapat diakses dengan null)		Tidak.
└─ timeout_ms	OpenAI.integer (dapat diakses dengan null)		Tidak.
call_id	string	ID unik panggilan alat shell yang dihasilkan oleh model. Batasan: minLength: 1, maxLength: 64	Yes
id	string (dapat diakses NULL)		Tidak.
status	OpenAI.FunctionShellCallItemStatus (dapat diubah untuk null)	Nilai status yang dilaporkan untuk panggilan alat shell.	Tidak.
jenis	enum	Jenis item. Selalu `shell_call`. Nilai yang mungkin: `shell_call`	Yes

OpenAI.InputItemFunctionShellCallOutputItemParam

Item output yang dialirkan yang dipancarkan oleh panggilan alat shell.

Nama	Tipe	Deskripsi	Diperlukan
call_id	string	ID unik panggilan alat shell yang dihasilkan oleh model. Batasan: minLength: 1, maxLength: 64	Yes
id	string (dapat diakses NULL)		Tidak.
max_output_length	OpenAI.integer (dapat diakses dengan null)		Tidak.
output	array OpenAI.FunctionShellCallOutputContentParam	Menangkap potongan output stdout dan stderr, bersama dengan hasil terkait.	Yes
jenis	enum	Jenis item. Selalu `shell_call_output`. Nilai yang mungkin: `shell_call_output`	Yes

OpenAI.InputItemFunctionToolCall

Panggilan alat untuk menjalankan fungsi. Lihat panduan pemanggilan fungsi untuk informasi selengkapnya.

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

OpenAI.InputItemImageGenToolCall

Permintaan pembuatan gambar yang dibuat oleh model.

Nama	Tipe	Deskripsi	Diperlukan
id	string	ID unik panggilan pembuatan gambar.	Yes
hasil	string (dapat diakses NULL)		Yes
status	enum	Status panggilan pembuatan gambar. Nilai yang mungkin: `in_progress`, `completed`, `generating`, `failed`	Yes
jenis	enum	Jenis panggilan pembuatan gambar. Selalu `image_generation_call`. Nilai yang mungkin: `image_generation_call`	Yes

OpenAI.InputItemLocalShellToolCall

Panggilan alat untuk menjalankan perintah pada shell lokal.

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

OpenAI.InputItemLocalShellToolCallOutput

Output panggilan alat shell lokal.

Nama	Tipe	Deskripsi	Diperlukan
id	string	ID unik dari panggilan alat shell lokal yang dihasilkan oleh model.	Yes
output	string	String JSON dari output panggilan alat shell lokal.	Yes
status	enum	Nilai yang mungkin: `in_progress`, `completed`, `incomplete`	Tidak.
jenis	enum	Jenis output panggilan alat shell lokal. Selalu `local_shell_call_output`. Nilai yang mungkin: `local_shell_call_output`	Yes

OpenAI.InputItemMcpApprovalRequest

Permintaan persetujuan dari manusia untuk penggunaan alat.

Nama	Tipe	Deskripsi	Diperlukan
argumen	string	String argumen JSON untuk alat ini.	Yes
id	string	ID unik permintaan persetujuan.	Yes
Nama	string	Nama alat yang akan dijalankan.	Yes
server_label	string	Label server MCP yang membuat permintaan.	Yes
jenis	enum	Jenis item. Selalu `mcp_approval_request`. Nilai yang mungkin: `mcp_approval_request`	Yes

OpenAI.InputItemMcpApprovalResponse

Respons terhadap permintaan persetujuan MCP.

Nama	Tipe	Deskripsi	Diperlukan
approval_request_id	string	ID permintaan persetujuan yang dijawab.	Yes
approve	Boolean	Apakah permintaan disetujui.	Yes
id	string (dapat diakses NULL)		Tidak.
alasan	string (dapat diakses NULL)		Tidak.
jenis	enum	Jenis item. Selalu `mcp_approval_response`. Nilai yang mungkin: `mcp_approval_response`	Yes

OpenAI.InputItemMcpListTools

Daftar alat yang tersedia di server MCP.

Nama	Tipe	Deskripsi	Diperlukan
galat	string (dapat diakses NULL)		Tidak.
id	string	ID unik daftar.	Yes
server_label	string	Label MCP server.	Yes
perangkat	array OpenAI.MCPListToolsToolsTool	Alat yang tersedia di server.	Yes
jenis	enum	Jenis item. Selalu `mcp_list_tools`. Nilai yang mungkin: `mcp_list_tools`	Yes

OpenAI.InputItemMcpToolCall

Pemanggilan alat di server MCP.

Nama	Tipe	Deskripsi	Diperlukan
approval_request_id	string (dapat diakses NULL)		Tidak.
argumen	string	String JSON dari argumen yang dikirimkan ke alat.	Yes
galat	string (dapat diakses NULL)		Tidak.
id	string	ID unik panggilan alat.	Yes
Nama	string	Nama alat yang dijalankan.	Yes
output	string (dapat diakses NULL)		Tidak.
server_label	string	Label server MCP yang menjalankan alat.	Yes
status	OpenAI.MCPToolCallStatus		Tidak.
jenis	enum	Jenis item. Selalu `mcp_call`. Nilai yang mungkin: `mcp_call`	Yes

OpenAI.InputItemOutputMessage

Pesan hasil dari model.

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

OpenAI.InputItemReasoningItem

Nama	Tipe	Deskripsi	Diperlukan
isi	array OpenAI.ReasoningTextContent	Konten teks penalaran.	Tidak.
encrypted_content	string (dapat diakses NULL)		Tidak.
id	string	Pengidentifikasi unik dari konten alasan.	Yes
status	enum	Status barang tersebut. Salah satu dari `in_progress`, `completed`, atau `incomplete`. Diisi saat item dikembalikan melalui API. Nilai yang mungkin: `in_progress`, `completed`, `incomplete`	Tidak.
summary	array OpenAI.Summary	Konten ringkasan penalaran.	Yes
jenis	enum	Jenis objek. Selalu `reasoning`. Nilai yang mungkin: `reasoning`	Yes

OpenAI.InputItemType

Harta benda Nilai

Jenis string

Nilai message
output_message
file_search_call
computer_call
computer_call_output
web_search_call
function_call
function_call_output
reasoning
compaction
image_generation_call
code_interpreter_call
local_shell_call
local_shell_call_output
shell_call
shell_call_output
apply_patch_call
apply_patch_call_output
mcp_list_tools
mcp_approval_request
mcp_approval_response
mcp_call
custom_tool_call_output
custom_tool_call
item_reference

OpenAI.InputItemWebSearchToolCall

Hasil panggilan alat pencarian web. Lihat panduan pencarian web untuk informasi selengkapnya.

Nama	Tipe	Deskripsi	Diperlukan
tindakan	OpenAI.WebSearchActionSearch atau OpenAI.WebSearchActionOpenPage atau OpenAI.WebSearchActionFind	Objek yang menjelaskan tindakan spesifik yang diambil dalam panggilan pencarian web ini. Mencakup detail tentang bagaimana model menggunakan web (pencarian, open_page, temukan).	Yes
id	string	ID unik dari panggilan alat pencarian web.	Yes
status	enum	Status panggilan alat pencarian web. Nilai yang mungkin: `in_progress`, `searching`, `completed`, `failed`	Yes
jenis	enum	Jenis panggilan alat pencarian web. Selalu `web_search_call`. Nilai yang mungkin: `web_search_call`	Yes

OpenAI.InputMessage

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

OpenAI.InputMessageContentList

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

Array dari: OpenAI.InputContent

OpenAI.InputMessageResource

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

OpenAI.InputParam

Input teks, gambar, atau file ke model, digunakan untuk menghasilkan respons. Pelajari lebih lanjut:

Jenis: string atau array OpenAI.InputItem

Input teks, gambar, atau file ke model, digunakan untuk menghasilkan respons. Pelajari lebih lanjut:

OpenAI.InputTextContent

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

Input teks ke model.

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

OpenAI.Item

Item konten yang digunakan untuk menghasilkan respons.

Diskriminator untuk OpenAI.Item

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
`memory_search_call`	MemorySearchToolCallItemParam
`message`	OpenAI.InputMessage
`output_message`	OpenAI.ItemOutputMessage
`file_search_call`	OpenAI.ItemFileSearchToolCall
`computer_call`	OpenAI.ItemComputerToolCall
`computer_call_output`	OpenAI.ItemComputerCallOutputItemParam
`web_search_call`	OpenAI.ItemWebSearchToolCall
`function_call`	OpenAI.ItemFunctionToolCall
`function_call_output`	OpenAI.ItemFunctionCallOutputItemParam
`reasoning`	OpenAI.ItemReasoningItem
`compaction`	OpenAI.ItemCompactionSummaryItemParam
`image_generation_call`	OpenAI.ItemImageGenToolCall
`code_interpreter_call`	OpenAI.ItemCodeInterpreterToolCall
`local_shell_call`	OpenAI.ItemLocalShellToolCall
`local_shell_call_output`	OpenAI.ItemLocalShellToolCallOutput
`shell_call`	OpenAI.ItemFunctionShellCallItemParam
`shell_call_output`	OpenAI.ItemFunctionShellCallOutputItemParam
`apply_patch_call`	OpenAI.ItemApplyPatchToolCallItemParam
`apply_patch_call_output`	OpenAI.ItemApplyPatchToolCallOutputItemParam
`mcp_list_tools`	OpenAI.ItemMcpListTools
`mcp_approval_request`	OpenAI.ItemMcpApprovalRequest
`mcp_approval_response`	OpenAI.ItemMcpApprovalResponse
`mcp_call`	OpenAI.ItemMcpToolCall
`custom_tool_call_output`	OpenAI.ItemCustomToolCallOutput
`custom_tool_call`	OpenAI.ItemCustomToolCall

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	OpenAI.ItemType		Yes

OpenAI.ItemApplyPatchToolCallItemParam

Panggilan alat yang mewakili permintaan untuk membuat, menghapus, atau memperbarui file menggunakan tambalan diff.

Nama	Tipe	Deskripsi	Diperlukan
call_id	string	ID unik dari panggilan alat patch terapkan yang dihasilkan oleh model. Batasan: minLength: 1, maxLength: 64	Yes
id	string (dapat diakses NULL)		Tidak.
operasi	OpenAI.ApplyPatchOperationParam	Salah satu operasi create_file, delete_file, atau update_file yang dipasok ke alat apply_patch.	Yes
└─ jenis	OpenAI.ApplyPatchOperationParamType		Yes
status	OpenAI.ApplyPatchCallStatusParam	Nilai status yang dilaporkan untuk panggilan alat apply_patch.	Yes
jenis	enum	Jenis item. Selalu `apply_patch_call`. Nilai yang mungkin: `apply_patch_call`	Yes

OpenAI.ItemApplyPatchToolCallOutputItemParam

Output streaming yang dipancarkan oleh panggilan alat patch terap.

Nama	Tipe	Deskripsi	Diperlukan
call_id	string	ID unik dari panggilan alat patch terapkan yang dihasilkan oleh model. Batasan: minLength: 1, maxLength: 64	Yes
id	string (dapat diakses NULL)		Tidak.
output	string (dapat diakses NULL)		Tidak.
status	OpenAI.ApplyPatchCallOutputStatusParam	Nilai hasil yang dilaporkan untuk output panggilan alat apply_patch.	Yes
jenis	enum	Jenis item. Selalu `apply_patch_call_output`. Nilai yang mungkin: `apply_patch_call_output`	Yes

OpenAI.ItemCodeInterpreterToolCall

Panggilan alat untuk menjalankan kode.

Nama	Tipe	Deskripsi	Diperlukan
kode	string (dapat diakses NULL)		Yes
container_id	string	ID kontainer yang digunakan untuk menjalankan kode.	Yes
id	string	ID unik dari panggilan alat penerjemah kode.	Yes
Keluaran	array OpenAI.CodeInterpreterOutputLogs atau OpenAI.CodeInterpreterOutputImage		Yes
status	enum	Status panggilan alat penerjemah kode. Nilai yang valid adalah `in_progress`, `completed`, `incomplete`, `interpreting`, dan `failed`. Nilai yang mungkin: `in_progress`, , `completedincomplete`, `interpreting`,`failed`	Yes
jenis	enum	Jenis panggilan alat penerjemah kode. Selalu `code_interpreter_call`. Nilai yang mungkin: `code_interpreter_call`	Yes

OpenAI.ItemCompactionSummaryItemParam

Item pemadatan yang dihasilkan oleh v1/responses/compact API.

Nama	Tipe	Deskripsi	Diperlukan
encrypted_content	string	Konten terenkripsi dari ringkasan pemadatan. Batasan: maxLength: 10485760	Yes
id	string (dapat diakses NULL)		Tidak.
jenis	enum	Jenis item. Selalu `compaction`. Nilai yang mungkin: `compaction`	Yes

OpenAI.ItemComputerCallOutputItemParam

Keluaran dari pengoperasian alat komputer.

Nama	Tipe	Deskripsi	Diperlukan
acknowledged_safety_checks	array OpenAI.ComputerCallSafetyCheckParam		Tidak.
call_id	string	ID panggilan alat komputer yang menghasilkan output. Batasan: minLength: 1, maxLength: 64	Yes
id	string (dapat diakses NULL)		Tidak.
output	OpenAI.ComputerScreenshotImage	Gambar cuplikan layar komputer yang digunakan dengan alat untuk penggunaan komputer.	Yes
status	OpenAI.FunctionCallItemStatus (dapat diubah ke null)		Tidak.
jenis	enum	Jenis output panggilan alat komputer. Selalu `computer_call_output`. Nilai yang mungkin: `computer_call_output`	Yes

OpenAI.ItemComputerToolCall

Panggilan alat ke alat penggunaan komputer. Lihat panduan penggunaan komputer komputer untuk informasi lebih lanjut.

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

OpenAI.ItemCustomToolCall

Panggilan ke alat kustom yang dibuat oleh model.

Nama	Tipe	Deskripsi	Diperlukan
call_id	string	Pengidentifikasi yang digunakan untuk memetakan panggilan alat kustom ini ke output panggilan alat.	Yes
id	string	ID unik dari panggilan alat khusus di platform OpenAI.	Tidak.
Masukan	string	Input untuk panggilan alat kustom yang dihasilkan oleh model.	Yes
Nama	string	Nama perangkat kustom yang dipanggil.	Yes
jenis	enum	Jenis panggilan alat kustom. Selalu `custom_tool_call`. Nilai yang mungkin: `custom_tool_call`	Yes

OpenAI.ItemCustomToolCallOutput

Output dari panggilan alat kustom dari kode Anda, dikirim kembali ke model.

Nama	Tipe	Deskripsi	Diperlukan
call_id	string	ID panggilan, digunakan untuk memetakan output panggilan alat kustom ini ke panggilan alat kustom.	Yes
id	string	ID unik dari output panggilan alat khusus di platform OpenAI.	Tidak.
output	string atau array OpenAI.FunctionAndCustomToolCallOutput	Output dari panggilan alat kustom yang dihasilkan oleh kode Anda. Dapat berupa string atau daftar konten output.	Yes
jenis	enum	Jenis output panggilan alat kustom. Selalu `custom_tool_call_output`. Nilai yang mungkin: `custom_tool_call_output`	Yes

OpenAI.ItemFileSearchToolCall

Hasil panggilan alat pencarian file. Lihat panduan pencarian file file untuk informasi selengkapnya.

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

OpenAI.ItemFunctionCallOutputItemParam

Output dari pemanggilan fungsi alat.

Nama	Tipe	Deskripsi	Diperlukan
call_id	string	ID unik dari panggilan alat fungsional yang dihasilkan oleh model. Batasan: minLength: 1, maxLength: 64	Yes
id	string (dapat diakses NULL)		Tidak.
output	string atau array OpenAI.InputTextContentParam atau OpenAI.InputImageContentParamAutoParam atau OpenAI.InputFileContentParam	Keluaran teks, gambar, atau file dari panggilan alat fungsi.	Yes
status	OpenAI.FunctionCallItemStatus (dapat diubah ke null)		Tidak.
jenis	enum	Jenis keluaran panggilan fungsi perangkat. Selalu `function_call_output`. Nilai yang mungkin: `function_call_output`	Yes

OpenAI.ItemFunctionShellCallItemParam

Alat yang mewakili permintaan untuk mengeksekusi satu atau beberapa perintah shell.

Nama	Tipe	Deskripsi	Diperlukan
tindakan	OpenAI.FunctionShellActionParam	Perintah dan batas yang menjelaskan cara menjalankan panggilan alat shell.	Yes
└─ perintah	array string	Perintah shell yang diperintahkan agar lingkungan eksekusi berjalan.	Yes
└─ max_output_length	OpenAI.integer (dapat diakses dengan null)		Tidak.
└─ timeout_ms	OpenAI.integer (dapat diakses dengan null)		Tidak.
call_id	string	ID unik panggilan alat shell yang dihasilkan oleh model. Batasan: minLength: 1, maxLength: 64	Yes
id	string (dapat diakses NULL)		Tidak.
status	OpenAI.FunctionShellCallItemStatus (dapat diubah untuk null)	Nilai status yang dilaporkan untuk panggilan alat shell.	Tidak.
jenis	enum	Jenis item. Selalu `shell_call`. Nilai yang mungkin: `shell_call`	Yes

OpenAI.ItemFunctionShellCallOutputItemParam

Item output yang dialirkan yang dipancarkan oleh panggilan alat shell.

Nama	Tipe	Deskripsi	Diperlukan
call_id	string	ID unik panggilan alat shell yang dihasilkan oleh model. Batasan: minLength: 1, maxLength: 64	Yes
id	string (dapat diakses NULL)		Tidak.
max_output_length	OpenAI.integer (dapat diakses dengan null)		Tidak.
output	array OpenAI.FunctionShellCallOutputContentParam	Menangkap potongan output stdout dan stderr, bersama dengan hasil terkait.	Yes
jenis	enum	Jenis item. Selalu `shell_call_output`. Nilai yang mungkin: `shell_call_output`	Yes

OpenAI.ItemFunctionToolCall

Panggilan alat untuk menjalankan fungsi. Lihat panduan pemanggilan fungsi untuk informasi selengkapnya.

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

OpenAI.ItemImageGenToolCall

Permintaan pembuatan gambar yang dibuat oleh model.

Nama	Tipe	Deskripsi	Diperlukan
id	string	ID unik panggilan pembuatan gambar.	Yes
hasil	string (dapat diakses NULL)		Yes
status	enum	Status panggilan pembuatan gambar. Nilai yang mungkin: `in_progress`, `completed`, `generating`, `failed`	Yes
jenis	enum	Jenis panggilan pembuatan gambar. Selalu `image_generation_call`. Nilai yang mungkin: `image_generation_call`	Yes

OpenAI.ItemLocalShellToolCall

Panggilan alat untuk menjalankan perintah pada shell lokal.

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

OpenAI.ItemLocalShellToolCallOutput

Output panggilan alat shell lokal.

Nama	Tipe	Deskripsi	Diperlukan
id	string	ID unik dari panggilan alat shell lokal yang dihasilkan oleh model.	Yes
output	string	String JSON dari output panggilan alat shell lokal.	Yes
status	enum	Nilai yang mungkin: `in_progress`, `completed`, `incomplete`	Tidak.
jenis	enum	Jenis output panggilan alat shell lokal. Selalu `local_shell_call_output`. Nilai yang mungkin: `local_shell_call_output`	Yes

OpenAI.ItemMcpApprovalRequest

Permintaan persetujuan dari manusia untuk penggunaan alat.

Nama	Tipe	Deskripsi	Diperlukan
argumen	string	String argumen JSON untuk alat ini.	Yes
id	string	ID unik permintaan persetujuan.	Yes
Nama	string	Nama alat yang akan dijalankan.	Yes
server_label	string	Label server MCP yang membuat permintaan.	Yes
jenis	enum	Jenis item. Selalu `mcp_approval_request`. Nilai yang mungkin: `mcp_approval_request`	Yes

OpenAI.ItemMcpApprovalResponse

Respons terhadap permintaan persetujuan MCP.

Nama	Tipe	Deskripsi	Diperlukan
approval_request_id	string	ID permintaan persetujuan yang dijawab.	Yes
approve	Boolean	Apakah permintaan disetujui.	Yes
id	string (dapat diakses NULL)		Tidak.
alasan	string (dapat diakses NULL)		Tidak.
jenis	enum	Jenis item. Selalu `mcp_approval_response`. Nilai yang mungkin: `mcp_approval_response`	Yes

OpenAI.ItemMcpListTools

Daftar alat yang tersedia di server MCP.

Nama	Tipe	Deskripsi	Diperlukan
galat	string (dapat diakses NULL)		Tidak.
id	string	ID unik daftar.	Yes
server_label	string	Label MCP server.	Yes
perangkat	array OpenAI.MCPListToolsToolsTool	Alat yang tersedia di server.	Yes
jenis	enum	Jenis item. Selalu `mcp_list_tools`. Nilai yang mungkin: `mcp_list_tools`	Yes

OpenAI.ItemMcpToolCall

Pemanggilan alat di server MCP.

Nama	Tipe	Deskripsi	Diperlukan
approval_request_id	string (dapat diakses NULL)		Tidak.
argumen	string	String JSON dari argumen yang dikirimkan ke alat.	Yes
galat	string (dapat diakses NULL)		Tidak.
id	string	ID unik panggilan alat.	Yes
Nama	string	Nama alat yang dijalankan.	Yes
output	string (dapat diakses NULL)		Tidak.
server_label	string	Label server MCP yang menjalankan alat.	Yes
status	OpenAI.MCPToolCallStatus		Tidak.
jenis	enum	Jenis item. Selalu `mcp_call`. Nilai yang mungkin: `mcp_call`	Yes

OpenAI.ItemOutputMessage

Pesan hasil dari model.

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

OpenAI.ItemReasoningItem

Nama	Tipe	Deskripsi	Diperlukan
isi	array OpenAI.ReasoningTextContent	Konten teks penalaran.	Tidak.
encrypted_content	string (dapat diakses NULL)		Tidak.
id	string	Pengidentifikasi unik dari konten alasan.	Yes
status	enum	Status barang tersebut. Salah satu dari `in_progress`, `completed`, atau `incomplete`. Diisi saat item dikembalikan melalui API. Nilai yang mungkin: `in_progress`, `completed`, `incomplete`	Tidak.
summary	array OpenAI.Summary	Konten ringkasan penalaran.	Yes
jenis	enum	Jenis objek. Selalu `reasoning`. Nilai yang mungkin: `reasoning`	Yes

OpenAI.ItemReferenceParam

Pengidentifikasi internal untuk item yang akan dirujuk.

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

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
`message`	OpenAI.InputMessageResource
`output_message`	OpenAI.ItemResourceOutputMessage
`file_search_call`	OpenAI.ItemResourceFileSearchToolCall
`computer_call`	OpenAI.ItemResourceComputerToolCall
`computer_call_output`	OpenAI.ItemResourceComputerToolCallOutputResource
`web_search_call`	OpenAI.ItemResourceWebSearchToolCall
`function_call`	OpenAI.ItemResourceFunctionToolCallResource
`function_call_output`	OpenAI.ItemResourceFunctionToolCallOutputResource
`image_generation_call`	OpenAI.ItemResourceImageGenToolCall
`code_interpreter_call`	OpenAI.ItemResourceCodeInterpreterToolCall
`local_shell_call`	OpenAI.ItemResourceLocalShellToolCall
`local_shell_call_output`	OpenAI.ItemResourceLocalShellToolCallOutput
`shell_call`	OpenAI.ItemResourceFunctionShellCall
`shell_call_output`	OpenAI.ItemResourceFunctionShellCallOutput
`apply_patch_call`	OpenAI.ItemResourceApplyPatchToolCall
`apply_patch_call_output`	OpenAI.ItemResourceApplyPatchToolCallOutput
`mcp_list_tools`	OpenAI.ItemResourceMcpListTools
`mcp_approval_request`	OpenAI.ItemResourceMcpApprovalRequest
`mcp_approval_response`	OpenAI.ItemResourceMcpApprovalResponseResource
`mcp_call`	OpenAI.ItemResourceMcpToolCall

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	OpenAI.ItemResourceType		Yes

OpenAI.ItemResourceApplyPatchToolCall

Panggilan alat yang menerapkan perbedaan file dengan membuat, menghapus, atau memperbarui file.

Nama	Tipe	Deskripsi	Diperlukan
call_id	string	ID unik dari panggilan alat patch terapkan yang dihasilkan oleh model.	Yes
dibuat oleh	string	ID entitas yang membuat panggilan alat ini.	Tidak.
id	string	ID unik dari panggilan alat terapkan patch. Diisi saat item ini dikembalikan melalui API.	Yes
operasi	OpenAI.ApplyPatchFileOperation	Salah satu operasi create_file, delete_file, atau update_file diterapkan melalui apply_patch.	Yes
└─ jenis	OpenAI.ApplyPatchFileOperationType		Yes
status	OpenAI.ApplyPatchCallStatus		Yes
jenis	enum	Jenis item. Selalu `apply_patch_call`. Nilai yang mungkin: `apply_patch_call`	Yes

OpenAI.ItemResourceApplyPatchToolCallOutput

Output yang dipancarkan oleh panggilan alat patch terapkan.

Nama	Tipe	Deskripsi	Diperlukan
call_id	string	ID unik dari panggilan alat patch terapkan yang dihasilkan oleh model.	Yes
dibuat oleh	string	ID entitas yang membuat output panggilan alat ini.	Tidak.
id	string	ID unik dari output panggilan alat terapkan patch. Diisi saat item ini dikembalikan melalui API.	Yes
output	string (dapat diakses NULL)		Tidak.
status	OpenAI.ApplyPatchCallOutputStatus		Yes
jenis	enum	Jenis item. Selalu `apply_patch_call_output`. Nilai yang mungkin: `apply_patch_call_output`	Yes

OpenAI.ItemResourceCodeInterpreterToolCall

Panggilan alat untuk menjalankan kode.

Nama	Tipe	Deskripsi	Diperlukan
kode	string (dapat diakses NULL)		Yes
container_id	string	ID kontainer yang digunakan untuk menjalankan kode.	Yes
id	string	ID unik dari panggilan alat penerjemah kode.	Yes
Keluaran	array OpenAI.CodeInterpreterOutputLogs atau OpenAI.CodeInterpreterOutputImage		Yes
status	enum	Status panggilan alat penerjemah kode. Nilai yang valid adalah `in_progress`, `completed`, `incomplete`, `interpreting`, dan `failed`. Nilai yang mungkin: `in_progress`, , `completedincomplete`, `interpreting`,`failed`	Yes
jenis	enum	Jenis panggilan alat penerjemah kode. Selalu `code_interpreter_call`. Nilai yang mungkin: `code_interpreter_call`	Yes

OpenAI.ItemResourceComputerToolCall

Panggilan alat ke alat penggunaan komputer. Lihat panduan penggunaan komputer komputer untuk informasi lebih lanjut.

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

OpenAI.ItemResourceComputerToolCallOutputResource

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

OpenAI.ItemResourceFileSearchToolCall

Hasil panggilan alat pencarian file. Lihat panduan pencarian file file untuk informasi selengkapnya.

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

OpenAI.ItemResourceFunctionShellCall

Panggilan alat yang menjalankan satu atau beberapa perintah shell di lingkungan terkelola.

Nama	Tipe	Deskripsi	Diperlukan
tindakan	OpenAI.FunctionShellAction	Jalankan perintah shell.	Yes
└─ perintah	array string		Yes
└─ max_output_length	OpenAI.integer (dapat diakses dengan null)		Yes
└─ timeout_ms	OpenAI.integer (dapat diakses dengan null)		Yes
call_id	string	ID unik panggilan alat shell yang dihasilkan oleh model.	Yes
dibuat oleh	string	ID entitas yang membuat panggilan alat ini.	Tidak.
id	string	ID unik panggilan alat shell. Diisi saat item ini dikembalikan melalui API.	Yes
status	OpenAI.LocalShellCallStatus		Yes
jenis	enum	Jenis item. Selalu `shell_call`. Nilai yang mungkin: `shell_call`	Yes

OpenAI.ItemResourceFunctionShellCallOutput

Output panggilan alat shell yang dipancarkan.

Nama	Tipe	Deskripsi	Diperlukan
call_id	string	ID unik panggilan alat shell yang dihasilkan oleh model.	Yes
dibuat oleh	string	Pengidentifikasi aktor yang membuat item.	Tidak.
id	string	ID unik dari output panggilan shell. Diisi saat item ini dikembalikan melalui API.	Yes
max_output_length	OpenAI.integer (dapat diakses dengan null)		Yes
output	array OpenAI.FunctionShellCallOutputContent	Array konten output panggilan shell	Yes
jenis	enum	Jenis output panggilan shell. Selalu `shell_call_output`. Nilai yang mungkin: `shell_call_output`	Yes

OpenAI.ItemResourceFunctionToolCallOutputResource

Nama	Tipe	Deskripsi	Diperlukan
call_id	string	ID unik dari panggilan alat fungsional yang dihasilkan oleh model.	Yes
id	string	ID unik dari keluaran panggilan peranti fungsi. Diisi ketika item ini dikembalikan melalui API.	Tidak.
output	string atau array OpenAI.FunctionAndCustomToolCallOutput	Output dari panggilan fungsi yang dihasilkan oleh kode Anda. Dapat berupa string atau daftar konten output.	Yes
status	enum	Status barang tersebut. Salah satu dari `in_progress`, `completed`, atau `incomplete`. Diisi saat item dikembalikan melalui API. Nilai yang mungkin: `in_progress`, `completed`, `incomplete`	Tidak.
jenis	enum	Jenis keluaran panggilan fungsi perangkat. Selalu `function_call_output`. Nilai yang mungkin: `function_call_output`	Yes

OpenAI.ItemResourceFunctionToolCallResource

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

OpenAI.ItemResourceImageGenToolCall

Permintaan pembuatan gambar yang dibuat oleh model.

Nama	Tipe	Deskripsi	Diperlukan
id	string	ID unik panggilan pembuatan gambar.	Yes
hasil	string (dapat diakses NULL)		Yes
status	enum	Status panggilan pembuatan gambar. Nilai yang mungkin: `in_progress`, `completed`, `generating`, `failed`	Yes
jenis	enum	Jenis panggilan pembuatan gambar. Selalu `image_generation_call`. Nilai yang mungkin: `image_generation_call`	Yes

OpenAI.ItemResourceLocalShellToolCall

Panggilan alat untuk menjalankan perintah pada shell lokal.

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

OpenAI.ItemResourceLocalShellToolCallOutput

Output panggilan alat shell lokal.

Nama	Tipe	Deskripsi	Diperlukan
id	string	ID unik dari panggilan alat shell lokal yang dihasilkan oleh model.	Yes
output	string	String JSON dari output panggilan alat shell lokal.	Yes
status	enum	Nilai yang mungkin: `in_progress`, `completed`, `incomplete`	Tidak.
jenis	enum	Jenis output panggilan alat shell lokal. Selalu `local_shell_call_output`. Nilai yang mungkin: `local_shell_call_output`	Yes

OpenAI.ItemResourceMcpApprovalRequest

Permintaan persetujuan dari manusia untuk penggunaan alat.

Nama	Tipe	Deskripsi	Diperlukan
argumen	string	String argumen JSON untuk alat ini.	Yes
id	string	ID unik permintaan persetujuan.	Yes
Nama	string	Nama alat yang akan dijalankan.	Yes
server_label	string	Label server MCP yang membuat permintaan.	Yes
jenis	enum	Jenis item. Selalu `mcp_approval_request`. Nilai yang mungkin: `mcp_approval_request`	Yes

OpenAI.ItemResourceMcpApprovalResponseResource

Respons terhadap permintaan persetujuan MCP.

Nama	Tipe	Deskripsi	Diperlukan
approval_request_id	string	ID permintaan persetujuan yang dijawab.	Yes
approve	Boolean	Apakah permintaan disetujui.	Yes
id	string	ID unik respons persetujuan	Yes
alasan	string (dapat diakses NULL)		Tidak.
jenis	enum	Jenis item. Selalu `mcp_approval_response`. Nilai yang mungkin: `mcp_approval_response`	Yes

OpenAI.ItemResourceMcpListTools

Daftar alat yang tersedia di server MCP.

Nama	Tipe	Deskripsi	Diperlukan
galat	string (dapat diakses NULL)		Tidak.
id	string	ID unik daftar.	Yes
server_label	string	Label MCP server.	Yes
perangkat	array OpenAI.MCPListToolsToolsTool	Alat yang tersedia di server.	Yes
jenis	enum	Jenis item. Selalu `mcp_list_tools`. Nilai yang mungkin: `mcp_list_tools`	Yes

OpenAI.ItemResourceMcpToolCall

Pemanggilan alat di server MCP.

Nama	Tipe	Deskripsi	Diperlukan
approval_request_id	string (dapat diakses NULL)		Tidak.
argumen	string	String JSON dari argumen yang dikirimkan ke alat.	Yes
galat	string (dapat diakses NULL)		Tidak.
id	string	ID unik panggilan alat.	Yes
Nama	string	Nama alat yang dijalankan.	Yes
output	string (dapat diakses NULL)		Tidak.
server_label	string	Label server MCP yang menjalankan alat.	Yes
status	OpenAI.MCPToolCallStatus		Tidak.
jenis	enum	Jenis item. Selalu `mcp_call`. Nilai yang mungkin: `mcp_call`	Yes

OpenAI.ItemResourceOutputMessage

Pesan hasil dari model.

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

OpenAI.ItemResourceType

Harta benda Nilai

Jenis string

Nilai message
output_message
file_search_call
computer_call
computer_call_output
web_search_call
function_call
function_call_output
image_generation_call
code_interpreter_call
local_shell_call
local_shell_call_output
shell_call
shell_call_output
apply_patch_call
apply_patch_call_output
mcp_list_tools
mcp_approval_request
mcp_approval_response
mcp_call
structured_outputs
oauth_consent_request
memory_search_call
workflow_action

OpenAI.ItemResourceWebSearchToolCall

Hasil panggilan alat pencarian web. Lihat panduan pencarian web untuk informasi selengkapnya.

Nama	Tipe	Deskripsi	Diperlukan
tindakan	OpenAI.WebSearchActionSearch atau OpenAI.WebSearchActionOpenPage atau OpenAI.WebSearchActionFind	Objek yang menjelaskan tindakan spesifik yang diambil dalam panggilan pencarian web ini. Mencakup detail tentang bagaimana model menggunakan web (pencarian, open_page, temukan).	Yes
id	string	ID unik dari panggilan alat pencarian web.	Yes
status	enum	Status panggilan alat pencarian web. Nilai yang mungkin: `in_progress`, `searching`, `completed`, `failed`	Yes
jenis	enum	Jenis panggilan alat pencarian web. Selalu `web_search_call`. Nilai yang mungkin: `web_search_call`	Yes

OpenAI.ItemType

Harta benda Nilai

Jenis string

OpenAI.ItemWebSearchToolCall

Hasil panggilan alat pencarian web. Lihat panduan pencarian web untuk informasi selengkapnya.

Nama	Tipe	Deskripsi	Diperlukan
tindakan	OpenAI.WebSearchActionSearch atau OpenAI.WebSearchActionOpenPage atau OpenAI.WebSearchActionFind	Objek yang menjelaskan tindakan spesifik yang diambil dalam panggilan pencarian web ini. Mencakup detail tentang bagaimana model menggunakan web (pencarian, open_page, temukan).	Yes
id	string	ID unik dari panggilan alat pencarian web.	Yes
status	enum	Status panggilan alat pencarian web. Nilai yang mungkin: `in_progress`, `searching`, `completed`, `failed`	Yes
jenis	enum	Jenis panggilan alat pencarian web. Selalu `web_search_call`. Nilai yang mungkin: `web_search_call`	Yes

OpenAI.KeyPressAction

Koleksi tombol yang ingin ditekan oleh model.

Nama	Tipe	Deskripsi	Diperlukan	Default
Kunci	array string	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.ListFineTuningJobCheckpointsResponse

Nama	Tipe	Deskripsi	Diperlukan
data	array OpenAI.FineTuningJobCheckpoint		Yes
first_id	string (dapat diakses NULL)		Tidak.
ada_lagi	Boolean		Yes
ID terakhir	string (dapat diakses NULL)		Tidak.
objek	enum	Nilai yang mungkin: `list`	Yes

OpenAI.ListFineTuningJobEventsResponse

Nama	Tipe	Deskripsi	Diperlukan
data	array OpenAI.FineTuningJobEvent		Yes
ada_lagi	Boolean		Yes
objek	enum	Nilai yang mungkin: `list`	Yes

OpenAI.ListPaginatedFineTuningJobsResponse

Nama	Tipe	Deskripsi	Diperlukan
data	array OpenAI.FineTuningJob		Yes
ada_lagi	Boolean		Yes
objek	enum	Nilai yang mungkin: `list`	Yes

OpenAI.LocalShellCallStatus

Harta benda	Nilai
Jenis	string
Nilai	`in_progress` `completed` `incomplete`

OpenAI.LocalShellExecAction

Jalankan perintah shell di server.

Nama	Tipe	Deskripsi	Diperlukan
Perintah	array string	Perintah yang akan dijalankan.	Yes
env	objek	Variabel lingkungan yang akan diatur untuk perintah .	Yes
batas_waktu_ms	OpenAI.integer (dapat diakses dengan null)		Tidak.
jenis	enum	Jenis tindakan shell lokal. Selalu `exec`. Nilai yang mungkin: `exec`	Yes
pengguna	string (dapat diakses NULL)		Tidak.
working_directory	string (dapat diakses NULL)		Tidak.

OpenAI.LocalShellToolParam

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

Probabilitas log token.

Nama	Tipe	Diperlukan
Byte	array OpenAI.integer	Yes
logprob	OpenAI.numeric	Yes
token	string	Yes
top_logprobs	array OpenAI.TopLogProb	Yes

OpenAI.MCPListToolsTool

Alat yang tersedia di server MCP.

Nama	Tipe	Deskripsi	Diperlukan
Anotasi	OpenAI.MCPListToolsToolAnnotations (dapat diubah dengan null)		Tidak.
deskripsi	string (dapat diakses NULL)		Tidak.
input_schema	OpenAI.MCPListToolsToolInputSchema		Yes
Nama	string	Nama alat.	Yes

OpenAI.MCPListToolsToolAnnotations

Jenis: objek

OpenAI.MCPListToolsToolInputSchema

Jenis: objek

OpenAI.MCPTool

Berikan access model ke alat tambahan melalui server Model Context Protocol (MCP) jarak jauh. Pelajari MCP lebih lanjut.

Nama	Tipe	Deskripsi	Diperlukan
alat_terizin	array string atau OpenAI.MCPToolFilter		Tidak.
otorisasi	string	Token access OAuth yang dapat digunakan dengan server MCP jarak jauh, baik dengan URL server MCP kustom atau konektor layanan. Aplikasi Anda harus menangani alur otorisasi OAuth dan menyediakan token di sini.	Tidak.
connector_id	enum	Pengidentifikasi untuk konektor layanan, seperti yang tersedia di ChatGPT. Salah satu `server_url` atau `connector_id` harus disediakan. Pelajari selengkapnya tentang layanan Konektor Di Sini. Nilai yang didukung `connector_id` saat ini adalah: -Dropbox: `connector_dropbox` -Gmail: `connector_gmail` - Google Kalender: `connector_googlecalendar` - Google Drive: `connector_googledrive` - Microsoft Teams: `connector_microsoftteams` - Kalender Outlook: `connector_outlookcalendar` - Email Outlook: `connector_outlookemail` -Sharepoint: `connector_sharepoint` Nilai yang mungkin: `connector_dropbox`, , `connector_gmailconnector_googlecalendar`, `connector_googledrive`, `connector_microsoftteams`, `connector_outlookcalendar`, , `connector_outlookemailconnector_sharepoint`	Tidak.
headers	objek (nullable)		Tidak.
project_connection_id	string	ID koneksi di project untuk server MCP. Koneksi menyimpan autentikasi dan detail koneksi lain yang diperlukan untuk terhubung ke server MCP.	Tidak.
memerlukan persetujuan	objek (lihat model yang valid di bawah)		Tidak.
server_description	string	Deskripsi opsional server MCP, digunakan untuk memberikan lebih banyak konteks.	Tidak.
server_label	string	Label untuk server MCP ini, digunakan untuk mengidentifikasinya dalam panggilan alat.	Yes
server_url	string	URL untuk server MCP. Salah satu dari `server_url` atau `connector_id` harus Disediakan.	Tidak.
jenis	enum	Jenis alat MCP. Selalu `mcp`. Nilai yang mungkin: `mcp`	Yes

OpenAI.MCPToolCallStatus

Harta benda	Nilai
Jenis	string
Nilai	`in_progress` `completed` `incomplete` `calling` `failed`

OpenAI.MCPToolFilter

Objek filter untuk menentukan alat mana yang diizinkan.

Nama	Tipe	Deskripsi	Diperlukan	Default
read_only	Boolean	Menunjukkan apakah alat memodifikasi data atau hanya baca atau tidak. Jika Server MCP diannotasi dengan `readOnlyHint`, ini akan cocok dengan filter ini.	Tidak.
tool_names	array string	Daftar nama alat yang diizinkan.	Tidak.

OpenAI.MCPToolRequireApproval

Nama	Tipe	Deskripsi	Diperlukan	Default
always	OpenAI.MCPToolFilter	Objek filter untuk menentukan alat mana yang diizinkan.	Tidak.
tidak pernah	OpenAI.MCPToolFilter	Objek filter untuk menentukan alat mana yang diizinkan.	Tidak.

OpenAI.MessageContent

Bagian konten yang membentuk item input atau output.

Diskriminator untuk OpenAI.MessageContent

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
`text`	OpenAI.TextContent
`summary_text`	OpenAI.SummaryTextContent
`computer_screenshot`	OpenAI.ComputerScreenshotContent
`input_text`	OpenAI.MessageContentInputTextContent
`output_text`	OpenAI.MessageContentOutputTextContent
`reasoning_text`	OpenAI.MessageContentReasoningTextContent
`refusal`	OpenAI.MessageContentRefusalContent
`input_image`	OpenAI.MessageContentInputImageContent
`input_file`	OpenAI.MessageContentInputFileContent

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	OpenAI.MessageContentType		Yes

OpenAI.MessageContentInputFileContent

Sebuah file input ke model.

Nama	Tipe	Deskripsi	Diperlukan
file_data	string	Konten file yang akan dikirim ke model.	Tidak.
file_id	string (dapat diakses NULL)		Tidak.
file_url	string	URL 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.MessageContentInputImageContent

Input gambar ke model. Pelajari tentang input image.

Nama	Tipe	Deskripsi	Diperlukan
detail	OpenAI.ImageDetail		Yes
file_id	string (dapat diakses NULL)		Tidak.
image_url	string		Tidak.
jenis	enum	Jenis item input. Selalu `input_image`. Nilai yang mungkin: `input_image`	Yes

OpenAI.MessageContentInputTextContent

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

Teks output dari model.

Nama	Tipe	Deskripsi	Diperlukan
Anotasi	array OpenAI.Anotasi	Anotasi keluaran teks.	Yes
logprobs	array OpenAI.LogProb		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.MessageContentReasoningTextContent

Teks penalaran dari model.

Nama	Tipe	Deskripsi	Diperlukan	Default
kirim pesan teks	string	Teks penalaran dari model.	Yes
jenis	enum	Jenis teks penalaran. Selalu `reasoning_text`. Nilai yang mungkin: `reasoning_text`	Yes

OpenAI.MessageContentRefusalContent

Penolakan dari model.

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

OpenAI.MessageContentType

Harta benda	Nilai
Jenis	string
Nilai	`input_text` `output_text` `text` `summary_text` `reasoning_text` `refusal` `input_image` `computer_screenshot` `input_file`

OpenAI.MessageRole

Harta benda	Nilai
Jenis	string
Nilai	`unknown` `user` `assistant` `system` `critic` `discriminator` `developer` `tool`

OpenAI.MessageStatus

Harta benda	Nilai
Jenis	string
Nilai	`in_progress` `completed` `incomplete`

OpenAI.Metadata

Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini dapat berguna untuk menyimpan informasi tambahan tentang objek dalam format terstruktur, dan mengkueri objek melalui API atau dasbor. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter.

Jenis: objek

OpenAI.ModelIdsCompaction

ID model yang digunakan untuk menghasilkan respons, seperti gpt-5 atau o3. OpenAI menawarkan berbagai model dengan kemampuan, karakteristik performa, dan titik harga yang berbeda. Lihat panduan model untuk menelusuri dan membandingkan model yang tersedia.

Jenis: OpenAI.ModelIdsResponses atau string

OpenAI.ModelIdsResponses

Harta benda	Nilai
Jenis	string
Nilai	`o1-pro` `o1-pro-2025-03-19` `o3-pro` `o3-pro-2025-06-10` `o3-deep-research` `o3-deep-research-2025-06-26` `o4-mini-deep-research` `o4-mini-deep-research-2025-06-26` `computer-use-preview` `computer-use-preview-2025-03-11` `gpt-5-codex` `gpt-5-pro` `gpt-5-pro-2025-10-06` `gpt-5.1-codex-max`

OpenAI.ModelIdsShared

Jenis: string atau OpenAI.ChatModel

OpenAI.Move

Aksi gerakan mouse.

Nama	Tipe	Deskripsi	Diperlukan
jenis	enum	Menentukan jenis peristiwa. Untuk tindakan pemindahan, properti ini adalah selalu atur ke `move`. Nilai yang mungkin: `move`	Yes
x	OpenAI.integer		Yes
y	OpenAI.integer		Yes

OpenAI.OutputContent

Diskriminator untuk OpenAI.OutputContent

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
`output_text`	OpenAI.OutputContentOutputTextContent
`refusal`	OpenAI.OutputContentRefusalContent
`reasoning_text`	OpenAI.OutputContentReasoningTextContent

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	OpenAI.OutputContentType		Yes

OpenAI.OutputContentOutputTextContent

Teks output dari model.

Nama	Tipe	Deskripsi	Diperlukan
Anotasi	array OpenAI.Anotasi	Anotasi keluaran teks.	Yes
logprobs	array OpenAI.LogProb		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.OutputContentReasoningTextContent

Teks penalaran dari model.

Nama	Tipe	Deskripsi	Diperlukan	Default
kirim pesan teks	string	Teks penalaran dari model.	Yes
jenis	enum	Jenis teks penalaran. Selalu `reasoning_text`. Nilai yang mungkin: `reasoning_text`	Yes

OpenAI.OutputContentRefusalContent

Penolakan dari model.

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

OpenAI.OutputContentType

Harta benda	Nilai
Jenis	string
Nilai	`output_text` `refusal` `reasoning_text`

OpenAI.OutputItem

Diskriminator untuk OpenAI.OutputItem

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
`structured_outputs`	StructuredOutputsOutputItem
`workflow_action`	WorkflowActionOutputItem
`oauth_consent_request`	OAuthConsentRequestOutputItem
`memory_search_call`	MemorySearchToolCallItemResource
`output_message`	OpenAI.OutputItemOutputMessage
`file_search_call`	OpenAI.OutputItemFileSearchToolCall
`function_call`	OpenAI.OutputItemFunctionToolCall
`web_search_call`	OpenAI.OutputItemWebSearchToolCall
`computer_call`	OpenAI.OutputItemComputerToolCall
`reasoning`	OpenAI.OutputItemReasoningItem
`compaction`	OpenAI.OutputItemCompactionBody
`image_generation_call`	OpenAI.OutputItemImageGenToolCall
`code_interpreter_call`	OpenAI.OutputItemCodeInterpreterToolCall
`local_shell_call`	OpenAI.OutputItemLocalShellToolCall
`shell_call`	OpenAI.OutputItemFunctionShellCall
`shell_call_output`	OpenAI.OutputItemFunctionShellCallOutput
`apply_patch_call`	OpenAI.OutputItemApplyPatchToolCall
`apply_patch_call_output`	OpenAI.OutputItemApplyPatchToolCallOutput
`mcp_call`	OpenAI.OutputItemMcpToolCall
`mcp_list_tools`	OpenAI.OutputItemMcpListTools
`mcp_approval_request`	OpenAI.OutputItemMcpApprovalRequest
`custom_tool_call`	OpenAI.OutputItemCustomToolCall

Nama	Tipe	Deskripsi	Diperlukan
agent_reference	AgentReference		Tidak.
└─ nama	string	Nama agen. Batasan: maxLength: 256	Yes
└─ jenis	enum	Nilai yang mungkin: `agent_reference`	Yes
└─ versi	string	Pengidentifikasi versi agen.	Tidak.
response_id	string	Respons tempat item dibuat.	Tidak.
jenis	OpenAI.OutputItemType		Yes

OpenAI.OutputItemApplyPatchToolCall

Panggilan alat yang menerapkan perbedaan file dengan membuat, menghapus, atau memperbarui file.

Nama	Tipe	Deskripsi	Diperlukan
agent_reference	AgentReference		Tidak.
└─ nama	string	Nama agen. Batasan: maxLength: 256	Yes
└─ jenis	enum	Nilai yang mungkin: `agent_reference`	Yes
└─ versi	string	Pengidentifikasi versi agen.	Tidak.
call_id	string	ID unik dari panggilan alat patch terapkan yang dihasilkan oleh model.	Yes
dibuat oleh	string	ID entitas yang membuat panggilan alat ini.	Tidak.
id	string	ID unik dari panggilan alat terapkan patch. Diisi saat item ini dikembalikan melalui API.	Yes
operasi	OpenAI.ApplyPatchFileOperation	Salah satu operasi create_file, delete_file, atau update_file diterapkan melalui apply_patch.	Yes
└─ jenis	OpenAI.ApplyPatchFileOperationType		Yes
response_id	string	Respons tempat item dibuat.	Tidak.
status	OpenAI.ApplyPatchCallStatus		Yes
jenis	enum	Jenis item. Selalu `apply_patch_call`. Nilai yang mungkin: `apply_patch_call`	Yes

OpenAI.OutputItemApplyPatchToolCallOutput

Output yang dipancarkan oleh panggilan alat patch terapkan.

Nama	Tipe	Deskripsi	Diperlukan
agent_reference	AgentReference		Tidak.
└─ nama	string	Nama agen. Batasan: maxLength: 256	Yes
└─ jenis	enum	Nilai yang mungkin: `agent_reference`	Yes
└─ versi	string	Pengidentifikasi versi agen.	Tidak.
call_id	string	ID unik dari panggilan alat patch terapkan yang dihasilkan oleh model.	Yes
dibuat oleh	string	ID entitas yang membuat output panggilan alat ini.	Tidak.
id	string	ID unik dari output panggilan alat terapkan patch. Diisi saat item ini dikembalikan melalui API.	Yes
output	string (dapat diakses NULL)		Tidak.
response_id	string	Respons tempat item dibuat.	Tidak.
status	OpenAI.ApplyPatchCallOutputStatus		Yes
jenis	enum	Jenis item. Selalu `apply_patch_call_output`. Nilai yang mungkin: `apply_patch_call_output`	Yes

OpenAI.OutputItemCodeInterpreterToolCall

Panggilan alat untuk menjalankan kode.

Nama	Tipe	Deskripsi	Diperlukan
agent_reference	AgentReference		Tidak.
└─ nama	string	Nama agen. Batasan: maxLength: 256	Yes
└─ jenis	enum	Nilai yang mungkin: `agent_reference`	Yes
└─ versi	string	Pengidentifikasi versi agen.	Tidak.
kode	string (dapat diakses NULL)		Yes
container_id	string	ID kontainer yang digunakan untuk menjalankan kode.	Yes
id	string	ID unik dari panggilan alat penerjemah kode.	Yes
Keluaran	array OpenAI.CodeInterpreterOutputLogs atau OpenAI.CodeInterpreterOutputImage		Yes
response_id	string	Respons tempat item dibuat.	Tidak.
status	enum	Status panggilan alat penerjemah kode. Nilai yang valid adalah `in_progress`, `completed`, `incomplete`, `interpreting`, dan `failed`. Nilai yang mungkin: `in_progress`, , `completedincomplete`, `interpreting`,`failed`	Yes
jenis	enum	Jenis panggilan alat penerjemah kode. Selalu `code_interpreter_call`. Nilai yang mungkin: `code_interpreter_call`	Yes

OpenAI.OutputItemCompactionBody

Item pemadatan yang dihasilkan oleh v1/responses/compact API.

Nama	Tipe	Deskripsi	Diperlukan
agent_reference	AgentReference		Tidak.
└─ nama	string	Nama agen. Batasan: maxLength: 256	Yes
└─ jenis	enum	Nilai yang mungkin: `agent_reference`	Yes
└─ versi	string	Pengidentifikasi versi agen.	Tidak.
dibuat oleh	string	Pengidentifikasi aktor yang membuat item.	Tidak.
encrypted_content	string	Konten terenkripsi yang dihasilkan oleh pemadatan.	Yes
id	string	ID unik item pemadatan.	Yes
response_id	string	Respons tempat item dibuat.	Tidak.
jenis	enum	Jenis item. Selalu `compaction`. Nilai yang mungkin: `compaction`	Yes

OpenAI.OutputItemComputerToolCall

Panggilan alat ke alat penggunaan komputer. Lihat panduan penggunaan komputer komputer untuk informasi lebih lanjut.

Nama	Tipe	Deskripsi	Diperlukan
tindakan	OpenAI.ComputerAction		Yes
agent_reference	AgentReference		Tidak.
└─ nama	string	Nama agen. Batasan: maxLength: 256	Yes
└─ jenis	enum	Nilai yang mungkin: `agent_reference`	Yes
└─ versi	string	Pengidentifikasi versi agen.	Tidak.
call_id	string	Identifikasi yang digunakan ketika merespon panggilan alat dengan output.	Yes
id	string	ID unik panggilan komputer.	Yes
pending_safety_checks	array OpenAI.ComputerCallSafetyCheckParam	Pemeriksaan keamanan tertunda untuk panggilan komputer.	Yes
response_id	string	Respons tempat item dibuat.	Tidak.
status	enum	Status barang tersebut. Salah satu dari `in_progress`, `completed`, atau `incomplete`. Diisi saat item dikembalikan melalui API. Nilai yang mungkin: `in_progress`, `completed`, `incomplete`	Yes
jenis	enum	Jenis panggilan komputer. Selalu `computer_call`. Nilai yang mungkin: `computer_call`	Yes

OpenAI.OutputItemCustomToolCall

Panggilan ke alat kustom yang dibuat oleh model.

Nama	Tipe	Deskripsi	Diperlukan
agent_reference	AgentReference		Tidak.
└─ nama	string	Nama agen. Batasan: maxLength: 256	Yes
└─ jenis	enum	Nilai yang mungkin: `agent_reference`	Yes
└─ versi	string	Pengidentifikasi versi agen.	Tidak.
call_id	string	Pengidentifikasi yang digunakan untuk memetakan panggilan alat kustom ini ke output panggilan alat.	Yes
id	string	ID unik dari panggilan alat khusus di platform OpenAI.	Tidak.
Masukan	string	Input untuk panggilan alat kustom yang dihasilkan oleh model.	Yes
Nama	string	Nama perangkat kustom yang dipanggil.	Yes
response_id	string	Respons tempat item dibuat.	Tidak.
jenis	enum	Jenis panggilan alat kustom. Selalu `custom_tool_call`. Nilai yang mungkin: `custom_tool_call`	Yes

OpenAI.OutputItemFileSearchToolCall

Hasil panggilan alat pencarian file. Lihat panduan pencarian file file untuk informasi selengkapnya.

Nama	Tipe	Deskripsi	Diperlukan
agent_reference	AgentReference		Tidak.
└─ nama	string	Nama agen. Batasan: maxLength: 256	Yes
└─ jenis	enum	Nilai yang mungkin: `agent_reference`	Yes
└─ versi	string	Pengidentifikasi versi agen.	Tidak.
id	string	ID unik dari panggilan alat pencarian file.	Yes
queries	array string	Kueri yang digunakan untuk mencari file.	Yes
response_id	string	Respons tempat item dibuat.	Tidak.
results	array OpenAI.FileSearchToolCallResults		Tidak.
status	enum	Status panggilan alat pencarian file. Salah satu dari `in_progress`, `searching`, `incomplete` atau `failed`, Nilai yang mungkin: `in_progress`, , `searchingcompleted`, `incomplete`,`failed`	Yes
jenis	enum	Jenis panggilan alat pencarian file. Selalu `file_search_call`. Nilai yang mungkin: `file_search_call`	Yes

OpenAI.OutputItemFunctionShellCall

Panggilan alat yang menjalankan satu atau beberapa perintah shell di lingkungan terkelola.

Nama	Tipe	Deskripsi	Diperlukan
tindakan	OpenAI.FunctionShellAction	Jalankan perintah shell.	Yes
└─ perintah	array string		Yes
└─ max_output_length	OpenAI.integer (dapat diakses dengan null)		Yes
└─ timeout_ms	OpenAI.integer (dapat diakses dengan null)		Yes
agent_reference	AgentReference		Tidak.
└─ nama	string	Nama agen. Batasan: maxLength: 256	Yes
└─ jenis	enum	Nilai yang mungkin: `agent_reference`	Yes
└─ versi	string	Pengidentifikasi versi agen.	Tidak.
call_id	string	ID unik panggilan alat shell yang dihasilkan oleh model.	Yes
dibuat oleh	string	ID entitas yang membuat panggilan alat ini.	Tidak.
id	string	ID unik panggilan alat shell. Diisi saat item ini dikembalikan melalui API.	Yes
response_id	string	Respons tempat item dibuat.	Tidak.
status	OpenAI.LocalShellCallStatus		Yes
jenis	enum	Jenis item. Selalu `shell_call`. Nilai yang mungkin: `shell_call`	Yes

OpenAI.OutputItemFunctionShellCallOutput

Output panggilan alat shell yang dipancarkan.

Nama	Tipe	Deskripsi	Diperlukan
agent_reference	AgentReference		Tidak.
└─ nama	string	Nama agen. Batasan: maxLength: 256	Yes
└─ jenis	enum	Nilai yang mungkin: `agent_reference`	Yes
└─ versi	string	Pengidentifikasi versi agen.	Tidak.
call_id	string	ID unik panggilan alat shell yang dihasilkan oleh model.	Yes
dibuat oleh	string	Pengidentifikasi aktor yang membuat item.	Tidak.
id	string	ID unik dari output panggilan shell. Diisi saat item ini dikembalikan melalui API.	Yes
max_output_length	OpenAI.integer (dapat diakses dengan null)		Yes
output	array OpenAI.FunctionShellCallOutputContent	Array konten output panggilan shell	Yes
response_id	string	Respons tempat item dibuat.	Tidak.
jenis	enum	Jenis output panggilan shell. Selalu `shell_call_output`. Nilai yang mungkin: `shell_call_output`	Yes

OpenAI.OutputItemFunctionToolCall

Panggilan alat untuk menjalankan fungsi. Lihat panduan pemanggilan fungsi untuk informasi selengkapnya.

Nama	Tipe	Deskripsi	Diperlukan
agent_reference	AgentReference		Tidak.
└─ nama	string	Nama agen. Batasan: maxLength: 256	Yes
└─ jenis	enum	Nilai yang mungkin: `agent_reference`	Yes
└─ versi	string	Pengidentifikasi versi agen.	Tidak.
argumen	string	String JSON berisi argumen untuk dilewatkan ke fungsi.	Yes
call_id	string	ID unik dari panggilan alat fungsional yang dihasilkan oleh model.	Yes
id	string	ID unik dari panggilan alat fungsi.	Tidak.
Nama	string	Nama fungsi yang akan dijalankan.	Yes
response_id	string	Respons tempat item dibuat.	Tidak.
status	enum	Status barang tersebut. Salah satu dari `in_progress`, `completed`, atau `incomplete`. Diisi saat item dikembalikan melalui API. Nilai yang mungkin: `in_progress`, `completed`, `incomplete`	Tidak.
jenis	enum	Jenis pemanggilan alat fungsi. Selalu `function_call`. Nilai yang mungkin: `function_call`	Yes

OpenAI.OutputItemImageGenToolCall

Permintaan pembuatan gambar yang dibuat oleh model.

Nama	Tipe	Deskripsi	Diperlukan
agent_reference	AgentReference		Tidak.
└─ nama	string	Nama agen. Batasan: maxLength: 256	Yes
└─ jenis	enum	Nilai yang mungkin: `agent_reference`	Yes
└─ versi	string	Pengidentifikasi versi agen.	Tidak.
id	string	ID unik panggilan pembuatan gambar.	Yes
response_id	string	Respons tempat item dibuat.	Tidak.
hasil	string (dapat diakses NULL)		Yes
status	enum	Status panggilan pembuatan gambar. Nilai yang mungkin: `in_progress`, `completed`, `generating`, `failed`	Yes
jenis	enum	Jenis panggilan pembuatan gambar. Selalu `image_generation_call`. Nilai yang mungkin: `image_generation_call`	Yes

OpenAI.OutputItemLocalShellToolCall

Panggilan alat untuk menjalankan perintah pada shell lokal.

Nama	Tipe	Deskripsi	Diperlukan
tindakan	OpenAI.LocalShellExecAction	Jalankan perintah shell di server.	Yes
agent_reference	AgentReference		Tidak.
└─ nama	string	Nama agen. Batasan: maxLength: 256	Yes
└─ jenis	enum	Nilai yang mungkin: `agent_reference`	Yes
└─ versi	string	Pengidentifikasi versi agen.	Tidak.
call_id	string	ID unik dari panggilan alat shell lokal yang dihasilkan oleh model.	Yes
id	string	ID unik panggilan shell lokal.	Yes
response_id	string	Respons tempat item dibuat.	Tidak.
status	enum	Status panggilan shell lokal. Nilai yang mungkin: `in_progress`, `completed`, `incomplete`	Yes
jenis	enum	Jenis panggilan shell lokal. Selalu `local_shell_call`. Nilai yang mungkin: `local_shell_call`	Yes

OpenAI.OutputItemMcpApprovalRequest

Permintaan persetujuan dari manusia untuk penggunaan alat.

Nama	Tipe	Deskripsi	Diperlukan
agent_reference	AgentReference		Tidak.
└─ nama	string	Nama agen. Batasan: maxLength: 256	Yes
└─ jenis	enum	Nilai yang mungkin: `agent_reference`	Yes
└─ versi	string	Pengidentifikasi versi agen.	Tidak.
argumen	string	String argumen JSON untuk alat ini.	Yes
id	string	ID unik permintaan persetujuan.	Yes
Nama	string	Nama alat yang akan dijalankan.	Yes
response_id	string	Respons tempat item dibuat.	Tidak.
server_label	string	Label server MCP yang membuat permintaan.	Yes
jenis	enum	Jenis item. Selalu `mcp_approval_request`. Nilai yang mungkin: `mcp_approval_request`	Yes

OpenAI.OutputItemMcpListTools

Daftar alat yang tersedia di server MCP.

Nama	Tipe	Deskripsi	Diperlukan
agent_reference	AgentReference		Tidak.
└─ nama	string	Nama agen. Batasan: maxLength: 256	Yes
└─ jenis	enum	Nilai yang mungkin: `agent_reference`	Yes
└─ versi	string	Pengidentifikasi versi agen.	Tidak.
galat	string (dapat diakses NULL)		Tidak.
id	string	ID unik daftar.	Yes
response_id	string	Respons tempat item dibuat.	Tidak.
server_label	string	Label MCP server.	Yes
perangkat	array OpenAI.MCPListToolsToolsTool	Alat yang tersedia di server.	Yes
jenis	enum	Jenis item. Selalu `mcp_list_tools`. Nilai yang mungkin: `mcp_list_tools`	Yes

OpenAI.OutputItemMcpToolCall

Pemanggilan alat di server MCP.

Nama	Tipe	Deskripsi	Diperlukan
agent_reference	AgentReference		Tidak.
└─ nama	string	Nama agen. Batasan: maxLength: 256	Yes
└─ jenis	enum	Nilai yang mungkin: `agent_reference`	Yes
└─ versi	string	Pengidentifikasi versi agen.	Tidak.
approval_request_id	string (dapat diakses NULL)		Tidak.
argumen	string	String JSON dari argumen yang dikirimkan ke alat.	Yes
galat	string (dapat diakses NULL)		Tidak.
id	string	ID unik panggilan alat.	Yes
Nama	string	Nama alat yang dijalankan.	Yes
output	string (dapat diakses NULL)		Tidak.
response_id	string	Respons tempat item dibuat.	Tidak.
server_label	string	Label server MCP yang menjalankan alat.	Yes
status	OpenAI.MCPToolCallStatus		Tidak.
jenis	enum	Jenis item. Selalu `mcp_call`. Nilai yang mungkin: `mcp_call`	Yes

OpenAI.OutputItemOutputMessage

Pesan hasil dari model.

Nama	Tipe	Deskripsi	Diperlukan
agent_reference	AgentReference		Tidak.
└─ nama	string	Nama agen. Batasan: maxLength: 256	Yes
└─ jenis	enum	Nilai yang mungkin: `agent_reference`	Yes
└─ versi	string	Pengidentifikasi versi agen.	Tidak.
isi	array OpenAI.OutputMessageContent	Isi pesan keluaran.	Yes
id	string	ID unik pesan output.	Yes
response_id	string	Respons tempat item dibuat.	Tidak.
peran	enum	Peran pesan keluaran. Selalu `assistant`. Nilai yang mungkin: `assistant`	Yes
status	enum	Status dari input pesan. Salah satu dari `in_progress`, `completed`, atau `incomplete`. Diisi saat item input dikembalikan melalui API. Nilai yang mungkin: `in_progress`, `completed`, `incomplete`	Yes
jenis	enum	Jenis pesan output. Selalu `message`. Nilai yang mungkin: `output_message`	Yes

OpenAI.OutputItemReasoningItem

Nama	Tipe	Deskripsi	Diperlukan
agent_reference	AgentReference		Tidak.
└─ nama	string	Nama agen. Batasan: maxLength: 256	Yes
└─ jenis	enum	Nilai yang mungkin: `agent_reference`	Yes
└─ versi	string	Pengidentifikasi versi agen.	Tidak.
isi	array OpenAI.ReasoningTextContent	Konten teks penalaran.	Tidak.
encrypted_content	string (dapat diakses NULL)		Tidak.
id	string	Pengidentifikasi unik dari konten alasan.	Yes
response_id	string	Respons tempat item dibuat.	Tidak.
status	enum	Status barang tersebut. Salah satu dari `in_progress`, `completed`, atau `incomplete`. Diisi saat item dikembalikan melalui API. Nilai yang mungkin: `in_progress`, `completed`, `incomplete`	Tidak.
summary	array OpenAI.Summary	Konten ringkasan penalaran.	Yes
jenis	enum	Jenis objek. Selalu `reasoning`. Nilai yang mungkin: `reasoning`	Yes

OpenAI.OutputItemType

Harta benda Nilai

Jenis string

Nilai output_message
file_search_call
function_call
web_search_call
computer_call
reasoning
compaction
image_generation_call
code_interpreter_call
local_shell_call
shell_call
shell_call_output
apply_patch_call
apply_patch_call_output
mcp_call
mcp_list_tools
mcp_approval_request
custom_tool_call
structured_outputs
oauth_consent_request
memory_search_call
workflow_action

OpenAI.OutputItemWebSearchToolCall

Hasil panggilan alat pencarian web. Lihat panduan pencarian web untuk informasi selengkapnya.

Nama	Tipe	Deskripsi	Diperlukan
tindakan	OpenAI.WebSearchActionSearch atau OpenAI.WebSearchActionOpenPage atau OpenAI.WebSearchActionFind	Objek yang menjelaskan tindakan spesifik yang diambil dalam panggilan pencarian web ini. Mencakup detail tentang bagaimana model menggunakan web (pencarian, open_page, temukan).	Yes
agent_reference	AgentReference		Tidak.
└─ nama	string	Nama agen. Batasan: maxLength: 256	Yes
└─ jenis	enum	Nilai yang mungkin: `agent_reference`	Yes
└─ versi	string	Pengidentifikasi versi agen.	Tidak.
id	string	ID unik dari panggilan alat pencarian web.	Yes
response_id	string	Respons tempat item dibuat.	Tidak.
status	enum	Status panggilan alat pencarian web. Nilai yang mungkin: `in_progress`, `searching`, `completed`, `failed`	Yes
jenis	enum	Jenis panggilan alat pencarian web. Selalu `web_search_call`. Nilai yang mungkin: `web_search_call`	Yes

OpenAI.OutputMessageContent

Diskriminator untuk OpenAI.OutputMessageContent

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
`output_text`	OpenAI.OutputMessageContentOutputTextContent
`refusal`	OpenAI.OutputMessageContentRefusalContent

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	OpenAI.OutputMessageContentType		Yes

OpenAI.OutputMessageContentOutputTextContent

Teks output dari model.

Nama	Tipe	Deskripsi	Diperlukan
Anotasi	array OpenAI.Anotasi	Anotasi keluaran teks.	Yes
logprobs	array OpenAI.LogProb		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.OutputMessageContentRefusalContent

Penolakan dari model.

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

OpenAI.OutputMessageContentType

Harta benda	Nilai
Jenis	string
Nilai	`output_text` `refusal`

OpenAI.Prompt

Referensi ke templat perintah dan variabelnya. Pelajari lebih lanjut.

Nama	Tipe	Deskripsi	Diperlukan
id	string	Pengidentifikasi unik templat perintah yang akan digunakan.	Yes
variabel	OpenAI.ResponsePromptVariables (dapat diubah ke null)	Peta nilai opsional untuk mengganti variabel di cepat. Nilai substitusi dapat berupa string, atau lainnya Jenis input respons seperti gambar atau file.	Tidak.
versi	string (dapat diakses NULL)		Tidak.

OpenAI.RankerVersionType

Harta benda	Nilai
Jenis	string
Nilai	`auto` `default-2024-11-15`

OpenAI.RankingOptions

Nama	Tipe	Deskripsi	Diperlukan
hybrid_search	OpenAI.HybridSearchOptions		Tidak.
└─ embedding_weight	OpenAI.numeric	Berat penyematan dalam fusi peringkat timbal balik.	Yes
└─ text_weight	OpenAI.numeric	Bobot teks dalam fusi peringkat timbal balik.	Yes
pemeringkat	OpenAI.RankerVersionType		Tidak.
ambang_batas_skor	OpenAI.numeric		Tidak.

OpenAI.Reasoning

Hanya model GPT-5 dan seri O Opsi konfigurasi untuk model penalaran.

Nama	Tipe	Deskripsi	Diperlukan
effort	OpenAI.ReasoningEffort	Membatasi upaya penalaran untuk model penalaran. Nilai yang saat ini didukung adalah `none`, `minimal`, `low`, `medium`, `high`, dan `xhigh`. Mengurangi upaya penalaran dapat menghasilkan respons yang lebih cepat dan lebih sedikit token yang digunakan penalaran dalam sebuah respons. - `gpt-5.1` default ke `none`, yang tidak melakukan penalaran. Nilai penalaran yang didukung untuk `gpt-5.1` adalah `none`, `low`, `medium`, dan `high`. Panggilan alat didukung untuk semua nilai penalaran dalam gpt-5.1. - Semua model sebelum `gpt-5.1` default ke `medium` upaya penalaran, dan tidak mendukung `none`. - Model `gpt-5-pro` default ke (dan hanya mendukung) `high` upaya penalaran. - `xhigh` didukung untuk semua model setelah `gpt-5.1-codex-max`.	Tidak.
generate_summary	enum	Nilai yang mungkin: `auto`, `concise`, `detailed`	Tidak.
summary	enum	Nilai yang mungkin: `auto`, `concise`, `detailed`	Tidak.

OpenAI.ReasoningEffort

Membatasi upaya penalaran untuk model penalaran. Nilai yang saat ini didukung adalah none, minimal, low, medium, high, dan xhigh. Mengurangi upaya penalaran dapat mengakibatkan respons yang lebih cepat dan lebih sedikit token yang digunakan pada penalaran dalam respons.

gpt-5.1 default ke none, yang tidak melakukan penalaran. Nilai penalaran yang didukung untuk gpt-5.1 adalah none, low, medium, dan high. Panggilan alat didukung untuk semua nilai penalaran dalam gpt-5.1.
Semua model sebelum gpt-5.1 default untuk medium upaya penalaran, dan tidak mendukung none.
Model default gpt-5-pro untuk (dan hanya mendukung) high upaya penalaran.
xhigh didukung untuk semua model setelah gpt-5.1-codex-max.

Harta benda	Nilai
Jenis	string
Dapat diubah ke null	Yes
Nilai	`none` `minimal` `low` `medium` `high` `xhigh`

OpenAI.ReasoningTextContent

Teks penalaran dari model.

Nama	Tipe	Deskripsi	Diperlukan	Default
kirim pesan teks	string	Teks penalaran dari model.	Yes
jenis	enum	Jenis teks penalaran. Selalu `reasoning_text`. Nilai yang mungkin: `reasoning_text`	Yes

OpenAI.Response

Nama	Tipe	Deskripsi	Diperlukan	Default
agent_reference	AgentReference (dapat diubah untuk null)		Yes
└─ nama	string	Nama agen. Batasan: maxLength: 256	Yes
└─ jenis	enum	Nilai yang mungkin: `agent_reference`	Yes
└─ versi	string	Pengidentifikasi versi agen.	Tidak.
latar belakang	Boolean (dapat diberisi dengan null)		Tidak.
selesai_pada	bilangan bulat		Tidak.
percakapan	OpenAI.ConversationReference (dapat diterima dengan null)	Percakapan tempat respons ini berada. Item input dan item output dari respons ini secara otomatis ditambahkan ke percakapan ini.	Tidak.
└─ ID	string	ID unik percakapan yang dikaitkan dengan respons ini.	Yes
dibuat_pada	bilangan bulat	Tanda waktu Unix (dalam detik) saat Respons ini dibuat.	Yes
galat	OpenAI.ResponseError (dapat diberisi null)	Objek kesalahan dikembalikan saat model gagal menghasilkan Respons.	Yes
└─ kode	OpenAI.ResponseErrorCode	Kode kesalahan untuk respons.	Yes
└─ pesan	string	Deskripsi kesalahan yang dapat dibaca manusia.	Yes
id	string	Pengidentifikasi unik untuk Respons ini.	Yes
incomplete_details	OpenAI.ResponseIncompleteDetails (dapat diberisi null)		Yes
└─ alasan	enum	Nilai yang mungkin: `max_output_tokens`, `content_filter`	Tidak.
instructions	string atau array OpenAI.InputItem		Yes
max_output_tokens	OpenAI.integer (dapat diakses dengan null)		Tidak.
max_tool_calls	OpenAI.integer (dapat diakses dengan null)		Tidak.
metadata	OpenAI.Metadata (dapat diberisi dengan null)	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini bisa berguna untuk menyimpan informasi tambahan tentang objek dalam terstruktur pemformatan dan pengambilan kueri untuk 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.	Tidak.
objek	enum	Jenis objek sumber daya ini - selalu diatur ke `response`. Nilai yang mungkin: `response`	Yes
output	array OpenAI.OutputItem	Sebuah array item konten yang dihasilkan oleh model. - Panjang dan urutan item dalam `output` array tergantung pada respons model. - Daripada mengakses item pertama dalam `output` array dan Dengan asumsi ini adalah pesan `assistant` dengan konten yang dihasilkan oleh model, Anda mungkin mempertimbangkan untuk menggunakan properti `output_text` di mana didukung dalam SDK.	Yes
output_text	string (dapat diakses NULL)		Tidak.
pemanggilan_alat_paralel	Boolean	Apakah akan mengizinkan model menjalankan panggilan alat secara paralel.	Yes	Benar
previous_response_id	string (dapat diakses NULL)		Tidak.
minta	OpenAI.Prompt	Referensi ke templat perintah dan variabelnya. Pelajari lebih lanjut.	Tidak.
prompt_cache_key	string	Digunakan oleh OpenAI untuk menyimpan respons untuk permintaan serupa guna mengoptimalkan tingkat hit cache Anda. Mengganti bidang `user`. Pelajari lebih lanjut.	Tidak.
prompt_cache_retention	enum	Nilai yang mungkin: `in-memory`, `24h`	Tidak.
reasoning	OpenAI.Reasoning (nullable)	model gpt-5 dan o-series saja Opsi konfigurasi untuk model penalaran.	Tidak.
└─ usaha	OpenAI.ReasoningEffort	Membatasi upaya penalaran untuk model penalaran. Nilai yang saat ini didukung adalah `none`, `minimal`, `low`, `medium`, `high`, dan `xhigh`. Mengurangi upaya penalaran dapat menghasilkan respons yang lebih cepat dan lebih sedikit token yang digunakan penalaran dalam sebuah respons. - `gpt-5.1` default ke `none`, yang tidak melakukan penalaran. Nilai penalaran yang didukung untuk `gpt-5.1` adalah `none`, `low`, `medium`, dan `high`. Panggilan alat didukung untuk semua nilai penalaran dalam gpt-5.1. - Semua model sebelum `gpt-5.1` default ke `medium` upaya penalaran, dan tidak mendukung `none`. - Model `gpt-5-pro` default ke (dan hanya mendukung) `high` upaya penalaran. - `xhigh` didukung untuk semua model setelah `gpt-5.1-codex-max`.	Tidak.
└─ menghasilkan_ringkasan	enum	Nilai yang mungkin: `auto`, `concise`, `detailed`	Tidak.
└─ ringkasan	enum	Nilai yang mungkin: `auto`, `concise`, `detailed`	Tidak.
safety_identifier	string	Pengidentifikasi stabil yang digunakan untuk membantu mendeteksi pengguna aplikasi Anda yang mungkin melanggar kebijakan penggunaan OpenAI. ID harus berupa string yang secara unik mengidentifikasi setiap pengguna. Sebaiknya hash nama pengguna atau alamat email mereka, untuk menghindari pengiriman informasi identifikasi apa pun kepada kami. Pelajari lebih lanjut.	Tidak.
tingkat_layanan	OpenAI.ServiceTier	Menentukan jenis pemrosesan yang digunakan untuk melayani permintaan. - Jika diatur ke 'otomatis', permintaan akan diproses dengan tingkat layanan yang dikonfigurasi di pengaturan Project. Kecuali dikonfigurasi lain, Project akan menggunakan 'default'. - Jika diatur ke 'default', maka permintaan akan diproses dengan harga dan performa standar untuk model yang dipilih. - Jika diatur ke 'flex' atau 'priority', maka permintaan akan diproses dengan tingkat layanan yang sesuai. - Ketika tidak diatur, perilaku defaultnya adalah 'otomatis'. `service_tier` Ketika parameter diatur, isi respons akan menyertakan `service_tier` nilai berdasarkan mode pemrosesan yang benar-benar digunakan untuk melayani permintaan. Nilai respons ini mungkin berbeda dari nilai yang ditetapkan dalam parameter .	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	OpenAI.numeric (nullable)		Tidak.	1
kirim pesan teks	OpenAI.ResponseTextParam	Opsi konfigurasi untuk respons teks dari model. Bisa biasa teks atau data JSON terstruktur. Pelajari lebih lanjut: - Input dan output teks - Output Terstruktur	Tidak.
tool_choice	OpenAI.ToolChoiceOptions atau OpenAI.ToolChoiceParam		Tidak.
perangkat	OpenAI.ToolsArray	Sekumpulan alat yang dapat dipanggil model ketika menghasilkan respons. Anda dapat menentukan alat mana yang akan digunakan dengan mengatur `tool_choice` parameter . Kami mendukung kategori alat berikut: - Alat bawaan: Alat yang disediakan oleh OpenAI yang memperluas Kemampuan model, seperti Web Search atau pencarian file. Pelajari selengkapnya tentang alat bawaan. - Alat MCP: Integrasi dengan sistem pihak ketiga melalui server MCP kustom atau konektor yang telah ditentukan sebelumnya seperti Google Drive dan SharePoint. Pelajari selengkapnya tentang Alat MCP. - Panggilan fungsi (alat kustom): Fungsi yang ditentukan oleh Anda, memungkinkan model untuk memanggil kode Anda sendiri dengan argumen yang sangat ditik dan output. Pelajari selengkapnya tentang panggilan fungsi. Anda juga dapat menggunakan alat kustom untuk memanggil kode Anda sendiri.	Tidak.
top_logprobs	OpenAI.integer (dapat diakses dengan null)		Tidak.
top_p	OpenAI.numeric (nullable)		Tidak.	1
truncation	enum	Nilai yang mungkin: `auto`, `disabled`	Tidak.
usage	OpenAI.ResponseUsage	Merinci detail penggunaan token termasuk token input, token output, perincian token output, dan total token yang digunakan.	Tidak.
pengguna	string (tidak digunakan lagi)	Bidang ini sedang digantikan oleh `safety_identifier` dan `prompt_cache_key`. Gunakan `prompt_cache_key` sebagai gantinya untuk mempertahankan pengoptimalan penembolokan. Pengidentifikasi yang stabil untuk pengguna akhir Anda. Digunakan untuk meningkatkan tingkat hit cache dengan membuat wadah permintaan serupa dengan lebih baik dan untuk membantu OpenAI mendeteksi dan mencegah penyalahgunaan. Pelajari lebih lanjut.	Tidak.

OpenAI.ResponseAudioDeltaEvent

Dipancarkan ketika ada respons audio parsial.

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

OpenAI.ResponseAudioDoneEvent

Dipancarkan saat respons audio selesai.

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

OpenAI.ResponseAudioTranscriptDeltaEvent

Dipancarkan ketika ada transkrip audio parsial.

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

OpenAI.ResponseAudioTranscriptDoneEvent

Dipancarkan ketika transkrip audio lengkap selesai.

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

OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent

Dipancarkan ketika cuplikan kode parsial dialirkan oleh penerjemah kode.

Nama	Tipe	Deskripsi	Diperlukan
delta	string	Cuplikan kode parsial yang dialirkan oleh penerjemah kode.	Yes
item_id	string	Pengidentifikasi unik item panggilan alat penerjemah kode.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		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
kode	string	Output cuplikan kode akhir oleh penerjemah kode.	Yes
item_id	string	Pengidentifikasi unik item panggilan alat penerjemah kode.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		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
item_id	string	Pengidentifikasi unik item panggilan alat penerjemah kode.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		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
item_id	string	Pengidentifikasi unik item panggilan alat penerjemah kode.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		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
item_id	string	Pengidentifikasi unik item panggilan alat penerjemah kode.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		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	OpenAI.Response		Yes
└─ agent_reference	AgentReference (dapat diubah untuk null)	Agen yang digunakan untuk respons ini	Yes
└─ latar belakang	Boolean (dapat diberisi dengan null)		Tidak.
└─ completed_at	bilangan bulat (nullable)		Tidak.
└─ percakapan	OpenAI.ConversationReference (dapat diterima dengan null)	Percakapan tempat respons ini berada. Item input dan item output dari respons ini secara otomatis ditambahkan ke percakapan ini.	Tidak.
└─ dibuat_pada	bilangan bulat	Tanda waktu Unix (dalam detik) saat Respons ini dibuat.	Yes
└─ kesalahan	OpenAI.ResponseError (dapat diberisi null)	Objek kesalahan dikembalikan saat model gagal menghasilkan Respons.	Yes
└─ ID	string	Pengidentifikasi unik untuk Respons ini.	Yes
└─ detail_tidak_lengkap	OpenAI.ResponseIncompleteDetails (dapat diberisi null)		Yes
└─ instruksi	string atau array OpenAI.InputItem (nullable)		Yes
└─ max_output_tokens	OpenAI.integer (dapat diakses dengan null)		Tidak.
└─ max_tool_calls	OpenAI.integer (dapat diakses dengan null)		Tidak.
└─ metadata	OpenAI.Metadata (dapat diberisi dengan null)	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini bisa berguna untuk menyimpan informasi tambahan tentang objek dalam terstruktur pemformatan dan pengambilan kueri untuk 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.	Tidak.
└─ objek	enum	Jenis objek sumber daya ini - selalu diatur ke `response`. Nilai yang mungkin: `response`	Yes
└─ keluaran	array OpenAI.OutputItem	Sebuah array item konten yang dihasilkan oleh model. - Panjang dan urutan item dalam `output` array tergantung pada respons model. - Daripada mengakses item pertama dalam `output` array dan Dengan asumsi ini adalah pesan `assistant` dengan konten yang dihasilkan oleh model, Anda mungkin mempertimbangkan untuk menggunakan properti `output_text` di mana didukung dalam SDK.	Yes
└─ teks hasil	string (dapat diakses NULL)		Tidak.
└─ pemanggilan_alat_parallel	Boolean	Apakah akan mengizinkan model menjalankan panggilan alat secara paralel.	Yes	Benar
└─ ID_respons_sebelumnya	string (dapat diakses NULL)		Tidak.
└─ perintah	OpenAI.Prompt	Referensi ke templat perintah dan variabelnya. Pelajari lebih lanjut.	Tidak.
└─ prompt_cache_key	string	Digunakan oleh OpenAI untuk menyimpan respons untuk permintaan serupa guna mengoptimalkan tingkat hit cache Anda. Mengganti bidang `user`. Pelajari lebih lanjut.	Tidak.
└─ prompt_cache_retention	enum	Nilai yang mungkin: `in-memory`, `24h`	Tidak.
└─ penalaran	OpenAI.Reasoning (nullable)	model gpt-5 dan o-series saja Opsi konfigurasi untuk model penalaran.	Tidak.
└─ safety_identifier	string	Pengidentifikasi stabil yang digunakan untuk membantu mendeteksi pengguna aplikasi Anda yang mungkin melanggar kebijakan penggunaan OpenAI. ID harus berupa string yang secara unik mengidentifikasi setiap pengguna. Sebaiknya hash nama pengguna atau alamat email mereka, untuk menghindari pengiriman informasi identifikasi apa pun kepada kami. Pelajari lebih lanjut.	Tidak.
└─ service_tier	OpenAI.ServiceTier	Menentukan jenis pemrosesan yang digunakan untuk melayani permintaan. - Jika diatur ke 'otomatis', permintaan akan diproses dengan tingkat layanan yang dikonfigurasi di pengaturan Project. Kecuali dikonfigurasi lain, Project akan menggunakan 'default'. - Jika diatur ke 'default', maka permintaan akan diproses dengan harga dan performa standar untuk model yang dipilih. - Jika diatur ke 'flex' atau 'priority', maka permintaan akan diproses dengan tingkat layanan yang sesuai. - Ketika tidak diatur, perilaku defaultnya adalah 'otomatis'. `service_tier` Ketika parameter diatur, isi respons akan menyertakan `service_tier` nilai berdasarkan mode pemrosesan yang benar-benar digunakan untuk melayani permintaan. Nilai respons ini mungkin berbeda dari nilai yang ditetapkan dalam parameter .	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	OpenAI.numeric (nullable)		Tidak.	1
└─ teks	OpenAI.ResponseTextParam	Opsi konfigurasi untuk respons teks dari model. Bisa biasa teks atau data JSON terstruktur. Pelajari lebih lanjut: - Input dan output teks - Output Terstruktur	Tidak.
└─ pilihan_alat	OpenAI.ToolChoiceOptions atau OpenAI.ToolChoiceParam		Tidak.
└─ peralatan	OpenAI.ToolsArray	Sekumpulan alat yang dapat dipanggil model ketika menghasilkan respons. Anda dapat menentukan alat mana yang akan digunakan dengan mengatur `tool_choice` parameter . Kami mendukung kategori alat berikut: - Alat bawaan: Alat yang disediakan oleh OpenAI yang memperluas Kemampuan model, seperti Web Search atau pencarian file. Pelajari selengkapnya tentang alat bawaan. - Alat MCP: Integrasi dengan sistem pihak ketiga melalui server MCP kustom atau konektor yang telah ditentukan sebelumnya seperti Google Drive dan SharePoint. Pelajari selengkapnya tentang Alat MCP. - Panggilan fungsi (alat kustom): Fungsi yang ditentukan oleh Anda, memungkinkan model untuk memanggil kode Anda sendiri dengan argumen yang sangat ditik dan output. Pelajari selengkapnya tentang panggilan fungsi. Anda juga dapat menggunakan alat kustom untuk memanggil kode Anda sendiri.	Tidak.
└─ top_logprobs	OpenAI.integer (dapat diakses dengan null)		Tidak.
└─ top_p	OpenAI.numeric (nullable)		Tidak.	1
└─ pemotongan	enum	Nilai yang mungkin: `auto`, `disabled`	Tidak.
└─ penggunaan	OpenAI.ResponseUsage	Merinci detail penggunaan token termasuk token input, token output, perincian token output, dan total token yang digunakan.	Tidak.
└─ pengguna	string (tidak digunakan lagi)	Bidang ini sedang digantikan oleh `safety_identifier` dan `prompt_cache_key`. Gunakan `prompt_cache_key` sebagai gantinya untuk mempertahankan pengoptimalan penembolokan. Pengidentifikasi yang stabil untuk pengguna akhir Anda. Digunakan untuk meningkatkan tingkat hit cache dengan membuat wadah permintaan serupa dengan lebih baik dan untuk membantu OpenAI mendeteksi dan mencegah penyalahgunaan. Pelajari lebih lanjut.	Tidak.
sequence_number	OpenAI.integer		Yes
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
content_index	OpenAI.integer		Yes
item_id	string	ID item output tempat bagian konten ditambahkan.	Yes
output_index	OpenAI.integer		Yes
bagian	OpenAI.OutputContent		Yes
└─ jenis	OpenAI.OutputContentType		Yes
sequence_number	OpenAI.integer		Yes
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
content_index	OpenAI.integer		Yes
item_id	string	ID item output tempat bagian konten ditambahkan.	Yes
output_index	OpenAI.integer		Yes
bagian	OpenAI.OutputContent		Yes
└─ jenis	OpenAI.OutputContentType		Yes
sequence_number	OpenAI.integer		Yes
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	OpenAI.Response		Yes
└─ agent_reference	AgentReference (dapat diubah untuk null)	Agen yang digunakan untuk respons ini	Yes
└─ latar belakang	Boolean (dapat diberisi dengan null)		Tidak.
└─ completed_at	bilangan bulat (nullable)		Tidak.
└─ percakapan	OpenAI.ConversationReference (dapat diterima dengan null)	Percakapan tempat respons ini berada. Item input dan item output dari respons ini secara otomatis ditambahkan ke percakapan ini.	Tidak.
└─ dibuat_pada	bilangan bulat	Tanda waktu Unix (dalam detik) saat Respons ini dibuat.	Yes
└─ kesalahan	OpenAI.ResponseError (dapat diberisi null)	Objek kesalahan dikembalikan saat model gagal menghasilkan Respons.	Yes
└─ ID	string	Pengidentifikasi unik untuk Respons ini.	Yes
└─ detail_tidak_lengkap	OpenAI.ResponseIncompleteDetails (dapat diberisi null)		Yes
└─ instruksi	string atau array OpenAI.InputItem (nullable)		Yes
└─ max_output_tokens	OpenAI.integer (dapat diakses dengan null)		Tidak.
└─ max_tool_calls	OpenAI.integer (dapat diakses dengan null)		Tidak.
└─ metadata	OpenAI.Metadata (dapat diberisi dengan null)	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini bisa berguna untuk menyimpan informasi tambahan tentang objek dalam terstruktur pemformatan dan pengambilan kueri untuk 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.	Tidak.
└─ objek	enum	Jenis objek sumber daya ini - selalu diatur ke `response`. Nilai yang mungkin: `response`	Yes
└─ keluaran	array OpenAI.OutputItem	Sebuah array item konten yang dihasilkan oleh model. - Panjang dan urutan item dalam `output` array tergantung pada respons model. - Daripada mengakses item pertama dalam `output` array dan Dengan asumsi ini adalah pesan `assistant` dengan konten yang dihasilkan oleh model, Anda mungkin mempertimbangkan untuk menggunakan properti `output_text` di mana didukung dalam SDK.	Yes
└─ teks hasil	string (dapat diakses NULL)		Tidak.
└─ pemanggilan_alat_parallel	Boolean	Apakah akan mengizinkan model menjalankan panggilan alat secara paralel.	Yes	Benar
└─ ID_respons_sebelumnya	string (dapat diakses NULL)		Tidak.
└─ perintah	OpenAI.Prompt	Referensi ke templat perintah dan variabelnya. Pelajari lebih lanjut.	Tidak.
└─ prompt_cache_key	string	Digunakan oleh OpenAI untuk menyimpan respons untuk permintaan serupa guna mengoptimalkan tingkat hit cache Anda. Mengganti bidang `user`. Pelajari lebih lanjut.	Tidak.
└─ prompt_cache_retention	enum	Nilai yang mungkin: `in-memory`, `24h`	Tidak.
└─ penalaran	OpenAI.Reasoning (nullable)	model gpt-5 dan o-series saja Opsi konfigurasi untuk model penalaran.	Tidak.
└─ safety_identifier	string	Pengidentifikasi stabil yang digunakan untuk membantu mendeteksi pengguna aplikasi Anda yang mungkin melanggar kebijakan penggunaan OpenAI. ID harus berupa string yang secara unik mengidentifikasi setiap pengguna. Sebaiknya hash nama pengguna atau alamat email mereka, untuk menghindari pengiriman informasi identifikasi apa pun kepada kami. Pelajari lebih lanjut.	Tidak.
└─ service_tier	OpenAI.ServiceTier	Menentukan jenis pemrosesan yang digunakan untuk melayani permintaan. - Jika diatur ke 'otomatis', permintaan akan diproses dengan tingkat layanan yang dikonfigurasi di pengaturan Project. Kecuali dikonfigurasi lain, Project akan menggunakan 'default'. - Jika diatur ke 'default', maka permintaan akan diproses dengan harga dan performa standar untuk model yang dipilih. - Jika diatur ke 'flex' atau 'priority', maka permintaan akan diproses dengan tingkat layanan yang sesuai. - Ketika tidak diatur, perilaku defaultnya adalah 'otomatis'. `service_tier` Ketika parameter diatur, isi respons akan menyertakan `service_tier` nilai berdasarkan mode pemrosesan yang benar-benar digunakan untuk melayani permintaan. Nilai respons ini mungkin berbeda dari nilai yang ditetapkan dalam parameter .	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	OpenAI.numeric (nullable)		Tidak.	1
└─ teks	OpenAI.ResponseTextParam	Opsi konfigurasi untuk respons teks dari model. Bisa biasa teks atau data JSON terstruktur. Pelajari lebih lanjut: - Input dan output teks - Output Terstruktur	Tidak.
└─ pilihan_alat	OpenAI.ToolChoiceOptions atau OpenAI.ToolChoiceParam		Tidak.
└─ peralatan	OpenAI.ToolsArray	Sekumpulan alat yang dapat dipanggil model ketika menghasilkan respons. Anda dapat menentukan alat mana yang akan digunakan dengan mengatur `tool_choice` parameter . Kami mendukung kategori alat berikut: - Alat bawaan: Alat yang disediakan oleh OpenAI yang memperluas Kemampuan model, seperti Web Search atau pencarian file. Pelajari selengkapnya tentang alat bawaan. - Alat MCP: Integrasi dengan sistem pihak ketiga melalui server MCP kustom atau konektor yang telah ditentukan sebelumnya seperti Google Drive dan SharePoint. Pelajari selengkapnya tentang Alat MCP. - Panggilan fungsi (alat kustom): Fungsi yang ditentukan oleh Anda, memungkinkan model untuk memanggil kode Anda sendiri dengan argumen yang sangat ditik dan output. Pelajari selengkapnya tentang panggilan fungsi. Anda juga dapat menggunakan alat kustom untuk memanggil kode Anda sendiri.	Tidak.
└─ top_logprobs	OpenAI.integer (dapat diakses dengan null)		Tidak.
└─ top_p	OpenAI.numeric (nullable)		Tidak.	1
└─ pemotongan	enum	Nilai yang mungkin: `auto`, `disabled`	Tidak.
└─ penggunaan	OpenAI.ResponseUsage	Merinci detail penggunaan token termasuk token input, token output, perincian token output, dan total token yang digunakan.	Tidak.
└─ pengguna	string (tidak digunakan lagi)	Bidang ini sedang digantikan oleh `safety_identifier` dan `prompt_cache_key`. Gunakan `prompt_cache_key` sebagai gantinya untuk mempertahankan pengoptimalan penembolokan. Pengidentifikasi yang stabil untuk pengguna akhir Anda. Digunakan untuk meningkatkan tingkat hit cache dengan membuat wadah permintaan serupa dengan lebih baik dan untuk membantu OpenAI mendeteksi dan mencegah penyalahgunaan. Pelajari lebih lanjut.	Tidak.
sequence_number	OpenAI.integer		Yes
jenis	enum	Jenis peristiwa. Selalu `response.created`. Nilai yang mungkin: `response.created`	Yes

OpenAI.ResponseCustomToolCallInputDeltaEvent

Peristiwa yang mewakili delta (pembaruan parsial) ke input panggilan alat kustom.

Nama	Tipe	Deskripsi	Diperlukan
delta	string	Data input inkremental (delta) untuk panggilan alat kustom.	Yes
item_id	string	Pengidentifikasi unik untuk item API yang terkait dengan peristiwa ini.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
jenis	enum	Pengidentifikasi jenis peristiwa. Nilai yang mungkin: `response.custom_tool_call_input.delta`	Yes

OpenAI.ResponseCustomToolCallInputDoneEvent

Peristiwa yang menunjukkan bahwa input untuk panggilan alat kustom selesai.

Nama	Tipe	Deskripsi	Diperlukan
Masukan	string	Data input lengkap untuk panggilan alat kustom.	Yes
item_id	string	Pengidentifikasi unik untuk item API yang terkait dengan peristiwa ini.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
jenis	enum	Pengidentifikasi jenis peristiwa. Nilai yang mungkin: `response.custom_tool_call_input.done`	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
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
kode	string (dapat diakses NULL)		Yes
pesan	string	Pesan kesalahan.	Yes
param	string (dapat diakses NULL)		Yes
sequence_number	OpenAI.integer		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	OpenAI.Response		Yes
└─ agent_reference	AgentReference (dapat diubah untuk null)	Agen yang digunakan untuk respons ini	Yes
└─ latar belakang	Boolean (dapat diberisi dengan null)		Tidak.
└─ completed_at	bilangan bulat (nullable)		Tidak.
└─ percakapan	OpenAI.ConversationReference (dapat diterima dengan null)	Percakapan tempat respons ini berada. Item input dan item output dari respons ini secara otomatis ditambahkan ke percakapan ini.	Tidak.
└─ dibuat_pada	bilangan bulat	Tanda waktu Unix (dalam detik) saat Respons ini dibuat.	Yes
└─ kesalahan	OpenAI.ResponseError (dapat diberisi null)	Objek kesalahan dikembalikan saat model gagal menghasilkan Respons.	Yes
└─ ID	string	Pengidentifikasi unik untuk Respons ini.	Yes
└─ detail_tidak_lengkap	OpenAI.ResponseIncompleteDetails (dapat diberisi null)		Yes
└─ instruksi	string atau array OpenAI.InputItem (nullable)		Yes
└─ max_output_tokens	OpenAI.integer (dapat diakses dengan null)		Tidak.
└─ max_tool_calls	OpenAI.integer (dapat diakses dengan null)		Tidak.
└─ metadata	OpenAI.Metadata (dapat diberisi dengan null)	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini bisa berguna untuk menyimpan informasi tambahan tentang objek dalam terstruktur pemformatan dan pengambilan kueri untuk 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.	Tidak.
└─ objek	enum	Jenis objek sumber daya ini - selalu diatur ke `response`. Nilai yang mungkin: `response`	Yes
└─ keluaran	array OpenAI.OutputItem	Sebuah array item konten yang dihasilkan oleh model. - Panjang dan urutan item dalam `output` array tergantung pada respons model. - Daripada mengakses item pertama dalam `output` array dan Dengan asumsi ini adalah pesan `assistant` dengan konten yang dihasilkan oleh model, Anda mungkin mempertimbangkan untuk menggunakan properti `output_text` di mana didukung dalam SDK.	Yes
└─ teks hasil	string (dapat diakses NULL)		Tidak.
└─ pemanggilan_alat_parallel	Boolean	Apakah akan mengizinkan model menjalankan panggilan alat secara paralel.	Yes	Benar
└─ ID_respons_sebelumnya	string (dapat diakses NULL)		Tidak.
└─ perintah	OpenAI.Prompt	Referensi ke templat perintah dan variabelnya. Pelajari lebih lanjut.	Tidak.
└─ prompt_cache_key	string	Digunakan oleh OpenAI untuk menyimpan respons untuk permintaan serupa guna mengoptimalkan tingkat hit cache Anda. Mengganti bidang `user`. Pelajari lebih lanjut.	Tidak.
└─ prompt_cache_retention	enum	Nilai yang mungkin: `in-memory`, `24h`	Tidak.
└─ penalaran	OpenAI.Reasoning (nullable)	model gpt-5 dan o-series saja Opsi konfigurasi untuk model penalaran.	Tidak.
└─ safety_identifier	string	Pengidentifikasi stabil yang digunakan untuk membantu mendeteksi pengguna aplikasi Anda yang mungkin melanggar kebijakan penggunaan OpenAI. ID harus berupa string yang secara unik mengidentifikasi setiap pengguna. Sebaiknya hash nama pengguna atau alamat email mereka, untuk menghindari pengiriman informasi identifikasi apa pun kepada kami. Pelajari lebih lanjut.	Tidak.
└─ service_tier	OpenAI.ServiceTier	Menentukan jenis pemrosesan yang digunakan untuk melayani permintaan. - Jika diatur ke 'otomatis', permintaan akan diproses dengan tingkat layanan yang dikonfigurasi di pengaturan Project. Kecuali dikonfigurasi lain, Project akan menggunakan 'default'. - Jika diatur ke 'default', maka permintaan akan diproses dengan harga dan performa standar untuk model yang dipilih. - Jika diatur ke 'flex' atau 'priority', maka permintaan akan diproses dengan tingkat layanan yang sesuai. - Ketika tidak diatur, perilaku defaultnya adalah 'otomatis'. `service_tier` Ketika parameter diatur, isi respons akan menyertakan `service_tier` nilai berdasarkan mode pemrosesan yang benar-benar digunakan untuk melayani permintaan. Nilai respons ini mungkin berbeda dari nilai yang ditetapkan dalam parameter .	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	OpenAI.numeric (nullable)		Tidak.	1
└─ teks	OpenAI.ResponseTextParam	Opsi konfigurasi untuk respons teks dari model. Bisa biasa teks atau data JSON terstruktur. Pelajari lebih lanjut: - Input dan output teks - Output Terstruktur	Tidak.
└─ pilihan_alat	OpenAI.ToolChoiceOptions atau OpenAI.ToolChoiceParam		Tidak.
└─ peralatan	OpenAI.ToolsArray	Sekumpulan alat yang dapat dipanggil model ketika menghasilkan respons. Anda dapat menentukan alat mana yang akan digunakan dengan mengatur `tool_choice` parameter . Kami mendukung kategori alat berikut: - Alat bawaan: Alat yang disediakan oleh OpenAI yang memperluas Kemampuan model, seperti Web Search atau pencarian file. Pelajari selengkapnya tentang alat bawaan. - Alat MCP: Integrasi dengan sistem pihak ketiga melalui server MCP kustom atau konektor yang telah ditentukan sebelumnya seperti Google Drive dan SharePoint. Pelajari selengkapnya tentang Alat MCP. - Panggilan fungsi (alat kustom): Fungsi yang ditentukan oleh Anda, memungkinkan model untuk memanggil kode Anda sendiri dengan argumen yang sangat ditik dan output. Pelajari selengkapnya tentang panggilan fungsi. Anda juga dapat menggunakan alat kustom untuk memanggil kode Anda sendiri.	Tidak.
└─ top_logprobs	OpenAI.integer (dapat diakses dengan null)		Tidak.
└─ top_p	OpenAI.numeric (nullable)		Tidak.	1
└─ pemotongan	enum	Nilai yang mungkin: `auto`, `disabled`	Tidak.
└─ penggunaan	OpenAI.ResponseUsage	Merinci detail penggunaan token termasuk token input, token output, perincian token output, dan total token yang digunakan.	Tidak.
└─ pengguna	string (tidak digunakan lagi)	Bidang ini sedang digantikan oleh `safety_identifier` dan `prompt_cache_key`. Gunakan `prompt_cache_key` sebagai gantinya untuk mempertahankan pengoptimalan penembolokan. Pengidentifikasi yang stabil untuk pengguna akhir Anda. Digunakan untuk meningkatkan tingkat hit cache dengan membuat wadah permintaan serupa dengan lebih baik dan untuk membantu OpenAI mendeteksi dan mencegah penyalahgunaan. Pelajari lebih lanjut.	Tidak.
sequence_number	OpenAI.integer		Yes
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
item_id	string	ID item keluaran yang dipicu oleh panggilan pencarian file.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		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
item_id	string	ID item keluaran yang dipicu oleh panggilan pencarian file.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		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
item_id	string	ID item keluaran yang dipicu oleh panggilan pencarian file.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
jenis	enum	Jenis peristiwa. Selalu `response.file_search_call.searching`. Nilai yang mungkin: `response.file_search_call.searching`	Yes

OpenAI.ResponseFormatJsonObject

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. Pelajari selengkapnya tentang Output Terstruktur.

Nama	Tipe	Deskripsi	Diperlukan
json_schema	OpenAI.ResponseFormatJsonSchemaJsonSchema		Yes
└─ deskripsi	string		Tidak.
└─ nama	string		Yes
└─ skema	OpenAI.ResponseFormatJsonSchemaSchema	Skema untuk format respons, dijelaskan sebagai objek Skema JSON. Pelajari cara membuat skema JSON di sini.	Tidak.
└─ ketat	Boolean (dapat diberisi dengan null)		Tidak.
jenis	enum	Jenis format respons yang ditentukan. Selalu `json_schema`. Nilai yang mungkin: `json_schema`	Yes

OpenAI.ResponseFormatJsonSchemaJsonSchema

Nama	Tipe	Deskripsi	Diperlukan
deskripsi	string		Tidak.
Nama	string		Yes
skema	OpenAI.ResponseFormatJsonSchemaSchema	Skema untuk format respons, dijelaskan sebagai objek Skema JSON. Pelajari cara membuat skema JSON di sini.	Tidak.
tegas	Boolean (dapat diberisi dengan null)		Tidak.

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
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	OpenAI.integer		Yes
sequence_number	OpenAI.integer		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
argumen	string	Argumen pemanggilan fungsi.	Yes
item_id	string	ID dari item.	Yes
Nama	string	Nama fungsi yang dipanggil.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		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
item_id	string	Pengidentifikasi unik elemen pembuatan gambar yang sedang diproses.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		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
item_id	string	Pengidentifikasi unik elemen pembuatan gambar yang sedang diproses.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		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
item_id	string	Pengidentifikasi unik elemen pembuatan gambar yang sedang diproses.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		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
item_id	string	Pengidentifikasi unik elemen pembuatan gambar yang sedang diproses.	Yes
output_index	OpenAI.integer		Yes
partial_image_b64	string	Data gambar parsial yang dikodekan Base64, cocok untuk penyajian sebagai gambar.	Yes
partial_image_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		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	OpenAI.Response		Yes
└─ agent_reference	AgentReference (dapat diubah untuk null)	Agen yang digunakan untuk respons ini	Yes
└─ latar belakang	Boolean (dapat diberisi dengan null)		Tidak.
└─ completed_at	bilangan bulat (nullable)		Tidak.
└─ percakapan	OpenAI.ConversationReference (dapat diterima dengan null)	Percakapan tempat respons ini berada. Item input dan item output dari respons ini secara otomatis ditambahkan ke percakapan ini.	Tidak.
└─ dibuat_pada	bilangan bulat	Tanda waktu Unix (dalam detik) saat Respons ini dibuat.	Yes
└─ kesalahan	OpenAI.ResponseError (dapat diberisi null)	Objek kesalahan dikembalikan saat model gagal menghasilkan Respons.	Yes
└─ ID	string	Pengidentifikasi unik untuk Respons ini.	Yes
└─ detail_tidak_lengkap	OpenAI.ResponseIncompleteDetails (dapat diberisi null)		Yes
└─ instruksi	string atau array OpenAI.InputItem (nullable)		Yes
└─ max_output_tokens	OpenAI.integer (dapat diakses dengan null)		Tidak.
└─ max_tool_calls	OpenAI.integer (dapat diakses dengan null)		Tidak.
└─ metadata	OpenAI.Metadata (dapat diberisi dengan null)	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini bisa berguna untuk menyimpan informasi tambahan tentang objek dalam terstruktur pemformatan dan pengambilan kueri untuk 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.	Tidak.
└─ objek	enum	Jenis objek sumber daya ini - selalu diatur ke `response`. Nilai yang mungkin: `response`	Yes
└─ keluaran	array OpenAI.OutputItem	Sebuah array item konten yang dihasilkan oleh model. - Panjang dan urutan item dalam `output` array tergantung pada respons model. - Daripada mengakses item pertama dalam `output` array dan Dengan asumsi ini adalah pesan `assistant` dengan konten yang dihasilkan oleh model, Anda mungkin mempertimbangkan untuk menggunakan properti `output_text` di mana didukung dalam SDK.	Yes
└─ teks hasil	string (dapat diakses NULL)		Tidak.
└─ pemanggilan_alat_parallel	Boolean	Apakah akan mengizinkan model menjalankan panggilan alat secara paralel.	Yes	Benar
└─ ID_respons_sebelumnya	string (dapat diakses NULL)		Tidak.
└─ perintah	OpenAI.Prompt	Referensi ke templat perintah dan variabelnya. Pelajari lebih lanjut.	Tidak.
└─ prompt_cache_key	string	Digunakan oleh OpenAI untuk menyimpan respons untuk permintaan serupa guna mengoptimalkan tingkat hit cache Anda. Mengganti bidang `user`. Pelajari lebih lanjut.	Tidak.
└─ prompt_cache_retention	enum	Nilai yang mungkin: `in-memory`, `24h`	Tidak.
└─ penalaran	OpenAI.Reasoning (nullable)	model gpt-5 dan o-series saja Opsi konfigurasi untuk model penalaran.	Tidak.
└─ safety_identifier	string	Pengidentifikasi stabil yang digunakan untuk membantu mendeteksi pengguna aplikasi Anda yang mungkin melanggar kebijakan penggunaan OpenAI. ID harus berupa string yang secara unik mengidentifikasi setiap pengguna. Sebaiknya hash nama pengguna atau alamat email mereka, untuk menghindari pengiriman informasi identifikasi apa pun kepada kami. Pelajari lebih lanjut.	Tidak.
└─ service_tier	OpenAI.ServiceTier	Menentukan jenis pemrosesan yang digunakan untuk melayani permintaan. - Jika diatur ke 'otomatis', permintaan akan diproses dengan tingkat layanan yang dikonfigurasi di pengaturan Project. Kecuali dikonfigurasi lain, Project akan menggunakan 'default'. - Jika diatur ke 'default', maka permintaan akan diproses dengan harga dan performa standar untuk model yang dipilih. - Jika diatur ke 'flex' atau 'priority', maka permintaan akan diproses dengan tingkat layanan yang sesuai. - Ketika tidak diatur, perilaku defaultnya adalah 'otomatis'. `service_tier` Ketika parameter diatur, isi respons akan menyertakan `service_tier` nilai berdasarkan mode pemrosesan yang benar-benar digunakan untuk melayani permintaan. Nilai respons ini mungkin berbeda dari nilai yang ditetapkan dalam parameter .	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	OpenAI.numeric (nullable)		Tidak.	1
└─ teks	OpenAI.ResponseTextParam	Opsi konfigurasi untuk respons teks dari model. Bisa biasa teks atau data JSON terstruktur. Pelajari lebih lanjut: - Input dan output teks - Output Terstruktur	Tidak.
└─ pilihan_alat	OpenAI.ToolChoiceOptions atau OpenAI.ToolChoiceParam		Tidak.
└─ peralatan	OpenAI.ToolsArray	Sekumpulan alat yang dapat dipanggil model ketika menghasilkan respons. Anda dapat menentukan alat mana yang akan digunakan dengan mengatur `tool_choice` parameter . Kami mendukung kategori alat berikut: - Alat bawaan: Alat yang disediakan oleh OpenAI yang memperluas Kemampuan model, seperti Web Search atau pencarian file. Pelajari selengkapnya tentang alat bawaan. - Alat MCP: Integrasi dengan sistem pihak ketiga melalui server MCP kustom atau konektor yang telah ditentukan sebelumnya seperti Google Drive dan SharePoint. Pelajari selengkapnya tentang Alat MCP. - Panggilan fungsi (alat kustom): Fungsi yang ditentukan oleh Anda, memungkinkan model untuk memanggil kode Anda sendiri dengan argumen yang sangat ditik dan output. Pelajari selengkapnya tentang panggilan fungsi. Anda juga dapat menggunakan alat kustom untuk memanggil kode Anda sendiri.	Tidak.
└─ top_logprobs	OpenAI.integer (dapat diakses dengan null)		Tidak.
└─ top_p	OpenAI.numeric (nullable)		Tidak.	1
└─ pemotongan	enum	Nilai yang mungkin: `auto`, `disabled`	Tidak.
└─ penggunaan	OpenAI.ResponseUsage	Merinci detail penggunaan token termasuk token input, token output, perincian token output, dan total token yang digunakan.	Tidak.
└─ pengguna	string (tidak digunakan lagi)	Bidang ini sedang digantikan oleh `safety_identifier` dan `prompt_cache_key`. Gunakan `prompt_cache_key` sebagai gantinya untuk mempertahankan pengoptimalan penembolokan. Pengidentifikasi yang stabil untuk pengguna akhir Anda. Digunakan untuk meningkatkan tingkat hit cache dengan membuat wadah permintaan serupa dengan lebih baik dan untuk membantu OpenAI mendeteksi dan mencegah penyalahgunaan. Pelajari lebih lanjut.	Tidak.
sequence_number	OpenAI.integer		Yes
jenis	enum	Jenis peristiwa. Selalu `response.in_progress`. Nilai yang mungkin: `response.in_progress`	Yes

OpenAI.ResponseIncompleteDetails

Nama	Tipe	Deskripsi	Diperlukan	Default
alasan	enum	Nilai yang mungkin: `max_output_tokens`, `content_filter`	Tidak.

OpenAI.ResponseIncompleteEvent

Peristiwa yang dipancarkan ketika respons selesai sebagai tidak lengkap.

Nama	Tipe	Deskripsi	Diperlukan	Default
response	OpenAI.Response		Yes
└─ agent_reference	AgentReference (dapat diubah untuk null)	Agen yang digunakan untuk respons ini	Yes
└─ latar belakang	Boolean (dapat diberisi dengan null)		Tidak.
└─ completed_at	bilangan bulat (nullable)		Tidak.
└─ percakapan	OpenAI.ConversationReference (dapat diterima dengan null)	Percakapan tempat respons ini berada. Item input dan item output dari respons ini secara otomatis ditambahkan ke percakapan ini.	Tidak.
└─ dibuat_pada	bilangan bulat	Tanda waktu Unix (dalam detik) saat Respons ini dibuat.	Yes
└─ kesalahan	OpenAI.ResponseError (dapat diberisi null)	Objek kesalahan dikembalikan saat model gagal menghasilkan Respons.	Yes
└─ ID	string	Pengidentifikasi unik untuk Respons ini.	Yes
└─ detail_tidak_lengkap	OpenAI.ResponseIncompleteDetails (dapat diberisi null)		Yes
└─ instruksi	string atau array OpenAI.InputItem (nullable)		Yes
└─ max_output_tokens	OpenAI.integer (dapat diakses dengan null)		Tidak.
└─ max_tool_calls	OpenAI.integer (dapat diakses dengan null)		Tidak.
└─ metadata	OpenAI.Metadata (dapat diberisi dengan null)	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini bisa berguna untuk menyimpan informasi tambahan tentang objek dalam terstruktur pemformatan dan pengambilan kueri untuk 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.	Tidak.
└─ objek	enum	Jenis objek sumber daya ini - selalu diatur ke `response`. Nilai yang mungkin: `response`	Yes
└─ keluaran	array OpenAI.OutputItem	Sebuah array item konten yang dihasilkan oleh model. - Panjang dan urutan item dalam `output` array tergantung pada respons model. - Daripada mengakses item pertama dalam `output` array dan Dengan asumsi ini adalah pesan `assistant` dengan konten yang dihasilkan oleh model, Anda mungkin mempertimbangkan untuk menggunakan properti `output_text` di mana didukung dalam SDK.	Yes
└─ teks hasil	string (dapat diakses NULL)		Tidak.
└─ pemanggilan_alat_parallel	Boolean	Apakah akan mengizinkan model menjalankan panggilan alat secara paralel.	Yes	Benar
└─ ID_respons_sebelumnya	string (dapat diakses NULL)		Tidak.
└─ perintah	OpenAI.Prompt	Referensi ke templat perintah dan variabelnya. Pelajari lebih lanjut.	Tidak.
└─ prompt_cache_key	string	Digunakan oleh OpenAI untuk menyimpan respons untuk permintaan serupa guna mengoptimalkan tingkat hit cache Anda. Mengganti bidang `user`. Pelajari lebih lanjut.	Tidak.
└─ prompt_cache_retention	enum	Nilai yang mungkin: `in-memory`, `24h`	Tidak.
└─ penalaran	OpenAI.Reasoning (nullable)	model gpt-5 dan o-series saja Opsi konfigurasi untuk model penalaran.	Tidak.
└─ safety_identifier	string	Pengidentifikasi stabil yang digunakan untuk membantu mendeteksi pengguna aplikasi Anda yang mungkin melanggar kebijakan penggunaan OpenAI. ID harus berupa string yang secara unik mengidentifikasi setiap pengguna. Sebaiknya hash nama pengguna atau alamat email mereka, untuk menghindari pengiriman informasi identifikasi apa pun kepada kami. Pelajari lebih lanjut.	Tidak.
└─ service_tier	OpenAI.ServiceTier	Menentukan jenis pemrosesan yang digunakan untuk melayani permintaan. - Jika diatur ke 'otomatis', permintaan akan diproses dengan tingkat layanan yang dikonfigurasi di pengaturan Project. Kecuali dikonfigurasi lain, Project akan menggunakan 'default'. - Jika diatur ke 'default', maka permintaan akan diproses dengan harga dan performa standar untuk model yang dipilih. - Jika diatur ke 'flex' atau 'priority', maka permintaan akan diproses dengan tingkat layanan yang sesuai. - Ketika tidak diatur, perilaku defaultnya adalah 'otomatis'. `service_tier` Ketika parameter diatur, isi respons akan menyertakan `service_tier` nilai berdasarkan mode pemrosesan yang benar-benar digunakan untuk melayani permintaan. Nilai respons ini mungkin berbeda dari nilai yang ditetapkan dalam parameter .	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	OpenAI.numeric (nullable)		Tidak.	1
└─ teks	OpenAI.ResponseTextParam	Opsi konfigurasi untuk respons teks dari model. Bisa biasa teks atau data JSON terstruktur. Pelajari lebih lanjut: - Input dan output teks - Output Terstruktur	Tidak.
└─ pilihan_alat	OpenAI.ToolChoiceOptions atau OpenAI.ToolChoiceParam		Tidak.
└─ peralatan	OpenAI.ToolsArray	Sekumpulan alat yang dapat dipanggil model ketika menghasilkan respons. Anda dapat menentukan alat mana yang akan digunakan dengan mengatur `tool_choice` parameter . Kami mendukung kategori alat berikut: - Alat bawaan: Alat yang disediakan oleh OpenAI yang memperluas Kemampuan model, seperti Web Search atau pencarian file. Pelajari selengkapnya tentang alat bawaan. - Alat MCP: Integrasi dengan sistem pihak ketiga melalui server MCP kustom atau konektor yang telah ditentukan sebelumnya seperti Google Drive dan SharePoint. Pelajari selengkapnya tentang Alat MCP. - Panggilan fungsi (alat kustom): Fungsi yang ditentukan oleh Anda, memungkinkan model untuk memanggil kode Anda sendiri dengan argumen yang sangat ditik dan output. Pelajari selengkapnya tentang panggilan fungsi. Anda juga dapat menggunakan alat kustom untuk memanggil kode Anda sendiri.	Tidak.
└─ top_logprobs	OpenAI.integer (dapat diakses dengan null)		Tidak.
└─ top_p	OpenAI.numeric (nullable)		Tidak.	1
└─ pemotongan	enum	Nilai yang mungkin: `auto`, `disabled`	Tidak.
└─ penggunaan	OpenAI.ResponseUsage	Merinci detail penggunaan token termasuk token input, token output, perincian token output, dan total token yang digunakan.	Tidak.
└─ pengguna	string (tidak digunakan lagi)	Bidang ini sedang digantikan oleh `safety_identifier` dan `prompt_cache_key`. Gunakan `prompt_cache_key` sebagai gantinya untuk mempertahankan pengoptimalan penembolokan. Pengidentifikasi yang stabil untuk pengguna akhir Anda. Digunakan untuk meningkatkan tingkat hit cache dengan membuat wadah permintaan serupa dengan lebih baik dan untuk membantu OpenAI mendeteksi dan mencegah penyalahgunaan. Pelajari lebih lanjut.	Tidak.
sequence_number	OpenAI.integer		Yes
jenis	enum	Jenis peristiwa. Selalu `response.incomplete`. Nilai yang mungkin: `response.incomplete`	Yes

OpenAI.ResponseLogProb

Logprob adalah probabilitas logaritmik yang ditetapkan model untuk menghasilkan token tertentu pada posisi tertentu dalam urutan. Nilai logprob yang kurang negatif (lebih tinggi) menunjukkan keyakinan model yang lebih besar dalam pilihan token tersebut.

Nama	Tipe	Deskripsi	Diperlukan
logprob	OpenAI.numeric		Yes
token	string	Token teks yang mungkin.	Yes
top_logprobs	array OpenAI.ResponseLogProbTopLogprobs	Probabilitas log dari 20 token teratas yang paling mungkin.	Tidak.

OpenAI.ResponseLogProbTopLogprobs

Nama	Tipe	Deskripsi	Diperlukan	Default
logprob	OpenAI.numeric		Tidak.
token	string		Tidak.

OpenAI.ResponseMCPCallArgumentsDeltaEvent

Dikeluarkan ketika ada perubahan parsial pada argumen panggilan alat MCP.

Nama	Tipe	Deskripsi	Diperlukan
delta	string	String JSON yang berisi pembaruan parsial ke argumen untuk panggilan alat MCP.	Yes
item_id	string	Pengidentifikasi unik dari item panggilan alat MCP yang sedang diproses.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		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
argumen	string	String JSON yang berisi argumen akhir untuk panggilan alat MCP.	Yes
item_id	string	Pengidentifikasi unik dari item panggilan alat MCP yang sedang diproses.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		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
item_id	string	ID item panggilan alat MCP yang selesai.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
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
item_id	string	ID item panggilan alat MCP yang gagal.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
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
item_id	string	Pengidentifikasi unik dari item panggilan alat MCP yang sedang diproses.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		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
item_id	string	ID item panggilan alat MCP yang menghasilkan output ini.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
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
item_id	string	ID item panggilan alat MCP yang gagal.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
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
item_id	string	ID item panggilan alat MCP yang sedang diproses.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
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
item	OpenAI.OutputItem		Yes
└─ agent_reference	AgentReference	Agen yang membuat item.	Tidak.
└─ response_id	string	Respons tempat item dibuat.	Tidak.
└─ jenis	OpenAI.OutputItemType		Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		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
item	OpenAI.OutputItem		Yes
└─ agent_reference	AgentReference	Agen yang membuat item.	Tidak.
└─ response_id	string	Respons tempat item dibuat.	Tidak.
└─ jenis	OpenAI.OutputItemType		Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
jenis	enum	Jenis peristiwa. Selalu `response.output_item.done`. Nilai yang mungkin: `response.output_item.done`	Yes

OpenAI.ResponseOutputTextAnnotationAddedEvent

Dipancarkan saat anotasi ditambahkan ke konten teks output.

Nama	Tipe	Deskripsi	Diperlukan
anotasi	OpenAI.Anotasi	Anotasi yang berlaku untuk rentang teks output.	Yes
└─ jenis	OpenAI.AnnotationType		Yes
annotation_index	OpenAI.integer		Yes
content_index	OpenAI.integer		Yes
item_id	string	Pengidentifikasi unik item tempat anotasi ditambahkan.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
jenis	enum	Jenis peristiwa. Selalu 'response.output_text.anotasi.added'. Nilai yang mungkin: `response.output_text.annotation.added`	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	OpenAI.Response		Yes
└─ agent_reference	AgentReference (dapat diubah untuk null)	Agen yang digunakan untuk respons ini	Yes
└─ latar belakang	Boolean (dapat diberisi dengan null)		Tidak.
└─ completed_at	bilangan bulat (nullable)		Tidak.
└─ percakapan	OpenAI.ConversationReference (dapat diterima dengan null)	Percakapan tempat respons ini berada. Item input dan item output dari respons ini secara otomatis ditambahkan ke percakapan ini.	Tidak.
└─ dibuat_pada	bilangan bulat	Tanda waktu Unix (dalam detik) saat Respons ini dibuat.	Yes
└─ kesalahan	OpenAI.ResponseError (dapat diberisi null)	Objek kesalahan dikembalikan saat model gagal menghasilkan Respons.	Yes
└─ ID	string	Pengidentifikasi unik untuk Respons ini.	Yes
└─ detail_tidak_lengkap	OpenAI.ResponseIncompleteDetails (dapat diberisi null)		Yes
└─ instruksi	string atau array OpenAI.InputItem (nullable)		Yes
└─ max_output_tokens	OpenAI.integer (dapat diakses dengan null)		Tidak.
└─ max_tool_calls	OpenAI.integer (dapat diakses dengan null)		Tidak.
└─ metadata	OpenAI.Metadata (dapat diberisi dengan null)	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini bisa berguna untuk menyimpan informasi tambahan tentang objek dalam terstruktur pemformatan dan pengambilan kueri untuk 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.	Tidak.
└─ objek	enum	Jenis objek sumber daya ini - selalu diatur ke `response`. Nilai yang mungkin: `response`	Yes
└─ keluaran	array OpenAI.OutputItem	Sebuah array item konten yang dihasilkan oleh model. - Panjang dan urutan item dalam `output` array tergantung pada respons model. - Daripada mengakses item pertama dalam `output` array dan Dengan asumsi ini adalah pesan `assistant` dengan konten yang dihasilkan oleh model, Anda mungkin mempertimbangkan untuk menggunakan properti `output_text` di mana didukung dalam SDK.	Yes
└─ teks hasil	string (dapat diakses NULL)		Tidak.
└─ pemanggilan_alat_parallel	Boolean	Apakah akan mengizinkan model menjalankan panggilan alat secara paralel.	Yes	Benar
└─ ID_respons_sebelumnya	string (dapat diakses NULL)		Tidak.
└─ perintah	OpenAI.Prompt	Referensi ke templat perintah dan variabelnya. Pelajari lebih lanjut.	Tidak.
└─ prompt_cache_key	string	Digunakan oleh OpenAI untuk menyimpan respons untuk permintaan serupa guna mengoptimalkan tingkat hit cache Anda. Mengganti bidang `user`. Pelajari lebih lanjut.	Tidak.
└─ prompt_cache_retention	enum	Nilai yang mungkin: `in-memory`, `24h`	Tidak.
└─ penalaran	OpenAI.Reasoning (nullable)	model gpt-5 dan o-series saja Opsi konfigurasi untuk model penalaran.	Tidak.
└─ safety_identifier	string	Pengidentifikasi stabil yang digunakan untuk membantu mendeteksi pengguna aplikasi Anda yang mungkin melanggar kebijakan penggunaan OpenAI. ID harus berupa string yang secara unik mengidentifikasi setiap pengguna. Sebaiknya hash nama pengguna atau alamat email mereka, untuk menghindari pengiriman informasi identifikasi apa pun kepada kami. Pelajari lebih lanjut.	Tidak.
└─ service_tier	OpenAI.ServiceTier	Menentukan jenis pemrosesan yang digunakan untuk melayani permintaan. - Jika diatur ke 'otomatis', permintaan akan diproses dengan tingkat layanan yang dikonfigurasi di pengaturan Project. Kecuali dikonfigurasi lain, Project akan menggunakan 'default'. - Jika diatur ke 'default', maka permintaan akan diproses dengan harga dan performa standar untuk model yang dipilih. - Jika diatur ke 'flex' atau 'priority', maka permintaan akan diproses dengan tingkat layanan yang sesuai. - Ketika tidak diatur, perilaku defaultnya adalah 'otomatis'. `service_tier` Ketika parameter diatur, isi respons akan menyertakan `service_tier` nilai berdasarkan mode pemrosesan yang benar-benar digunakan untuk melayani permintaan. Nilai respons ini mungkin berbeda dari nilai yang ditetapkan dalam parameter .	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	OpenAI.numeric (nullable)		Tidak.	1
└─ teks	OpenAI.ResponseTextParam	Opsi konfigurasi untuk respons teks dari model. Bisa biasa teks atau data JSON terstruktur. Pelajari lebih lanjut: - Input dan output teks - Output Terstruktur	Tidak.
└─ pilihan_alat	OpenAI.ToolChoiceOptions atau OpenAI.ToolChoiceParam		Tidak.
└─ peralatan	OpenAI.ToolsArray	Sekumpulan alat yang dapat dipanggil model ketika menghasilkan respons. Anda dapat menentukan alat mana yang akan digunakan dengan mengatur `tool_choice` parameter . Kami mendukung kategori alat berikut: - Alat bawaan: Alat yang disediakan oleh OpenAI yang memperluas Kemampuan model, seperti Web Search atau pencarian file. Pelajari selengkapnya tentang alat bawaan. - Alat MCP: Integrasi dengan sistem pihak ketiga melalui server MCP kustom atau konektor yang telah ditentukan sebelumnya seperti Google Drive dan SharePoint. Pelajari selengkapnya tentang Alat MCP. - Panggilan fungsi (alat kustom): Fungsi yang ditentukan oleh Anda, memungkinkan model untuk memanggil kode Anda sendiri dengan argumen yang sangat ditik dan output. Pelajari selengkapnya tentang panggilan fungsi. Anda juga dapat menggunakan alat kustom untuk memanggil kode Anda sendiri.	Tidak.
└─ top_logprobs	OpenAI.integer (dapat diakses dengan null)		Tidak.
└─ top_p	OpenAI.numeric (nullable)		Tidak.	1
└─ pemotongan	enum	Nilai yang mungkin: `auto`, `disabled`	Tidak.
└─ penggunaan	OpenAI.ResponseUsage	Merinci detail penggunaan token termasuk token input, token output, perincian token output, dan total token yang digunakan.	Tidak.
└─ pengguna	string (tidak digunakan lagi)	Bidang ini sedang digantikan oleh `safety_identifier` dan `prompt_cache_key`. Gunakan `prompt_cache_key` sebagai gantinya untuk mempertahankan pengoptimalan penembolokan. Pengidentifikasi yang stabil untuk pengguna akhir Anda. Digunakan untuk meningkatkan tingkat hit cache dengan membuat wadah permintaan serupa dengan lebih baik dan untuk membantu OpenAI mendeteksi dan mencegah penyalahgunaan. Pelajari lebih lanjut.	Tidak.
sequence_number	OpenAI.integer		Yes
jenis	enum	Jenis peristiwa. Selalu 'response.queued'. Nilai yang mungkin: `response.queued`	Yes

OpenAI.ResponseReasoningSummaryPartAddedEvent

Dikeluarkan saat bagian ringkasan penalaran baru ditambahkan.

Nama	Tipe	Deskripsi	Diperlukan
item_id	string	ID item yang dikaitkan dengan bagian ringkasan ini.	Yes
output_index	OpenAI.integer		Yes
bagian	OpenAI.ResponseReasoningSummaryPartAddedEventPart		Yes
└─ teks	string		Yes
└─ jenis	enum	Nilai yang mungkin: `summary_text`	Yes
sequence_number	OpenAI.integer		Yes
summary_index	OpenAI.integer		Yes
jenis	enum	Jenis peristiwa. Selalu `response.reasoning_summary_part.added`. Nilai yang mungkin: `response.reasoning_summary_part.added`	Yes

OpenAI.ResponseReasoningSummaryPartAddedEventPart

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

OpenAI.ResponseReasoningSummaryPartDoneEvent

Dihasilkan saat bagian ringkasan penalaran selesai.

Nama	Tipe	Deskripsi	Diperlukan
item_id	string	ID item yang dikaitkan dengan bagian ringkasan ini.	Yes
output_index	OpenAI.integer		Yes
bagian	OpenAI.ResponseReasoningSummaryPartDoneEventPart		Yes
└─ teks	string		Yes
└─ jenis	enum	Nilai yang mungkin: `summary_text`	Yes
sequence_number	OpenAI.integer		Yes
summary_index	OpenAI.integer		Yes
jenis	enum	Jenis peristiwa. Selalu `response.reasoning_summary_part.done`. Nilai yang mungkin: `response.reasoning_summary_part.done`	Yes

OpenAI.ResponseReasoningSummaryPartDoneEventPart

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

OpenAI.ResponseReasoningSummaryTextDeltaEvent

Dikeluarkan saat sebuah delta ditambahkan ke ringkasan teks penalaran.

Nama	Tipe	Deskripsi	Diperlukan
delta	string	Delta teks yang ditambahkan ke ringkasan.	Yes
item_id	string	ID item yang dikaitkan dengan delta teks ringkasan ini.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
summary_index	OpenAI.integer		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
item_id	string	ID dari item yang terkait dengan teks ringkasan ini.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
summary_index	OpenAI.integer		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.ResponseReasoningTextDeltaEvent

Dipancarkan saat delta ditambahkan ke teks penalaran.

Nama	Tipe	Deskripsi	Diperlukan
content_index	OpenAI.integer		Yes
delta	string	Delta teks yang ditambahkan ke konten penalaran.	Yes
item_id	string	ID item yang dikaitkan dengan delta teks penalaran ini.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
jenis	enum	Jenis peristiwa. Selalu `response.reasoning_text.delta`. Nilai yang mungkin: `response.reasoning_text.delta`	Yes

OpenAI.ResponseReasoningTextDoneEvent

Dipancarkan saat teks penalaran selesai.

Nama	Tipe	Deskripsi	Diperlukan
content_index	OpenAI.integer		Yes
item_id	string	ID item yang dikaitkan dengan teks penalaran ini.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
kirim pesan teks	string	Teks lengkap dari konten penalaran yang telah selesai.	Yes
jenis	enum	Jenis peristiwa. Selalu `response.reasoning_text.done`. Nilai yang mungkin: `response.reasoning_text.done`	Yes

OpenAI.ResponseRefusalDeltaEvent

Dipancarkan ketika ada teks penolakan parsial.

Nama	Tipe	Deskripsi	Diperlukan
content_index	OpenAI.integer		Yes
delta	string	Teks penolakan yang ditambahkan.	Yes
item_id	string	ID dari item keluaran tempat teks penolakan ditambahkan.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		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
content_index	OpenAI.integer		Yes
item_id	string	ID item keluaran dari teks penolakan yang selesai.	Yes
output_index	OpenAI.integer		Yes
refusal	string	Teks penolakan yang sudah difinalisasi.	Yes
sequence_number	OpenAI.integer		Yes
jenis	enum	Jenis peristiwa. Selalu `response.refusal.done`. Nilai yang mungkin: `response.refusal.done`	Yes

OpenAI.ResponseStreamOptions

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

Nama	Tipe	Deskripsi	Diperlukan	Default
include_obfuscation	Boolean	Jika true, obfuscation streaming akan diaktifkan. Pengaburan streaming ditambahkan karakter acak ke `obfuscation` bidang pada peristiwa delta streaming ke menormalkan ukuran payload sebagai mitigasi terhadap serangan saluran samping tertentu. Bidang obfuscation ini disertakan secara default, tetapi menambahkan sejumlah kecil overhead ke aliran data. Anda dapat mengatur `include_obfuscation` ke false untuk mengoptimalkan bandwidth jika Anda mempercayai tautan jaringan antara aplikasi Anda dan OpenAI API.	Tidak.

OpenAI.ResponseTextDeltaEvent

Dipancarkan ketika ada delta teks tambahan.

Nama	Tipe	Deskripsi	Diperlukan
content_index	OpenAI.integer		Yes
delta	string	Delta teks yang ditambahkan.	Yes
item_id	string	ID item keluaran tempat delta teks ditambahkan.	Yes
logprobs	array OpenAI.ResponseLogProb	Probabilitas log token di delta.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		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
content_index	OpenAI.integer		Yes
item_id	string	ID dari item keluaran yang konten teksnya telah difinalisasi.	Yes
logprobs	array OpenAI.ResponseLogProb	Probabilitas log token di delta.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		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.ResponseTextParam

Opsi konfigurasi untuk respons teks dari model. Dapat berupa teks biasa atau data JSON terstruktur. Pelajari lebih lanjut:

Nama	Tipe	Deskripsi	Diperlukan	Default
format	OpenAI.TextResponseFormatConfiguration	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. Pelajari selengkapnya di Format defaultnya adalah `{ "type": "text" }` tanpa opsi tambahan. Tidak disarankan untuk model gpt-4o dan yang lebih baru:* Pengaturan ke `{ "type": "json_object" }` memungkinkan mode JSON yang lebih lama, yang memastikan pesan yang dihasilkan model adalah JSON yang valid. Menggunakan `json_schema` lebih diperuntukkan bagi model yang mendukungnya.	Tidak.
verbositas	OpenAI.Verbosity	Membatasi verbositas respons model. Nilai yang lebih rendah akan menghasilkan respons yang lebih ringkas, sementara nilai yang lebih tinggi akan menghasilkan respons yang lebih verbose. Nilai yang saat ini didukung adalah `low`, `medium`, dan `high`.	Tidak.

OpenAI.ResponseUsage

Mewakili detail penggunaan token termasuk token input, token output, perincian token output, dan total token yang digunakan.

Nama	Tipe	Diperlukan
input_tokens	OpenAI.integer	Yes
input_tokens_details	OpenAI.ResponseUsageInputTokensDetails	Yes
└─ token_yang_di-cache	OpenAI.integer	Yes
output_tokens	OpenAI.integer	Yes
output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails	Yes
└─ token_penalaran	OpenAI.integer	Yes
total_tokens	OpenAI.integer	Yes

OpenAI.ResponseUsageInputTokensDetails

Nama	Tipe	Deskripsi	Diperlukan	Default
cached_tokens	OpenAI.integer		Yes

OpenAI.ResponseUsageOutputTokensDetails

Nama	Tipe	Deskripsi	Diperlukan	Default
token_penalaran	OpenAI.integer		Yes

OpenAI.ResponseWebSearchCallCompletedEvent

Dikeluarkan ketika panggilan pencarian web selesai.

Nama	Tipe	Deskripsi	Diperlukan
item_id	string	ID unik untuk item output yang terkait dengan panggilan pencarian web.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
jenis	enum	Jenis peristiwa. Selalu `response.web_search_call.completed`. Nilai yang mungkin: `response.web_search_call.completed`	Yes

OpenAI.ResponseWebSearchCallInProgressEvent

Dipancarkan ketika panggilan pencarian web dimulai.

Nama	Tipe	Deskripsi	Diperlukan
item_id	string	ID unik untuk item output yang terkait dengan panggilan pencarian web.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
jenis	enum	Jenis peristiwa. Selalu `response.web_search_call.in_progress`. Nilai yang mungkin: `response.web_search_call.in_progress`	Yes

OpenAI.ResponseWebSearchCallSearchingEvent

Dipancarkan ketika panggilan pencarian web dijalankan.

Nama	Tipe	Deskripsi	Diperlukan
item_id	string	ID unik untuk item output yang terkait dengan panggilan pencarian web.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
jenis	enum	Jenis peristiwa. Selalu `response.web_search_call.searching`. Nilai yang mungkin: `response.web_search_call.searching`	Yes

OpenAI.Screenshot

Aksi tangkapan layar.

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	enum	Menentukan jenis peristiwa. Untuk tindakan cuplikan layar, properti ini adalah selalu atur ke `screenshot`. Nilai yang mungkin: `screenshot`	Yes

OpenAI.Scroll

Sebuah aksi pengguliran.

Nama	Tipe	Deskripsi	Diperlukan
scroll_x	OpenAI.integer		Yes
scroll_y	OpenAI.integer		Yes
jenis	enum	Menentukan jenis peristiwa. Untuk tindakan gulir, properti ini adalah selalu atur ke `scroll`. Nilai yang mungkin: `scroll`	Yes
x	OpenAI.integer		Yes
y	OpenAI.integer		Yes

OpenAI.SearchContextSize

Harta benda	Nilai
Jenis	string
Nilai	`low` `medium` `high`

OpenAI.ServiceTier

Menentukan jenis pemrosesan yang digunakan untuk melayani permintaan.

Jika diatur ke 'otomatis', maka permintaan akan diproses dengan tingkat layanan yang dikonfigurasi di pengaturan Project. Kecuali dikonfigurasi lain, Project akan menggunakan 'default'.
Jika diatur ke 'default', maka permintaan akan diproses dengan harga dan performa standar untuk model yang dipilih.
Jika diatur ke 'flex' atau 'priority', maka permintaan akan diproses dengan tingkat layanan yang sesuai.
Saat tidak diatur, perilaku defaultnya adalah 'otomatis'. service_tier Ketika parameter diatur, isi respons akan menyertakan service_tier nilai berdasarkan mode pemrosesan yang benar-benar digunakan untuk melayani permintaan. Nilai respons ini mungkin berbeda dari nilai yang ditetapkan dalam parameter .

Harta benda	Nilai
Jenis	string
Dapat diubah ke null	Yes
Nilai	`auto` `default` `flex` `scale` `priority`

OpenAI.SpecificApplyPatchParam

Memaksa model untuk memanggil alat apply_patch saat menjalankan panggilan alat.

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	enum	Alat untuk dipanggil. Selalu `apply_patch`. Nilai yang mungkin: `apply_patch`	Yes

OpenAI.SpecificFunctionShellParam

Memaksa model untuk memanggil alat shell saat panggilan alat diperlukan.

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	enum	Alat untuk dipanggil. Selalu `shell`. Nilai yang mungkin: `shell`	Yes

OpenAI.Summary

Teks ringkasan dari model.

Nama	Tipe	Deskripsi	Diperlukan	Default
kirim pesan teks	string	Ringkasan keluaran penalaran dari model sejauh ini.	Yes
jenis	enum	Jenis objek. Selalu `summary_text`. Nilai yang mungkin: `summary_text`	Yes

OpenAI.SummaryTextContent

Teks ringkasan dari model.

Nama	Tipe	Deskripsi	Diperlukan	Default
kirim pesan teks	string	Ringkasan keluaran penalaran dari model sejauh ini.	Yes
jenis	enum	Jenis objek. Selalu `summary_text`. Nilai yang mungkin: `summary_text`	Yes

OpenAI.TextContent

Konten teks.

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

OpenAI.TextResponseFormatConfiguration

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. Pelajari selengkapnya di

Format defaultnya adalah { "type": "text" } tanpa opsi tambahan. Tidak disarankan untuk gpt-4o dan model 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.

Diskriminator untuk OpenAI.TextResponseFormatConfiguration

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
`json_schema`	OpenAI.TextResponseFormatJsonSchema
`text`	OpenAI.TextResponseFormatConfigurationResponseFormatText
`json_object`	OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	OpenAI.TextResponseFormatConfigurationType		Yes

OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject

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

OpenAI.TextResponseFormatConfigurationResponseFormatText

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

Harta benda	Nilai
Jenis	string
Nilai	`text` `json_schema` `json_object`

OpenAI.TextResponseFormatJsonSchema

Format Skema JSON untuk respons. Digunakan untuk menghasilkan respons JSON terstruktur. Pelajari selengkapnya tentang Output Terstruktur.

Nama	Tipe	Deskripsi	Diperlukan
deskripsi	string	Deskripsi tentang tujuan format respons, yang digunakan oleh model untuk tentukan cara merespons sesuai dengan format.	Tidak.
Nama	string	Nama format tanggapan. Harus terdiri dari a-z, A-Z, 0-9, atau mengandung 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 (dapat diberisi dengan null)		Tidak.
jenis	enum	Jenis format respons yang ditentukan. Selalu `json_schema`. Nilai yang mungkin: `json_schema`	Yes

OpenAI.Tool

Alat yang dapat digunakan untuk menghasilkan respons.

Diskriminator untuk OpenAI.Tool

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
`bing_grounding`	BingGroundingTool
`fabric_dataagent_preview`	MicrosoftFabricPreviewTool
`sharepoint_grounding_preview`	SharepointPreviewTool
`azure_ai_search`	AzureAISearchTool
`openapi`	OpenApiTool
`bing_custom_search_preview`	BingCustomSearchPreviewTool
`browser_automation_preview`	BrowserAutomationPreviewTool
`azure_function`	AzureFunctionTool
`capture_structured_outputs`	CaptureStructuredOutputsTool
`a2a_preview`	A2APreviewTool
`memory_search_preview`	MemorySearchPreviewTool
`code_interpreter`	OpenAI.CodeInterpreterTool
`function`	OpenAI.FunctionTool
`file_search`	OpenAI.FileSearchTool
`computer_use_preview`	OpenAI.ComputerUsePreviewTool
`web_search`	OpenAI.WebSearchTool
`mcp`	OpenAI.MCPTool
`image_generation`	OpenAI.ImageGenTool
`local_shell`	OpenAI.LocalShellToolParam
`shell`	OpenAI.FunctionShellToolParam
`custom`	OpenAI.CustomToolParam
`web_search_preview`	OpenAI.WebSearchPreviewTool
`apply_patch`	OpenAI.ApplyPatchToolParam

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	OpenAI.ToolType		Yes

OpenAI.ToolChoiceAllowed

Membatasi alat yang tersedia untuk model ke set yang telah ditentukan sebelumnya.

Nama	Tipe	Deskripsi	Diperlukan
mode	enum	Membatasi alat yang tersedia untuk model ke set yang telah ditentukan sebelumnya. `auto` memungkinkan model untuk memilih dari antara alat yang diizinkan dan menghasilkan pesan. `required` memerlukan model untuk memanggil satu atau beberapa alat yang diizinkan. Nilai yang mungkin: `auto`, `required`	Yes
perangkat	array objek	Daftar definisi alat yang harus diizinkan untuk dipanggil model. Untuk API Respons, daftar definisi alat mungkin terlihat seperti: `json<br> [<br> { "type": "function", "name": "get_weather" },<br> { "type": "mcp", "server_label": "deepwiki" },<br> { "type": "image_generation" }<br> ]<br>`	Yes
jenis	enum	Jenis konfigurasi alat yang diizinkan. Selalu `allowed_tools`. Nilai yang mungkin: `allowed_tools`	Yes

OpenAI.ToolChoiceCodeInterpreter

Menunjukkan bahwa model harus menggunakan alat bawaan untuk menghasilkan respons. Pelajari selengkapnya tentang alat bawaan.

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

OpenAI.ToolChoiceComputerUsePreview

Menunjukkan bahwa model harus menggunakan alat bawaan untuk menghasilkan respons. Pelajari selengkapnya tentang alat bawaan.

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

OpenAI.ToolChoiceCustom

Gunakan opsi ini untuk memaksa model memanggil alat kustom tertentu.

Nama	Tipe	Deskripsi	Diperlukan	Default
Nama	string	Nama alat kustom yang akan dipanggil.	Yes
jenis	enum	Untuk panggilan alat kustom, jenisnya selalu `custom`. Nilai yang mungkin: `custom`	Yes

OpenAI.ToolChoiceFileSearch

Menunjukkan bahwa model harus menggunakan alat bawaan untuk menghasilkan respons. Pelajari selengkapnya tentang alat bawaan.

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

OpenAI.ToolChoiceFunction

Gunakan opsi ini untuk memaksa model memanggil fungsi tertentu.

Nama	Tipe	Deskripsi	Diperlukan	Default
Nama	string	Nama fungsi yang akan dipanggil.	Yes
jenis	enum	Untuk panggilan fungsi, jenisnya selalu `function`. Nilai yang mungkin: `function`	Yes

OpenAI.ToolChoiceImageGeneration

Menunjukkan bahwa model harus menggunakan alat bawaan untuk menghasilkan respons. Pelajari selengkapnya tentang alat bawaan.

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

OpenAI.ToolChoiceMCP

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

Nama	Tipe	Deskripsi	Diperlukan
Nama	string (dapat diakses NULL)		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.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
Jenis	string
Nilai	`none` `auto` `required`

OpenAI.ToolChoiceParam

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.

Diskriminator untuk OpenAI.ToolChoiceParam

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
`allowed_tools`	OpenAI.ToolChoiceAllowed
`function`	OpenAI.ToolChoiceFunction
`mcp`	OpenAI.ToolChoiceMCP
`custom`	OpenAI.ToolChoiceCustom
`apply_patch`	OpenAI.SpecificApplyPatchParam
`shell`	OpenAI.SpecificFunctionShellParam
`file_search`	OpenAI.ToolChoiceFileSearch
`web_search_preview`	OpenAI.ToolChoiceWebSearchPreview
`computer_use_preview`	OpenAI.ToolChoiceComputerUsePreview
`web_search_preview_2025_03_11`	OpenAI.ToolChoiceWebSearchPreview20250311
`image_generation`	OpenAI.ToolChoiceImageGeneration
`code_interpreter`	OpenAI.ToolChoiceCodeInterpreter

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	OpenAI.ToolChoiceParamType		Yes

OpenAI.ToolChoiceParamType

Harta benda	Nilai
Jenis	string
Nilai	`allowed_tools` `function` `mcp` `custom` `apply_patch` `shell` `file_search` `web_search_preview` `computer_use_preview` `web_search_preview_2025_03_11` `image_generation` `code_interpreter`

OpenAI.ToolChoiceWebSearchPreview

Menunjukkan bahwa model harus menggunakan alat bawaan untuk menghasilkan respons. Pelajari selengkapnya tentang alat bawaan.

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

OpenAI.ToolChoiceWebSearchPreview20250311

Menunjukkan bahwa model harus menggunakan alat bawaan untuk menghasilkan respons. Pelajari selengkapnya tentang alat bawaan.

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

OpenAI.ToolType

Harta benda Nilai

Jenis string

Nilai function
file_search
computer_use_preview
web_search
mcp
code_interpreter
image_generation
local_shell
shell
custom
web_search_preview
apply_patch
a2a_preview
bing_custom_search_preview
browser_automation_preview
fabric_dataagent_preview
sharepoint_grounding_preview
memory_search_preview
azure_ai_search
azure_function
bing_grounding
capture_structured_outputs
openapi

OpenAI.ToolsArray

Sekumpulan alat yang dapat dipanggil model ketika menghasilkan respons. Anda dapat menentukan alat mana yang akan digunakan dengan mengatur tool_choice parameter . Kami mendukung kategori alat berikut:

Alat bawaan: Alat yang disediakan oleh OpenAI yang memperluas kemampuan model, seperti pencarian web atau pencarian file . Pelajari selengkapnya tentang alat bawaan.
Alat MCP: Integrasi dengan sistem pihak ketiga melalui server MCP kustom atau konektor yang telah ditentukan sebelumnya seperti Google Drive dan SharePoint. Pelajari selengkapnya tentang MCP Tools.
Panggilan fungsi (alat kustom): Fungsi yang ditentukan oleh Anda, memungkinkan model untuk memanggil kode Anda sendiri dengan argumen dan output yang sangat ditik. Pelajari lebih lanjut fungsi pemanggilan. Anda juga dapat menggunakan alat kustom untuk memanggil kode Anda sendiri.

Array dari: OpenAI.Tool

OpenAI.TopLogProb

Probabilitas log atas token.

Nama	Tipe	Diperlukan
Byte	array OpenAI.integer	Yes
logprob	OpenAI.numeric	Yes
token	string	Yes

OpenAI.Type

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 adalah selalu atur ke `type`. Nilai yang mungkin: `type`	Yes

OpenAI.UpdateConversationBody

Nama	Tipe	Deskripsi	Diperlukan	Default
metadata	OpenAI.Metadata (dapat diberisi dengan null)	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini bisa berguna untuk menyimpan informasi tambahan tentang objek dalam terstruktur pemformatan dan pengambilan kueri untuk objek melalui API atau dasbor. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter.	Yes

OpenAI.UrlCitationBody

Kutipan untuk sumber daya web yang digunakan untuk menghasilkan respons model.

Nama	Tipe	Deskripsi	Diperlukan
end_index	OpenAI.integer		Yes
start_index	OpenAI.integer		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.VectorStoreFileAttributes

Jenis: objek

OpenAI.Verbosity

Membatasi verbositas respons model. Nilai yang lebih rendah akan menghasilkan respons yang lebih ringkas, sedangkan nilai yang lebih tinggi akan menghasilkan respons yang lebih bertele-tele. Nilai yang saat ini didukung adalah low, medium, dan high.

Harta benda	Nilai
Jenis	string
Dapat diubah ke null	Yes
Nilai	`low` `medium` `high`

OpenAI.Wait

Tindakan tunggu.

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	enum	Menentukan jenis peristiwa. Untuk tindakan tunggu, properti ini adalah selalu atur ke `wait`. Nilai yang mungkin: `wait`	Yes

OpenAI.WebSearchActionFind

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

Nama	Tipe	Deskripsi	Diperlukan
pola	string	Pola atau teks yang akan dicari di dalam halaman.	Yes
jenis	enum	Jenis tindakan. Nilai yang mungkin: `find_in_page`	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
queries	array string	Kueri pencarian.	Tidak.
kueri	string (tidak digunakan lagi)	[TIDAK DIGUNAKAN LAGI] Kueri pencarian.	Yes
Sumber	array OpenAI.WebSearchActionSearchSources	Sumber yang digunakan dalam pencarian.	Tidak.
jenis	enum	Jenis tindakan. Nilai yang mungkin: `search`	Yes

OpenAI.WebSearchActionSearchSources

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	enum	Nilai yang mungkin: `url`	Yes
URL	string		Yes

OpenAI.WebSearchApproximateLocation

Perkiraan lokasi pengguna.

Nama	Tipe	Deskripsi	Diperlukan
kota	string (dapat diakses NULL)		Tidak.
country	string (dapat diakses NULL)		Tidak.
region	string (dapat diakses NULL)		Tidak.
zona waktu	string (dapat diakses NULL)		Tidak.
jenis	enum	Jenis perkiraan lokasi. Selalu `approximate`. Nilai yang mungkin: `approximate`	Tidak.

OpenAI.WebSearchPreviewTool

Alat ini mencari hasil yang relevan di web untuk digunakan dalam respons. Pelajari alat pencarian web web lebih lanjut.

Nama	Tipe	Deskripsi	Diperlukan
ukuran_konteks_pencarian	OpenAI.SearchContextSize		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	OpenAI.ApproximateLocation (dapat diberilang)		Tidak.
└─ kota	string (dapat diakses NULL)		Tidak.
└─ negara	string (dapat diakses NULL)		Tidak.
└─ wilayah	string (dapat diakses NULL)		Tidak.
└─ zona waktu	string (dapat diakses NULL)		Tidak.
└─ jenis	enum	Jenis perkiraan lokasi. Selalu `approximate`. Nilai yang mungkin: `approximate`	Yes

OpenAI.WebSearchTool

Cari sumber yang terkait dengan prompt di Internet. Pelajari alat pencarian web web lebih lanjut.

Nama	Tipe	Deskripsi	Diperlukan
custom_search_configuration	WebSearchConfiguration	Konfigurasi penelusuran web untuk pencarian kustom bing	Tidak.
└─ instance_name	string	Nama instans konfigurasi kustom yang diberikan untuk konfigurasi.	Yes
└─ project_connection_id	string	ID koneksi Project untuk pembumian dengan pencarian kustom bing	Yes
filters	OpenAI.WebSearchToolFilters (dapat diubah ke null)		Tidak.
└─ allowed_domains	array string (nullable)		Tidak.
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` atau `web_search_2025_08_26`. Nilai yang mungkin: `web_search`	Yes
lokasi_pengguna	OpenAI.WebSearchApproximateLocation (dapat diberisi dengan null)	Perkiraan lokasi pengguna.	Tidak.
└─ kota	string (dapat diakses NULL)		Tidak.
└─ negara	string (dapat diakses NULL)		Tidak.
└─ wilayah	string (dapat diakses NULL)		Tidak.
└─ zona waktu	string (dapat diakses NULL)		Tidak.
└─ jenis	enum	Jenis perkiraan lokasi. Selalu `approximate`. Nilai yang mungkin: `approximate`	Tidak.

OpenAI.WebSearchToolFilters

Nama	Tipe	Deskripsi	Diperlukan	Default
allowed_domains	array string		Tidak.

OpenAI.integer

Jenis: bilangan bulat

Format: int64

OpenAI.numeric

Jenis: angka

Format: ganda

OpenApiAnonymousAuthDetails

Detail keamanan untuk autentikasi anonim OpenApi

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	enum	Jenis objek, yang selalu 'anonim'. Nilai yang mungkin: `anonymous`	Yes

OpenApiAuthDetails

detail autentikasi untuk OpenApiFunctionDefinition

Diskriminator untuk OpenApiAuthDetails

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
`anonymous`	OpenApiAnonymousAuthDetails
`project_connection`	OpenApiProjectConnectionAuthDetails
`managed_identity`	OpenApiManagedAuthDetails

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	OpenApiAuthType	Jenis autentikasi untuk titik akhir OpenAPI. Jenis yang diperbolehkan: - Anonim (tidak diperlukan autentikasi) - Project Koneksi (memerlukan project_connection_id ke titik akhir, seperti yang disiapkan di AI Foundry) - Managed_Identity (memerlukan audiens untuk autentikasi berbasis identitas)	Yes

OpenApiAuthType

Jenis autentikasi untuk titik akhir OpenAPI. Jenis yang diperbolehkan:

Anonim (tidak perlu otentikasi)
Project Koneksi (memerlukan project_connection_id ke titik akhir, seperti yang disiapkan di AI Foundry)
Managed_Identity (memerlukan audiens untuk autentikasi berbasis identitas)

Harta benda	Nilai
Deskripsi	Jenis autentikasi untuk titik akhir OpenAPI. Jenis yang diperbolehkan: - Anonim (tidak diperlukan autentikasi) - Project Koneksi (memerlukan project_connection_id ke titik akhir, seperti yang disiapkan di AI Foundry) - Managed_Identity (memerlukan audiens untuk autentikasi berbasis identitas)
Jenis	string
Nilai	`anonymous` `project_connection` `managed_identity`

OpenApiFunctionDefinition

Informasi definisi input untuk fungsi openapi.

Nama	Tipe	Deskripsi	Diperlukan
auth	OpenApiAuthDetails	detail autentikasi untuk OpenApiFunctionDefinition	Yes
└─ jenis	OpenApiAuthType	Jenis autentikasi, harus anonim/project_connection/managed_identity	Yes
default_params	array string	Daftar parameter spesifikasi OpenAPI yang akan menggunakan default yang disediakan pengguna	Tidak.
deskripsi	string	Deskripsi tentang apa yang dilakukan fungsi, digunakan oleh model untuk memilih kapan dan bagaimana memanggil fungsi.	Tidak.
functions	array objek	Daftar definisi fungsi yang digunakan oleh alat OpenApi	Tidak.
Nama	string	Nama fungsi yang akan dipanggil.	Yes
spec	objek	Bentuk fungsi openapi, digambarkan sebagai objek Skema JSON.	Yes

OpenApiManagedAuthDetails

Detail keamanan untuk autentikasi OpenApi managed_identity

Nama	Tipe	Deskripsi	Diperlukan
security_scheme	OpenApiManagedSecurityScheme	Skema keamanan untuk autentikasi OpenApi managed_identity	Yes
└─ audiens	string	Cakupan autentikasi untuk jenis autentikasi managed_identity	Yes
jenis	enum	Jenis objek, yang selalu 'managed_identity'. Nilai yang mungkin: `managed_identity`	Yes

OpenApiManagedSecurityScheme

Skema keamanan untuk autentikasi OpenApi managed_identity

Nama	Tipe	Deskripsi	Diperlukan	Default
audience	string	Cakupan autentikasi untuk jenis autentikasi managed_identity	Yes

OpenApiProjectConnectionAuthDetails

Detail keamanan untuk OpenApi project autentikasi koneksi

Nama	Tipe	Deskripsi	Diperlukan
security_scheme	OpenApiProjectConnectionSecurityScheme	Skema keamanan untuk autentikasi OpenApi managed_identity	Yes
└─ project_connection_id	string	ID koneksi Project untuk jenis autentikasi Project Connection	Yes
jenis	enum	Jenis objek, yang selalu 'project_connection'. Nilai yang mungkin: `project_connection`	Yes

OpenApiProjectConnectionSecurityScheme

Skema keamanan untuk autentikasi OpenApi managed_identity

Nama	Tipe	Deskripsi	Diperlukan	Default
project_connection_id	string	ID koneksi Project untuk jenis autentikasi Project Connection	Yes

OpenApiTool

Informasi definisi input untuk alat OpenAPI seperti yang digunakan untuk mengonfigurasi agen.

Nama	Tipe	Deskripsi	Diperlukan
openapi	OpenApiFunctionDefinition	Informasi definisi input untuk fungsi openapi.	Yes
└─ Autentikasi	OpenApiAuthDetails	Buka detail autentikasi API	Yes
└─ default_params	array string	Daftar parameter spesifikasi OpenAPI yang akan menggunakan default yang disediakan pengguna	Tidak.
└─ deskripsi	string	Deskripsi tentang apa yang dilakukan fungsi, digunakan oleh model untuk memilih kapan dan bagaimana memanggil fungsi.	Tidak.
└─ fungsi	array objek (baca-saja)	Daftar definisi fungsi yang digunakan oleh alat OpenApi	Tidak.
└─ 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.	Yes
└─ parameter	objek	Parameter yang diterima fungsi, dijelaskan sebagai objek Skema JSON.	Yes
└─ nama	string	Nama fungsi yang akan dipanggil.	Yes
└─ spesifikasi	objek	Bentuk fungsi openapi, digambarkan sebagai objek Skema JSON.	Yes
jenis	enum	Jenis objek, yang selalu 'openapi'. Nilai yang mungkin: `openapi`	Yes

PageOrder

Harta benda	Nilai
Jenis	string
Nilai	`asc` `desc`

PagedConnection

Koleksi halaman item Koneksi

Nama	Tipe	Deskripsi	Diperlukan	Default
NextLink	string	Tautan ke halaman item berikutnya	Tidak.
nilai	array Koneksi	Item Koneksi di halaman ini	Yes

PagedDatasetVersion

Kumpulan halaman item DatasetVersion

Nama	Tipe	Deskripsi	Diperlukan	Default
NextLink	string	Tautan ke halaman item berikutnya	Tidak.
nilai	array DatasetVersion	Item DatasetVersion di halaman ini	Yes

PagedDeployment

Kumpulan halaman item Deployment

Nama	Tipe	Deskripsi	Diperlukan	Default
NextLink	string	Tautan ke halaman item berikutnya	Tidak.
nilai	array Penyebaran	Item Penyebaran di halaman ini	Yes

PagedEvaluationRule

Kumpulan halaman item EvaluationRule

Nama	Tipe	Deskripsi	Diperlukan	Default
NextLink	string	Tautan ke halaman item berikutnya	Tidak.
nilai	array EvaluationRule	Item EvaluationRule di halaman ini	Yes

PagedEvaluationTaxonomy

Kumpulan halaman item EvaluationTaxonomy

Nama	Tipe	Deskripsi	Diperlukan	Default
NextLink	string	Tautan ke halaman item berikutnya	Tidak.
nilai	array EvaluationTaxonomy	Item EvaluationTaxonomy di halaman ini	Yes

PagedEvaluatorVersion

Kumpulan halaman item EvaluatorVersion

Nama	Tipe	Deskripsi	Diperlukan	Default
NextLink	string	Tautan ke halaman item berikutnya	Tidak.
nilai	array EvaluatorVersion	Item EvaluatorVersion di halaman ini	Yes

PagedIndex

Koleksi halaman item Indeks

Nama	Tipe	Deskripsi	Diperlukan	Default
NextLink	string	Tautan ke halaman item berikutnya	Tidak.
nilai	array Indeks	Item Indeks di halaman ini	Yes

PagedInsight

Kumpulan halaman item Wawasan

Nama	Tipe	Deskripsi	Diperlukan	Default
NextLink	string	Tautan ke halaman item berikutnya	Tidak.
nilai	array Wawasan	Item Wawasan di halaman ini	Yes

PagedRedTeam

Koleksi halaman item RedTeam

Nama	Tipe	Deskripsi	Diperlukan	Default
NextLink	string	Tautan ke halaman item berikutnya	Tidak.
nilai	array RedTeam	Item RedTeam di halaman ini	Yes

PagedSchedule

Koleksi item Jadwal halaman

Nama	Tipe	Deskripsi	Diperlukan	Default
NextLink	string	Tautan ke halaman item berikutnya	Tidak.
nilai	array Jadwal	Jadwalkan item di halaman ini	Yes

PagedScheduleRun

Kumpulan halaman item ScheduleRun

Nama	Tipe	Deskripsi	Diperlukan	Default
NextLink	string	Tautan ke halaman item berikutnya	Tidak.
nilai	array ScheduleRun	Item ScheduleRun di halaman ini	Yes

PendingUploadRequest

Mewakili permintaan upload yang tertunda.

Nama	Tipe	Deskripsi	Diperlukan
connectionName	string	Nama koneksi Akun Azure Storage yang akan digunakan untuk menghasilkan token SAS sementara	Tidak.
pendingUploadId	string	Jika PendingUploadId tidak disediakan, GUID acak akan digunakan.	Tidak.
pendingUploadType	enum	BlobReference adalah satu-satunya jenis yang didukung. Nilai yang mungkin: `BlobReference`	Yes

PendingUploadResponse

Mewakili respons untuk permintaan upload yang tertunda

Nama	Tipe	Deskripsi	Diperlukan
blobReference	BlobReference	Detail referensi blob.	Yes
└─ blobUri	string	Jalur URI blob bagi klien untuk mengunggah data. Contoh: `https://blob.windows.core.net/Container/Path`	Yes
└─ kredensial	SasCredential	Info kredensial untuk access akun storage.	Yes
└─ penyimpananAkunArmId	string	ID ARM dari akun storage yang akan digunakan.	Yes
pendingUploadId	string	ID untuk permintaan upload ini.	Yes
pendingUploadType	enum	BlobReference adalah satu-satunya jenis yang didukung Nilai yang mungkin: `BlobReference`	Yes
versi	string	Versi aset yang akan dibuat jika pengguna tidak menentukan versi saat pertama kali membuat upload	Tidak.

PromptAgentDefinition

Definisi agen prompt

Nama	Tipe	Deskripsi	Diperlukan	Default
instructions	string (dapat diakses NULL)	Pesan sistem (atau pengembang) dimasukkan ke dalam konteks model.	Tidak.
jenis	enum	Nilai yang mungkin: `prompt`	Yes
model	string	Penyebaran model yang akan digunakan untuk agen ini.	Yes
rai_config	RaiConfig	Konfigurasi untuk fitur pemfilteran konten dan keamanan AI yang Bertanggung Jawab (RAI).	Tidak.
└─ rai_policy_name	string	Nama polis RAI yang akan diterapkan.	Yes
reasoning	OpenAI.Reasoning (nullable)	model gpt-5 dan o-series saja Opsi konfigurasi untuk model penalaran.	Tidak.
└─ usaha	OpenAI.ReasoningEffort	Membatasi upaya penalaran untuk model penalaran. Nilai yang saat ini didukung adalah `none`, `minimal`, `low`, `medium`, `high`, dan `xhigh`. Mengurangi upaya penalaran dapat menghasilkan respons yang lebih cepat dan lebih sedikit token yang digunakan penalaran dalam sebuah respons. - `gpt-5.1` default ke `none`, yang tidak melakukan penalaran. Nilai penalaran yang didukung untuk `gpt-5.1` adalah `none`, `low`, `medium`, dan `high`. Panggilan alat didukung untuk semua nilai penalaran dalam gpt-5.1. - Semua model sebelum `gpt-5.1` default ke `medium` upaya penalaran, dan tidak mendukung `none`. - Model `gpt-5-pro` default ke (dan hanya mendukung) `high` upaya penalaran. - `xhigh` didukung untuk semua model setelah `gpt-5.1-codex-max`.	Tidak.
└─ menghasilkan_ringkasan	enum	Nilai yang mungkin: `auto`, `concise`, `detailed`	Tidak.
└─ ringkasan	enum	Nilai yang mungkin: `auto`, `concise`, `detailed`	Tidak.
structured_inputs	objek	Kumpulan input terstruktur yang dapat berpartisipasi dalam penggantian templat prompt atau pengikatan argumen alat.	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
kirim pesan teks	PromptAgentDefinitionTextOptions	Opsi konfigurasi untuk respons teks dari model. Dapat berupa teks biasa atau data JSON terstruktur.	Tidak.
└─ bentuk	OpenAI.TextResponseFormatConfiguration	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. Pelajari selengkapnya di Format defaultnya adalah `{ "type": "text" }` tanpa opsi tambahan. Tidak disarankan untuk model gpt-4o dan yang lebih baru:* Pengaturan ke `{ "type": "json_object" }` memungkinkan mode JSON yang lebih lama, yang memastikan pesan yang dihasilkan model adalah JSON yang valid. Menggunakan `json_schema` lebih diperuntukkan bagi model yang mendukungnya.	Tidak.
tool_choice	string atau OpenAI.ToolChoiceParam	Bagaimana model harus memilih alat (atau alat) mana yang akan digunakan saat menghasilkan respons. `tools` Lihat parameter untuk melihat cara menentukan alat mana yang dapat dipanggil model.	Tidak.
perangkat	array OpenAI.Tool	Sekumpulan alat yang dapat dipanggil model ketika menghasilkan respons. Anda dapat menentukan alat mana yang akan digunakan dengan mengatur `tool_choice` parameter .	Tidak.
top_p	nomor/angka	Alternatif untuk pengambilan sampel dengan suhu, yang disebut pengambilan sampel nukleus, di mana model mempertimbangkan hasil token dengan probabilitas top_p massa. Jadi 0,1 berarti hanya token yang termasuk dalam 10 persen teratas dari massa probabilitas% dipertimbangkan. Kami umumnya merekomendasikan untuk memodifikasi ini atau `temperature` tetapi tidak keduanya.	Tidak.	1

PromptAgentDefinitionTextOptions

Opsi konfigurasi untuk respons teks dari model. Dapat berupa teks biasa atau data JSON terstruktur.

Nama	Tipe	Deskripsi	Diperlukan	Default
format	OpenAI.TextResponseFormatConfiguration	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. Pelajari selengkapnya di Format defaultnya adalah `{ "type": "text" }` tanpa opsi tambahan. Tidak disarankan untuk model gpt-4o dan yang lebih baru:* Pengaturan ke `{ "type": "json_object" }` memungkinkan mode JSON yang lebih lama, yang memastikan pesan yang dihasilkan model adalah JSON yang valid. Menggunakan `json_schema` lebih diperuntukkan bagi model yang mendukungnya.	Tidak.

PromptBasedEvaluatorDefinition

Evaluator berbasis prompt

Nama	Tipe	Deskripsi	Diperlukan
data_schema	objek	Skema JSON (Draf 2020-12) untuk data input evaluator. Ini termasuk parameter seperti jenis, properti, diperlukan.	Tidak.
init_parameters	objek	Skema JSON (Draf 2020-12) untuk parameter input evaluator. Ini termasuk parameter seperti jenis, properti, diperlukan.	Tidak.
metrik	objek	Daftar metrik output yang dihasilkan oleh evaluator ini	Tidak.
prompt_text	string	Teks prompt yang digunakan untuk evaluasi	Yes
jenis	enum	Nilai yang mungkin: `prompt`	Yes

ProtocolVersionRecord

Pemetaan rekaman untuk protokol tunggal dan versinya.

Nama	Tipe	Deskripsi	Diperlukan	Default
protokol	AgentProtocol		Yes
versi	string	String versi untuk protokol, misalnya 'v0.1.1'.	Yes

RaiConfig

Konfigurasi untuk fitur pemfilteran konten dan keamanan AI yang Bertanggung Jawab (RAI).

Nama	Tipe	Deskripsi	Diperlukan	Default
rai_policy_name	string	Nama polis RAI yang akan diterapkan.	Yes

RecurrenceSchedule

Model jadwal pengulangan.

Diskriminator untuk RecurrenceSchedule

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
`Hourly`	HourlyRecurrenceSchedule
`Daily`	DailyRecurrenceSchedule
`Weekly`	WeeklyRecurrenceSchedule
`Monthly`	MonthlyRecurrenceSchedule

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	RecurrenceType	Jenis pengulangan.	Yes

RecurrenceTrigger

Pemicu berbasis pengulangan.

Nama	Tipe	Deskripsi	Diperlukan	Default
endTime	string	Waktu akhir untuk jadwal pengulangan dalam format ISO 8601.	Tidak.
interval	bilangan bulat	Interval untuk jadwal pengulangan.	Yes
jadwal	RecurrenceSchedule	Model jadwal pengulangan.	Yes
└─ jenis	RecurrenceType	Jenis pengulangan untuk jadwal pengulangan.	Yes
startTime	string	Waktu mulai untuk jadwal pengulangan dalam format ISO 8601.	Tidak.
zona waktu	string	Zona waktu untuk jadwal pengulangan.	Tidak.	UTC
jenis	enum	Jenis pemicu. Nilai yang mungkin: `Recurrence`	Yes

RecurrenceType

Jenis pengulangan.

Harta benda	Nilai
Deskripsi	Jenis pengulangan.
Jenis	string
Nilai	`Hourly` `Daily` `Weekly` `Monthly`

RedTeam

Detail tim merah.

Nama	Tipe	Deskripsi	Diperlukan	Default
applicationScenario	string	Skenario aplikasi untuk operasi tim merah, untuk menghasilkan serangan khusus skenario.	Tidak.
attackStrategies	array AttackStrategy	Daftar strategi serangan atau daftar strategi serangan bersarang.	Tidak.
nama tampilan	string	Nama tim merah yang berjalan.	Tidak.
id	string (baca-saja)	Pengidentifikasi lari tim merah.	Yes
numTurns	bilangan bulat	Jumlah putaran simulasi.	Tidak.
properties	objek	Properti tim merah. Tidak seperti tag, properti bersifat add-only. Setelah ditambahkan, properti tidak dapat dihapus.	Tidak.
riskCategories	array RiskCategory	Daftar kategori risiko untuk menghasilkan tujuan serangan.	Tidak.
simulationOnly	Boolean	Simulasi saja atau Simulasi + Evaluasi. Default false, jika true pemindaian menghasilkan percakapan bukan hasil evaluasi.	Tidak.	False
status	string (baca-saja)	Status tim merah. Ini diatur oleh layanan dan hanya-baca.	Tidak.
tags	objek	Tag tim merah. Tidak seperti properti, tag sepenuhnya dapat diubah.	Tidak.
sasaran	TargetConfig	Kelas abstrak untuk konfigurasi target.	Yes
└─ jenis	string	Jenis konfigurasi model.	Yes

RedTeamEvalRunDataSource

Nama	Tipe	Deskripsi	Diperlukan
item_generation_params	ItemGenerationParams	Mewakili sekumpulan parameter yang digunakan untuk mengontrol operasi pembuatan item.	Yes
└─ jenis	ItemGenerationParamsType	Jenis parameter pembuatan item yang akan digunakan.	Yes
sasaran	Target	Kelas dasar untuk target dengan dukungan diskriminator.	Yes
└─ jenis	string	Jenis target.	Yes
jenis	enum	Jenis sumber data. Selalu `azure_ai_red_team`. Nilai yang mungkin: `azure_ai_red_team`	Yes

RedTeamItemGenerationParams

Nama	Tipe	Deskripsi	Diperlukan	Default
attack_strategies	array AttackStrategy	Pengumpulan strategi serangan yang akan digunakan.	Yes
num_turns	bilangan bulat	Jumlah giliran yang diizinkan dalam permainan.	Yes	20
jenis	enum	Jenis parameter pembuatan item. Nilai yang mungkin: `red_team`	Yes

RedTeamSeedPromptsItemGenerationParams

Mewakili parameter untuk pembuatan item perintah seed tim merah.

Nama	Tipe	Deskripsi	Diperlukan	Default
attack_strategies	array AttackStrategy	Pengumpulan strategi serangan yang akan digunakan.	Yes
num_turns	bilangan bulat	Jumlah giliran yang diizinkan dalam permainan.	Yes	20
sumber	OpenAI.EvalJsonlFileContentSource		Yes
└─ konten	array OpenAI.EvalJsonlFileContentSourceContent	Isi file JSONL.	Yes
└─ jenis	enum	Jenis sumber jsonl. Selalu `file_content`. Nilai yang mungkin: `file_content`	Yes
jenis	enum	Jenis parameter pembuatan item, selalu `red_team_seed_prompts`. Nilai yang mungkin: `red_team_seed_prompts`	Yes

RedTeamTaxonomyItemGenerationParams

Mewakili parameter untuk pembuatan item taksonomi tim merah.

Nama	Tipe	Deskripsi	Diperlukan	Default
attack_strategies	array AttackStrategy	Pengumpulan strategi serangan yang akan digunakan.	Yes
num_turns	bilangan bulat	Jumlah giliran yang diizinkan dalam permainan.	Yes	20
sumber	OpenAI.EvalJsonlFileContentSource		Yes
└─ konten	array OpenAI.EvalJsonlFileContentSourceContent	Isi file JSONL.	Yes
└─ jenis	enum	Jenis sumber jsonl. Selalu `file_content`. Nilai yang mungkin: `file_content`	Yes
jenis	enum	Jenis parameter pembuatan item, selalu `red_team_taxonomy`. Nilai yang mungkin: `red_team_taxonomy`	Yes

ResponseRetrievalItemGenerationParams

Mewakili parameter untuk pembuatan item pengambilan respons.

Nama	Tipe	Deskripsi	Diperlukan
data_mapping	objek	Pemetaan dari bidang sumber ke bidang response_id, diperlukan untuk mengambil riwayat obrolan.	Yes
max_num_turns	bilangan bulat	Jumlah maksimum giliran riwayat obrolan untuk dievaluasi.	Yes
sumber	OpenAI.EvalJsonlFileContentSource atau OpenAI.EvalJsonlFileIdSource	Sumber dari mana konten JSONL dibaca.	Yes
jenis	enum	Jenis parameter pembuatan item, selalu `response_retrieval`. Nilai yang mungkin: `response_retrieval`	Yes

RiskCategory

Kategori risiko untuk tujuan serangan.

Harta benda	Nilai
Deskripsi	Kategori risiko untuk tujuan serangan.
Jenis	string
Nilai	`HateUnfairness` `Violence` `Sexual` `SelfHarm` `ProtectedMaterial` `CodeVulnerability` `UngroundedAttributes` `ProhibitedActions` `SensitiveDataLeakage` `TaskAdherence`

SASCredentials

Definisi kredensial Tanda Tangan Access Bersama (SAS)

Nama	Tipe	Deskripsi	Diperlukan	Default
SAS	string (baca-saja)	token SAS	Tidak.
jenis	enum	Jenis kredensial Nilai yang mungkin: `SAS`	Yes

SampleType

Jenis sampel yang digunakan dalam analisis.

Harta benda	Nilai
Deskripsi	Jenis sampel yang digunakan dalam analisis.
Jenis	string
Nilai	`EvaluationResultSample`

Kredensial SasSaber

Definisi Kredensial SAS

Nama	Tipe	Deskripsi	Diperlukan	Default
sasUri	string (baca-saja)	SAS uri	Yes
jenis	enum	Jenis kredensial Nilai yang mungkin: `SAS`	Yes

Jadwal

Model jadwal.

Nama	Tipe	Deskripsi	Diperlukan
deskripsi	string	Deskripsi jadwal.	Tidak.
nama tampilan	string	Nama jadwal.	Tidak.
enabled	Boolean	Mengaktifkan status jadwal.	Yes
id	string (baca-saja)	Pengidentifikasi jadwal.	Yes
properties	objek	Properti jadwal. Tidak seperti tag, properti bersifat add-only. Setelah ditambahkan, properti tidak dapat dihapus.	Tidak.
status penyediaan	ScheduleProvisioningStatus (baca-saja)	Jadwalkan status penyediaan.	Tidak.
sistem Data	objek (baca-saja)	Metadata sistem untuk sumber daya.	Yes
tags	objek	Tag jadwal. Tidak seperti properti, tag sepenuhnya dapat diubah.	Tidak.
tugas	ScheduleTask	Jadwalkan model tugas.	Yes
└─ konfigurasi	objek	Konfigurasi untuk tugas tersebut.	Tidak.
└─ jenis	ScheduleTaskType	Jenis tugas.	Yes
pemicu	Trigger	Model dasar untuk Pemicu jadwal.	Yes
└─ jenis	TriggerType	Jenis pemicu.	Yes

ScheduleProvisioningStatus

Jadwalkan status penyediaan.

Harta benda	Nilai
Deskripsi	Jadwalkan status penyediaan.
Jenis	string
Nilai	`Creating` `Updating` `Deleting` `Succeeded` `Failed`

ScheduleRun

Menjadwalkan model eksekusi.

Nama	Tipe	Deskripsi	Diperlukan
galat	string (baca-saja)	Informasi kesalahan untuk eksekusi jadwal.	Tidak.
id	string (baca-saja)	Pengidentifikasi jadwal eksekusi.	Yes
properties	objek (baca-saja)	Properti jadwal berjalan.	Yes
scheduleId	string	Pengidentifikasi jadwal.	Yes
keberhasilan	boolean (baca-saja)	Memicu status keberhasilan eksekusi jadwal.	Yes
triggerTime	string	Waktu pemicu jadwal berjalan.	Tidak.

JadwalTugas

Jadwalkan model tugas.

Diskriminator untuk ScheduleTask

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
`Evaluation`	EvaluationScheduleTask
`Insight`	InsightScheduleTask

Nama	Tipe	Deskripsi	Diperlukan	Default
konfigurasi	objek	Konfigurasi untuk tugas tersebut.	Tidak.
jenis	ScheduleTaskType	Jenis tugas.	Yes

ScheduleTaskType

Jenis tugas.

Harta benda	Nilai
Deskripsi	Jenis tugas.
Jenis	string
Nilai	`Evaluation` `Insight`

SharepointGroundingToolParameters

Parameter alat pembumian sharepoint.

Nama	Tipe	Deskripsi	Diperlukan	Default
project_connections	array ToolProjectConnection	Koneksi project yang terpasang pada alat ini. Mungkin ada maksimal 1 koneksi sumber daya yang dilampirkan ke alat.	Tidak.

SharepointPreviewTool

Informasi definisi input untuk alat sharepoint seperti yang digunakan untuk mengonfigurasi agen.

Nama	Tipe	Deskripsi	Diperlukan
sharepoint_grounding_preview	SharepointGroundingToolParameters	Parameter alat pembumian sharepoint.	Yes
└─ project_connections	array ToolProjectConnection	Koneksi project yang terpasang pada alat ini. Mungkin ada maksimal 1 koneksi sumber daya yang dilampirkan ke alat. Batasan: maxItems: 1	Tidak.
jenis	enum	Jenis objek, yang selalu 'sharepoint_grounding_preview'. Nilai yang mungkin: `sharepoint_grounding_preview`	Yes

SKU

Informasi Sku

Nama	Tipe	Deskripsi	Diperlukan
kapasitas	bilangan bulat	Kapasitas Sku	Yes
family	string	Keluarga Sku	Yes
Nama	string	Nama Sku	Yes
ukuran	string	Ukuran Sku	Yes
lapisan	string	Tingkat Sku	Yes

StructuredInputDefinition

Input terstruktur yang dapat berpartisipasi dalam penggantian templat prompt dan pengikatan argumen alat.

Nama	Tipe	Deskripsi	Diperlukan	Default
default_value		Nilai default untuk input jika tidak ada nilai run-time yang disediakan.	Tidak.
deskripsi	string	Deskripsi input yang dapat dibaca manusia.	Tidak.
required	Boolean	Apakah properti input diperlukan saat agen dipanggil.	Tidak.	False
skema	objek	Skema JSON untuk input terstruktur (opsional).	Tidak.

StructuredOutputDefinition

Output terstruktur yang dapat diproduksi oleh agen.

Nama	Tipe	Deskripsi	Diperlukan
deskripsi	string	Deskripsi output yang akan dipancarkan. Digunakan oleh model untuk menentukan kapan harus memancarkan output.	Yes
Nama	string	Nama output terstruktur.	Yes
skema	objek	Skema JSON untuk output terstruktur.	Yes
tegas	Boolean (dapat diberisi dengan null)	Apakah akan memberlakukan validasi yang ketat. Bawaan `true`.	Yes

StructuredOutputsOutputItem

Nama	Tipe	Deskripsi	Diperlukan
agent_reference	AgentReference		Tidak.
└─ nama	string	Nama agen. Batasan: maxLength: 256	Yes
└─ jenis	enum	Nilai yang mungkin: `agent_reference`	Yes
└─ versi	string	Pengidentifikasi versi agen.	Tidak.
output		Output terstruktur yang diambil selama respons.	Yes
response_id	string	Respons tempat item dibuat.	Tidak.
jenis	enum	Nilai yang mungkin: `structured_outputs`	Yes

SyntheticDataGenerationPreviewEvalRunDataSource

Mewakili sumber data untuk eksekusi evaluasi yang mengevaluasi berdasarkan data sintetis yang dihasilkan untuk tujuan pengujian.

Nama	Tipe	Deskripsi	Diperlukan
pesan_masuk	OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate		Tidak.
└─ templat	array objek atau OpenAI.EvalItem		Yes
└─ jenis	enum	Nilai yang mungkin: `template`	Yes
item_generation_params	SyntheticDataGenerationPreviewItemGenerationParams		Yes
└─ model_deployment_name	string	Nama penyebaran model yang digunakan untuk menghasilkan data sintetis.	Yes
└─ output_dataset_id	string (baca-saja)	Pengidentifikasi himpunan data output tempat data sintetis yang dihasilkan disimpan. Data yang dihasilkan adalah file jsonl dengan id kolom, kueri, dan test_description.	Tidak.
└─ output_dataset_name	string	Nama himpunan data output tempat data sintetis yang dihasilkan akan disimpan. Jika tidak disediakan, layanan menghasilkan nama himpunan data secara otomatis.	Tidak.
└─ perintah	string	Perintah yang digunakan untuk menghasilkan data sintetis. Ini adalah opsi jika target berjenis 'azure_ai_agent' dengan instruksi yang dikonfigurasi dalam agen.	Tidak.
└─ samples_count	bilangan bulat	Jumlah maksimum sampel data yang akan dihasilkan.	Yes
└─ sumber	array OpenAI.EvalJsonlFileIdSource	File sumber konten data benih opsional untuk pembuatan data.	Yes
└─ jenis	enum	Jenis parameter pembuatan item. Nilai yang mungkin: `synthetic_data_gen_preview`	Yes
sasaran	Target	Kelas dasar untuk target dengan dukungan diskriminator.	Yes
└─ jenis	string	Jenis target.	Yes
jenis	enum	Jenis sumber data, selalu `azure_ai_synthetic_data_gen_preview`. Nilai yang mungkin: `azure_ai_synthetic_data_gen_preview`	Yes

SyntheticDataGenerationPreviewItemGenerationParams

Nama	Tipe	Deskripsi	Diperlukan
model_deployment_name	string	Nama penyebaran model yang digunakan untuk menghasilkan data sintetis.	Yes
output_dataset_id	string (baca-saja)	Pengidentifikasi himpunan data output tempat data sintetis yang dihasilkan disimpan. Data yang dihasilkan adalah file jsonl dengan id kolom, kueri, dan test_description.	Tidak.
output_dataset_name	string	Nama himpunan data output tempat data sintetis yang dihasilkan akan disimpan. Jika tidak disediakan, layanan menghasilkan nama himpunan data secara otomatis.	Tidak.
minta	string	Perintah yang digunakan untuk menghasilkan data sintetis. Ini adalah opsi jika target berjenis 'azure_ai_agent' dengan instruksi yang dikonfigurasi dalam agen.	Tidak.
samples_count	bilangan bulat	Jumlah maksimum sampel data yang akan dihasilkan.	Yes
Sumber	array OpenAI.EvalJsonlFileIdSource	File sumber konten data benih opsional untuk pembuatan data.	Yes
jenis	enum	Jenis parameter pembuatan item. Nilai yang mungkin: `synthetic_data_gen_preview`	Yes

Target

Kelas dasar untuk target dengan dukungan diskriminator.

Diskriminator untuk Target

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
`azure_ai_model`	AzureAIModelTarget
`azure_ai_agent`	AzureAIAgentTarget

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	string	Jenis target.	Yes

TargetCompletionEvalRunDataSource

Mewakili sumber data untuk konfigurasi evaluasi penyelesaian berbasis target.

Nama	Tipe	Deskripsi	Diperlukan
pesan_masuk	OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference		Tidak.
└─ referensi_item	string		Yes
└─ jenis	enum	Nilai yang mungkin: `item_reference`	Yes
sumber	OpenAI.EvalJsonlFileContentSource atau OpenAI.EvalJsonlFileIdSource	Konfigurasi sumber untuk data sebaris atau file.	Yes
sasaran	Target	Kelas dasar untuk target dengan dukungan diskriminator.	Yes
└─ jenis	string	Jenis target.	Yes
jenis	enum	Jenis sumber data, selalu `azure_ai_target_completions`. Nilai yang mungkin: `azure_ai_target_completions`	Yes

TargetConfig

Kelas abstrak untuk konfigurasi target.

Diskriminator untuk TargetConfig

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
`AzureOpenAIModel`	AzureOpenAIModelConfiguration

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	string	Jenis konfigurasi model.	Yes

TargetUpdate

Kelas dasar untuk target dengan dukungan diskriminator.

Diskriminator untuk TargetUpdate

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
`azure_ai_model`	AzureAIModelTargetUpdate
`azure_ai_agent`	AzureAIAgentTargetUpdate

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	string	Jenis target.	Yes

TaxonomyCategory

Definisi kategori taksonomi.

Nama	Tipe	Deskripsi	Diperlukan
deskripsi	string	Deskripsi kategori taksonomi.	Tidak.
id	string	Pengidentifikasi unik dari kategori taksonomi.	Yes
Nama	string	Nama kategori taksonomi.	Yes
properties	objek	Properti tambahan untuk kategori taksonomi.	Tidak.
riskCategory	RiskCategory	Kategori risiko untuk tujuan serangan.	Yes
Subkategori	array TaksonomiSubCategory	Daftar sub kategori taksonomi.	Yes

TaksonomiSubCategory

Definisi sub-kategori taksonomi.

Nama	Tipe	Deskripsi	Diperlukan
deskripsi	string	Deskripsi sub-kategori taksonomi.	Tidak.
enabled	Boolean	Daftar item taksonomi di bawah sub-kategori ini.	Yes
id	string	Pengidentifikasi unik dari sub-kategori taksonomi.	Yes
Nama	string	Nama sub-kategori taksonomi.	Yes
properties	objek	Properti tambahan untuk sub-kategori taksonomi.	Tidak.

ToolDescription

Deskripsi alat yang dapat digunakan oleh agen.

Nama	Tipe	Deskripsi	Diperlukan	Default
deskripsi	string	Deskripsi singkat tentang tujuan alat ini.	Tidak.
Nama	string	Nama alat.	Tidak.

ToolProjectConnection

Sumber daya koneksi project.

Nama	Tipe	Deskripsi	Diperlukan	Default
project_connection_id	string	Koneksi project dalam ToolProjectConnectionList yang dilampirkan ke alat ini.	Yes

TracesPreviewEvalRunDataSource

Mewakili sumber data untuk eksekusi evaluasi yang beroperasi melalui jejak Agen yang disimpan di Application Insights.

Nama	Tipe	Deskripsi	Diperlukan	Default
agent_id	string	ID agen yang digunakan untuk memfilter jejak untuk evaluasi.	Tidak.
agent_name	string	Nama agen yang digunakan untuk memfilter jejak untuk evaluasi.	Tidak.
waktu_selesai	bilangan bulat	Tanda waktu Unix (dalam detik) menandai akhir jendela kueri pelacakan. Default ke waktu saat ini.	Tidak.
ingestion_delay_seconds	bilangan bulat	Penundaan untuk mengajukan penyerapan saat mengkueri jejak.	Tidak.	300
lookback_hours	bilangan bulat	Jendela lookback (dalam jam) diterapkan saat mengambil jejak dari Application Insights. Untuk evaluasi terjadwal, ini disimpulkan dari interval pengulangan.	Tidak.	168
max_traces	bilangan bulat	Batas pengambilan sampel diterapkan pada jejak yang diambil untuk evaluasi.	Tidak.	1000
trace_ids	array string	Pengumpulan pengidentifikasi jejak Agen yang harus dievaluasi.	Tidak.
jenis	enum	Jenis sumber data, selalu `azure_ai_traces_preview`. Nilai yang mungkin: `azure_ai_traces_preview`	Yes

TreatmentEffectType

Jenis Efek Pengobatan.

Harta benda	Nilai
Deskripsi	Jenis Efek Pengobatan.
Jenis	string
Nilai	`TooFewSamples` `Inconclusive` `Changed` `Improved` `Degraded`

Pemicu

Model dasar untuk Pemicu jadwal.

Diskriminator untuk Pemicu

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
`Cron`	CronTrigger
`Recurrence`	RecurrenceTrigger
`OneTime`	OneTimeTrigger

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	TriggerType	Jenis pemicu.	Yes

TriggerType

Jenis pemicu.

Harta benda	Nilai
Deskripsi	Jenis pemicu.
Jenis	string
Nilai	`Cron` `Recurrence` `OneTime`

UpdateAgentFromManifestRequest

Nama	Tipe	Deskripsi	Diperlukan
deskripsi	string	Deskripsi agen yang dapat dibaca manusia. Batasan: maxLength: 512	Tidak.
manifest_id	string	ID manifes untuk mengimpor versi agen.	Yes
metadata	objek	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini bisa berguna untuk menyimpan informasi tambahan tentang objek dalam terstruktur pemformatan dan pengambilan kueri untuk objek melalui API atau dasbor. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter.	Tidak.
parameter_values	objek	Input ke manifes yang akan menghasilkan Agen yang sepenuhnya terwujud.	Yes

UpdateAgentRequest

Nama	Tipe	Deskripsi	Diperlukan
definisi	AgentDefinition		Yes
└─ jenis	AgentKind		Yes
└─ rai_config	RaiConfig	Konfigurasi untuk fitur pemfilteran konten dan keamanan AI yang Bertanggung Jawab (RAI).	Tidak.
deskripsi	string	Deskripsi agen yang dapat dibaca manusia. Batasan: maxLength: 512	Tidak.
metadata	objek	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini bisa berguna untuk menyimpan informasi tambahan tentang objek dalam terstruktur pemformatan dan pengambilan kueri untuk objek melalui API atau dasbor. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter.	Tidak.

UpdateEvalParametersBody

Nama	Tipe	Deskripsi	Diperlukan
metadata	OpenAI.Metadata (dapat diberisi dengan null)	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini bisa berguna untuk menyimpan informasi tambahan tentang objek dalam terstruktur pemformatan dan pengambilan kueri untuk 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.
properties	objek	Set pasangan kunci-nilai 16 yang tidak dapat diubah yang dapat dilampirkan ke objek untuk menyimpan informasi tambahan. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter.	Tidak.

UserProfileMemoryItem

Item memori yang secara khusus berisi informasi profil pengguna yang diekstrak dari percakapan, seperti preferensi, minat, dan detail pribadi.

Nama	Tipe	Deskripsi	Diperlukan
isi	string	Isi memori.	Yes
jenis	enum	Jenis item memori. Nilai yang mungkin: `user_profile`	Yes
memory_id	string	ID unik item memori.	Yes
cakupan	string	Namespace yang secara logis mengelompokkan dan mengisolasi memori, seperti ID pengguna.	Yes
updated_at	bilangan bulat	Waktu pembaruan terakhir item memori.	Yes

WebSearchConfiguration

Konfigurasi penelusuran web untuk pencarian kustom bing

Nama	Tipe	Deskripsi	Diperlukan	Default
instance_name	string	Nama instans konfigurasi kustom yang diberikan untuk konfigurasi.	Yes
project_connection_id	string	ID koneksi Project untuk pembumian dengan pencarian kustom bing	Yes

WeeklyRecurrenceSchedule

Jadwal pengulangan mingguan.

Nama	Tipe	Deskripsi	Diperlukan	Default
daysOfWeek	array DayOfWeek	Hari-hari dalam seminggu untuk jadwal pengulangan.	Yes
jenis	enum	Jenis pengulangan mingguan. Nilai yang mungkin: `Weekly`	Yes

WorkflowActionOutputItem

Nama	Tipe	Deskripsi	Diperlukan
action_id	string	Pengidentifikasi unik untuk tindakan tersebut.	Yes
agent_reference	AgentReference		Tidak.
└─ nama	string	Nama agen. Batasan: maxLength: 256	Yes
└─ jenis	enum	Nilai yang mungkin: `agent_reference`	Yes
└─ versi	string	Pengidentifikasi versi agen.	Tidak.
jenis	string	Jenis tindakan CSDL (misalnya, 'SetVariable', 'InvokeAzureAgent').	Yes
parent_action_id	string	ID tindakan induk jika ini adalah tindakan berlapis.	Tidak.
previous_action_id	string	ID tindakan sebelumnya jika tindakan ini mengikuti tindakan lain.	Tidak.
response_id	string	Respons tempat item dibuat.	Tidak.
status	enum	Status tindakan (misalnya, 'in_progress', 'completed', 'failed', 'cancelled'). Nilai yang mungkin: `completed`, `failed`, `in_progress`, `cancelled`	Yes
jenis	enum	Nilai yang mungkin: `workflow_action`	Yes

WorkflowAgentDefinition

Definisi agen alur kerja.

Nama	Tipe	Deskripsi	Diperlukan
jenis	enum	Nilai yang mungkin: `workflow`	Yes
rai_config	RaiConfig	Konfigurasi untuk fitur pemfilteran konten dan keamanan AI yang Bertanggung Jawab (RAI).	Tidak.
└─ rai_policy_name	string	Nama polis RAI yang akan diterapkan.	Yes
alur kerja	string	Definisi alur kerja CSDL YAML.	Tidak.

bilangan bulat

Jenis: bilangan bulat

Format: int64

Last updated on 2026-02-28

Bagikan melalui

Microsoft Foundry

Authentication

Agents

Agen - buat agen

Parameter URI

Header Permohonan

Isi Permintaan

Responses

Agen - daftar agen

Parameter URI

Responses

Agen - dapatkan agen

Parameter URI

Responses

Agen - agen pembaruan

Parameter URI

Header Permohonan

Isi Permintaan

Responses

Agen - hapus agen

Parameter URI

Responses

Agen - memperbarui agen dari manifes

Parameter URI

Isi Permintaan

Responses

Agen - membuat versi agen

Parameter URI

Header Permohonan

Isi Permintaan

Responses

Agen - mencantumkan versi agen

Parameter URI

Responses

Agen - dapatkan versi agen

Parameter URI

Responses

Agen - hapus versi agen

Parameter URI

Responses

Agen - membuat versi agen dari manifes

Parameter URI

Isi Permintaan

Responses

Agen - membuat agen dari manifes

Parameter URI

Isi Permintaan

Responses

Kontainer Agen

Kontainer agen - mencantumkan operasi kontainer agen

Parameter URI

Header Permohonan

Responses

Kontainer agen - dapatkan operasi kontainer agen

Parameter URI

Header Permohonan

Responses

Kontainer agen - dapatkan kontainer agen

Parameter URI

Header Permohonan

Responses

Kontainer agen - mencantumkan operasi kontainer versi agen

Parameter URI

Header Permohonan

Responses

Kontainer agen - hapus kontainer agen

Parameter URI

Header Permohonan

Responses

Kontainer agen - log kontainer agen aliran

Parameter URI

Header Permohonan

Responses

Kontainer agen - mulai kontainer agen

Parameter URI

Header Permohonan

Isi Permintaan

Responses

Kontainer agen - hentikan kontainer agen