Microsoft Foundry

API Sürümü: v1

Authentication

Akış: örtük

Yetkilendirme URL'si:https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Kapsam:

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

Agents

Aracılar - aracı oluşturma

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

Aracıyı oluşturur.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

İsim	Gerekli	Türü	Description
Foundry-Features	Yanlış	String Olası değerler: ContainerAgents=V1Preview, HostedAgents=V1Preview, WorkflowAgents=V1Preview	Önizleme işlemleri kullanılırken veya kalıcı önizleme kaynaklarını değiştirirken bir özellik bayrağı kabul etmek gerekir.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
tanım	AgentDefinition		Evet
└─ tür	AgentKind		Evet
└─ rai_config	RaiConfig	Sorumlu Yapay Zeka (RAI) içerik filtreleme ve güvenlik özellikleri için yapılandırma.	Hayı
açıklama	String	Aracının insan tarafından okunabilir bir açıklaması. Kısıtlamalar: maxLength: 512	Hayı
metadata	nesne	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Hayı
name	String	Aracıyı tanımlayan benzersiz ad. Ad, aracıyı almak/güncellemek/silmek için kullanılabilir. - Alfasayısal karakterlerle başlayıp bitmelidir, - Ortada kısa çizgi içerebilir - 63 karakteri aşmamalıdır. Kısıtlamalar: maxLength: 63	Evet

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	AgentObject

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Aracılar - liste aracıları

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

Tüm müşteri temsilcilerinin listesini döndürür.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
tür	soru	Hayı	String Olası değerler: prompt, hosted, container_app, workflow	Ajanları türlerine göre filtreleyin. Sağlanmazsa, tüm temsilciler iade edilir.
limit	soru	Hayı	tamsayı	Döndürülecek nesne sayısıyla ilgili bir sınır. Sınır 1 ile 100 arasında olabilir ve varsayılan değer 20'dir.
order	soru	Hayı	String Olası değerler: asc, desc	Düzeni nesnelerin zaman damgasına göre created_at sıralayın. asc artan sırayla ve desc azalan sırayla
after	soru	Hayı	String	Sayfalandırmada kullanılacak bir imleç. after , listedeki yerinizi tanımlayan bir nesne kimliğidir. Örneğin, bir liste isteğinde bulunur ve obj_foo ile biten 100 nesne alırsanız sonraki çağrı, listenin sonraki sayfasını getirmek için after=obj_foo içerebilir.
önce	soru	Hayı	String	Sayfalandırmada kullanılacak bir imleç. before , listedeki yerinizi tanımlayan bir nesne kimliğidir. Örneğin, bir liste isteğinde bulunur ve obj_foo ile biten 100 nesne alırsanız sonraki çağrı, listenin önceki sayfasını getirmek için before=obj_foo içerebilir.
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	nesne	İstenen öğe listesi için yanıt verileri.

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Aracılar - aracı alma

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

Aracıyı alır.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
agent_name	path	Evet	String	Alınacak aracının adı.
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	AgentObject

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Aracılar - aracıyı güncelleştirme

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

Aracı tanımında herhangi bir değişiklik olması durumunda yeni bir sürüm ekleyerek aracıyı güncelleştirir. Değişiklik yoksa mevcut aracı sürümünü döndürür.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
agent_name	path	Evet	String	Alınacak aracının adı.
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

İsim	Gerekli	Türü	Description
Foundry-Features	Yanlış	String Olası değerler: ContainerAgents=V1Preview, HostedAgents=V1Preview, WorkflowAgents=V1Preview	Önizleme işlemleri kullanılırken veya kalıcı önizleme kaynaklarını değiştirirken bir özellik bayrağı kabul etmek gerekir.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
tanım	AgentDefinition		Evet
└─ tür	AgentKind		Evet
└─ rai_config	RaiConfig	Sorumlu Yapay Zeka (RAI) içerik filtreleme ve güvenlik özellikleri için yapılandırma.	Hayı
açıklama	String	Aracının insan tarafından okunabilir bir açıklaması. Kısıtlamalar: maxLength: 512	Hayı
metadata	nesne	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Hayı

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	AgentObject

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Aracılar - aracıyı silme

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

Aracıyı siler.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
agent_name	path	Evet	String	Silinecek aracının adı.
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	DeleteAgentResponse

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Aracılar - bildirimden aracıyı güncelleştirme

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

Aracı tanımında herhangi bir değişiklik varsa yeni bir sürüm ekleyerek bir bildirimden aracıyı güncelleştirir. Değişiklik yoksa mevcut aracı sürümünü döndürür.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
agent_name	path	Evet	String	Güncelleştirilecek aracının adı.
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
açıklama	String	Aracının insan tarafından okunabilir bir açıklaması. Kısıtlamalar: maxLength: 512	Hayı
manifest_id	String	Aracı sürümünü içeri aktaracak bildirim kimliği.	Evet
metadata	nesne	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Hayı
parameter_values	nesne	Bildirime yapılan ve tam olarak gerçekleştirilmiş bir Aracı ile sonuçlanacak girişler.	Evet

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	AgentObject

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Aracılar - aracı sürümü oluşturma

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

Yeni bir aracı sürümü oluşturun.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
agent_name	path	Evet	String	Aracıyı tanımlayan benzersiz ad. Ad, aracıyı almak/güncellemek/silmek için kullanılabilir. - Alfasayısal karakterlerle başlayıp bitmelidir, - Ortada kısa çizgi içerebilir - 63 karakteri aşmamalıdır.
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

İsim	Gerekli	Türü	Description
Foundry-Features	Yanlış	String Olası değerler: ContainerAgents=V1Preview, HostedAgents=V1Preview, WorkflowAgents=V1Preview	Önizleme işlemleri kullanılırken veya kalıcı önizleme kaynaklarını değiştirirken bir özellik bayrağı kabul etmek gerekir.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
tanım	AgentDefinition		Evet
└─ tür	AgentKind		Evet
└─ rai_config	RaiConfig	Sorumlu Yapay Zeka (RAI) içerik filtreleme ve güvenlik özellikleri için yapılandırma.	Hayı
açıklama	String	Aracının insan tarafından okunabilir bir açıklaması. Kısıtlamalar: maxLength: 512	Hayı
metadata	nesne	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Hayı

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	AgentVersionObject

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Aracılar - aracı sürümlerini listeleme

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

Bir aracının sürümlerinin listesini döndürür.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
agent_name	path	Evet	String	Sürümleri alınacak aracının adı.
limit	soru	Hayı	tamsayı	Döndürülecek nesne sayısıyla ilgili bir sınır. Sınır 1 ile 100 arasında olabilir ve varsayılan değer 20'dir.
order	soru	Hayı	String Olası değerler: asc, desc	Düzeni nesnelerin zaman damgasına göre created_at sıralayın. asc artan sırayla ve desc azalan sırayla
after	soru	Hayı	String	Sayfalandırmada kullanılacak bir imleç. after , listedeki yerinizi tanımlayan bir nesne kimliğidir. Örneğin, bir liste isteğinde bulunur ve obj_foo ile biten 100 nesne alırsanız sonraki çağrı, listenin sonraki sayfasını getirmek için after=obj_foo içerebilir.
önce	soru	Hayı	String	Sayfalandırmada kullanılacak bir imleç. before , listedeki yerinizi tanımlayan bir nesne kimliğidir. Örneğin, bir liste isteğinde bulunur ve obj_foo ile biten 100 nesne alırsanız sonraki çağrı, listenin önceki sayfasını getirmek için before=obj_foo içerebilir.
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	nesne	İstenen öğe listesi için yanıt verileri.

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Aracılar - aracı sürümünü alma

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

Bir aracının belirli bir sürümünü alır.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
agent_name	path	Evet	String	Alınacak aracının adı.
agent_version	path	Evet	String	Alınacak aracı sürümü.
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	AgentVersionObject

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Aracılar - aracı sürümünü silme

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

Bir aracının belirli bir sürümünü siler.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
agent_name	path	Evet	String	Silinecek aracının adı.
agent_version	path	Evet	String	Silinecek aracı sürümü
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	DeleteAgentVersionResponse

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Aracılar - bildirimden aracı sürümü oluşturma

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

Bildirimden yeni bir aracı sürümü oluşturun.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
agent_name	path	Evet	String	Aracıyı tanımlayan benzersiz ad. Ad, aracıyı almak/güncellemek/silmek için kullanılabilir. - Alfasayısal karakterlerle başlayıp bitmelidir, - Ortada kısa çizgi içerebilir - 63 karakteri aşmamalıdır.
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
açıklama	String	Aracının insan tarafından okunabilir bir açıklaması. Kısıtlamalar: maxLength: 512	Hayı
manifest_id	String	Aracı sürümünü içeri aktaracak bildirim kimliği.	Evet
metadata	nesne	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Hayı
parameter_values	nesne	Bildirime yapılan ve tam olarak gerçekleştirilmiş bir Aracı ile sonuçlanacak girişler.	Evet

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	AgentVersionObject

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Aracılar - bildirimden aracı oluşturma

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

Bildirimden bir aracı oluşturur.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
açıklama	String	Aracının insan tarafından okunabilir bir açıklaması. Kısıtlamalar: maxLength: 512	Hayı
manifest_id	String	Aracı sürümünü içeri aktaracak bildirim kimliği.	Evet
metadata	nesne	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Hayı
name	String	Aracıyı tanımlayan benzersiz ad. Ad, aracıyı almak/güncellemek/silmek için kullanılabilir. - Alfasayısal karakterlerle başlayıp bitmelidir, - Ortada kısa çizgi içerebilir - 63 karakteri aşmamalıdır. Kısıtlamalar: maxLength: 63	Evet
parameter_values	nesne	Bildirime yapılan ve tam olarak gerçekleştirilmiş bir Aracı ile sonuçlanacak girişler.	Evet

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	AgentObject

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Aracı Kapsayıcıları

Aracı kapsayıcıları - aracı kapsayıcı işlemlerini listeleme

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

Bir aracı için kapsayıcı işlemlerini listeleme.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
agent_name	path	Evet	String	Aracının adı.
limit	soru	Hayı	tamsayı	Döndürülecek nesne sayısıyla ilgili bir sınır. Sınır 1 ile 100 arasında olabilir ve varsayılan değer 20'dir.
order	soru	Hayı	String Olası değerler: asc, desc	Düzeni nesnelerin zaman damgasına göre created_at sıralayın. asc artan sırayla ve desc azalan sırayla
after	soru	Hayı	String	Sayfalandırmada kullanılacak bir imleç. after , listedeki yerinizi tanımlayan bir nesne kimliğidir. Örneğin, bir liste isteğinde bulunur ve obj_foo ile biten 100 nesne alırsanız sonraki çağrı, listenin sonraki sayfasını getirmek için after=obj_foo içerebilir.
önce	soru	Hayı	String	Sayfalandırmada kullanılacak bir imleç. before , listedeki yerinizi tanımlayan bir nesne kimliğidir. Örneğin, bir liste isteğinde bulunur ve obj_foo ile biten 100 nesne alırsanız sonraki çağrı, listenin önceki sayfasını getirmek için before=obj_foo içerebilir.
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

İsim	Gerekli	Türü	Description
Foundry-Features	Yanlış	String Olası değerler: ContainerAgents=V1Preview	Önizleme işlemleri kullanılırken veya kalıcı önizleme kaynaklarını değiştirirken bir özellik bayrağı kabul etmek gerekir.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	nesne	İstenen öğe listesi için yanıt verileri.

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Aracı kapsayıcıları - aracı kapsayıcısı işlemini alma

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

Bir aracı için kapsayıcı işleminin durumunu alın.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
agent_name	path	Evet	String	Aracının adı.
operation_id	path	Evet	String	İşlem kimliği.
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

İsim	Gerekli	Türü	Description
Foundry-Features	Yanlış	String Olası değerler: ContainerAgents=V1Preview	Önizleme işlemleri kullanılırken veya kalıcı önizleme kaynaklarını değiştirirken bir özellik bayrağı kabul etmek gerekir.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	AgentContainerOperationObject

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Aracı kapsayıcıları - aracı kapsayıcısı alma

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

Aracının belirli bir sürümü için kapsayıcı alma.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
agent_name	path	Evet	String	Aracının adı.
agent_version	path	Evet	String	Aracının sürümü.
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

İsim	Gerekli	Türü	Description
Foundry-Features	Yanlış	String Olası değerler: ContainerAgents=V1Preview	Önizleme işlemleri kullanılırken veya kalıcı önizleme kaynaklarını değiştirirken bir özellik bayrağı kabul etmek gerekir.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	AgentContainerObject

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Aracı kapsayıcıları - aracı sürümü kapsayıcı işlemlerini listeleme

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

Bir aracının belirli bir sürümü için kapsayıcı işlemlerini listeleme.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
agent_name	path	Evet	String	Aracının adı.
agent_version	path	Evet	String	Aracının sürümü.
limit	soru	Hayı	tamsayı	Döndürülecek nesne sayısıyla ilgili bir sınır. Sınır 1 ile 100 arasında olabilir ve varsayılan değer 20'dir.
order	soru	Hayı	String Olası değerler: asc, desc	Düzeni nesnelerin zaman damgasına göre created_at sıralayın. asc artan sırayla ve desc azalan sırayla
after	soru	Hayı	String	Sayfalandırmada kullanılacak bir imleç. after , listedeki yerinizi tanımlayan bir nesne kimliğidir. Örneğin, bir liste isteğinde bulunur ve obj_foo ile biten 100 nesne alırsanız sonraki çağrı, listenin sonraki sayfasını getirmek için after=obj_foo içerebilir.
önce	soru	Hayı	String	Sayfalandırmada kullanılacak bir imleç. before , listedeki yerinizi tanımlayan bir nesne kimliğidir. Örneğin, bir liste isteğinde bulunur ve obj_foo ile biten 100 nesne alırsanız sonraki çağrı, listenin önceki sayfasını getirmek için before=obj_foo içerebilir.
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

İsim	Gerekli	Türü	Description
Foundry-Features	Yanlış	String Olası değerler: ContainerAgents=V1Preview	Önizleme işlemleri kullanılırken veya kalıcı önizleme kaynaklarını değiştirirken bir özellik bayrağı kabul etmek gerekir.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	nesne	İstenen öğe listesi için yanıt verileri.

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Aracı kapsayıcıları - aracı kapsayıcısı silme

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

Bir aracının belirli bir sürümü için kapsayıcıyı silin. Kapsayıcı yoksa, işlem no-opolur. İşlem uzun süre çalışan bir işlemdir. Azure REST API'lerinde uzun süreli işlemler için tasarım yönergelerine uymak. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
agent_name	path	Evet	String	Aracının adı.
agent_version	path	Evet	String	Aracının sürümü.
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

İsim	Gerekli	Türü	Description
Foundry-Features	Yanlış	String Olası değerler: ContainerAgents=V1Preview	Önizleme işlemleri kullanılırken veya kalıcı önizleme kaynaklarını değiştirirken bir özellik bayrağı kabul etmek gerekir.

Yanıtlar

Durum Kodu: 202

Açıklama: İstek işleme için kabul edildi, ancak işleme henüz tamamlanmadı.

İçerik Türü	Türü	Açıklama
uygulama/json	AgentContainerOperationObject

Yanıt Üst Bilgileri:

Başlık	Türü	Description
İşlem Konumu	String

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Aracı kapsayıcıları - akış aracısı kapsayıcı günlükleri

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

Konteyner log girişi, konteynerden metin parçaları olarak akış yapar. Her parça, akış yapılan konteyner logu türüne bağlı olarak ya düz metin log satırı ya da JSON formatlı log girişi olabilecek bir UTF-8 dizisidir. İstemciler her parçayı opak metin olarak ele almalı ve gerekirse loglama gereksinimlerine göre JSON olarak ayrıştırmaya çalışmalı.

Sistem kayıtları için format JSON'dur ve şu yapıya sahiptir: {"TimeStamp":"2025-12-15T16:51:33Z","Type":"Normal","ContainerAppName":null,"RevisionName":null,"ReplicaName":null,"Msg":"Olay toplayıcısına bağlanıyor...","Reason":"StartingGettingEvents","EventSource":"ContainerAppController","Count":1} {"TimeStamp":"2025-12-15T16:51:34Z","Type":"Normal","ContainerAppName":null,"RevisionName":null,"ReplicaName":null,"Msg":"Başarıyla olaylara bağlandı sunucu","Reason":"ConnectedToEventsServer","EventSource":"ContainerAppController","Count":1}

Konsol logları için format konteynerin stdout/stderr tarafından yayımlanan düz metindir. 2025-12-15T08:43:48.72656 Konteynere bağlanıyor 'ajan-konteyner'... 2025-12-15T08:43:48.75451 Konteynere Başarıyla Bağlandı: 'ajan-konteyner' [Revizyon: 'je90fe655aa742ef9a188b9fd14d6764--7tca06b', Replika: 'je90fe655aa742ef9a188b9fd14d6764--7tca06b-6898b9c89f-mpkjc'] 2025-12-15T08:33:59.0671054Z stdout F BILGI: 127.0.0.1:42588 - "GET /readyiness HTTP/1.1" 200 OK 2025-12-15T08:34:29.0649033Z stdout F BILGI: 127.0.0.1:60246 - "GET /readyiness HTTP/1.1" 200 OK 2025-12-15T08:34:59.0644467Z stdout F BILGI: 127.0.0.1:43994 - "GET /readyiness HTTP/1.1" 200 OK

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
agent_name	path	Evet	String	Aracının adı.
agent_version	path	Evet	String	Aracının sürümü.
tür	soru	Hayı	String Olası değerler: console, system	konsol konteyner stdout/stderr döndürür, sistem konteyner uygulaması olay akışını döndürür. Konsola varsayılan
replica_name	soru	Hayı	String	Eksik bırakıldığında, sunucu konsol günlükleri için ilk replikayı seçer. Belirli bir çoğaltmayı hedeflemek için gereklidir.
kuyruk	soru	Hayı	tamsayı	Döndürülen sondaki satır sayısı. 1-300'e kadar zorunlu tutuldu. Varsayılan değer: 20
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

İsim	Gerekli	Türü	Description
Foundry-Features	Yanlış	String Olası değerler: ContainerAgents=V1Preview	Önizleme işlemleri kullanılırken veya kalıcı önizleme kaynaklarını değiştirirken bir özellik bayrağı kabul etmek gerekir.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Aracı kapsayıcıları - aracı kapsayıcısı başlatma

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

Bir aracının belirli bir sürümü için kapsayıcı başlatın. Kapsayıcı zaten çalışıyorsa, işlem no-opolur. İşlem uzun süre çalışan bir işlemdir. Azure REST API'lerinde uzun süreli işlemler için tasarım yönergelerine uymak. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
agent_name	path	Evet	String	Aracının adı.
agent_version	path	Evet	String	Aracının sürümü.
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

İsim	Gerekli	Türü	Description
Foundry-Features	Yanlış	String Olası değerler: ContainerAgents=V1Preview	Önizleme işlemleri kullanılırken veya kalıcı önizleme kaynaklarını değiştirirken bir özellik bayrağı kabul etmek gerekir.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
max_replicas	tamsayı	En fazla çoğaltma sayısı. Varsayılan değer 1'tir.	Hayı	1
min_replicas	tamsayı	En az çoğaltma sayısı. Varsayılan değer 1'tir.	Hayı	1

Yanıtlar

Durum Kodu: 202

Açıklama: İstek işleme için kabul edildi, ancak işleme henüz tamamlanmadı.

İçerik Türü	Türü	Açıklama
uygulama/json	AgentContainerOperationObject

Yanıt Üst Bilgileri:

Başlık	Türü	Description
İşlem Konumu	String

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Aracı kapsayıcıları - aracı kapsayıcısını durdurma

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

Aracının belirli bir sürümü için kapsayıcıyı durdurun. Kapsayıcı çalışmıyorsa veya zaten durdurulmuşsa, işlem no-opolur. İşlem uzun süre çalışan bir işlemdir. Azure REST API'lerinde uzun süreli işlemler için tasarım yönergelerine uymak. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
agent_name	path	Evet	String	Aracının adı.
agent_version	path	Evet	String	Aracının sürümü.
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

İsim	Gerekli	Türü	Description
Foundry-Features	Yanlış	String Olası değerler: ContainerAgents=V1Preview	Önizleme işlemleri kullanılırken veya kalıcı önizleme kaynaklarını değiştirirken bir özellik bayrağı kabul etmek gerekir.

Yanıtlar

Durum Kodu: 202

Açıklama: İstek işleme için kabul edildi, ancak işleme henüz tamamlanmadı.

İçerik Türü	Türü	Açıklama
uygulama/json	AgentContainerOperationObject

Yanıt Üst Bilgileri:

Başlık	Türü	Description
İşlem Konumu	String

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Aracı kapsayıcıları - aracı kapsayıcısı güncelleştirme

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

Bir aracının belirli bir sürümü için kapsayıcıyı güncelleştirme. Kapsayıcı çalışmıyorsa, işlem no-opolur. İşlem uzun süre çalışan bir işlemdir. Azure REST API'lerinde uzun süreli işlemler için tasarım yönergelerine uymak. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
agent_name	path	Evet	String	Aracının adı.
agent_version	path	Evet	String	Aracının sürümü.
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

İsim	Gerekli	Türü	Description
Foundry-Features	Yanlış	String Olası değerler: ContainerAgents=V1Preview	Önizleme işlemleri kullanılırken veya kalıcı önizleme kaynaklarını değiştirirken bir özellik bayrağı kabul etmek gerekir.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
max_replicas	tamsayı	En fazla çoğaltma sayısı.	Hayı
min_replicas	tamsayı	En az çoğaltma sayısı.	Hayı

Yanıtlar

Durum Kodu: 202

Açıklama: İstek işleme için kabul edildi, ancak işleme henüz tamamlanmadı.

İçerik Türü	Türü	Açıklama
uygulama/json	AgentContainerOperationObject

Yanıt Üst Bilgileri:

Başlık	Türü	Description
İşlem Konumu	String

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Bağlantılar

Bağlantılar - liste

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

Bağlantı bilgilerini doldurmadan proje'deki tüm bağlantıları listeleyin

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
connectionType	soru	Hayı	String Olası değerler: AzureOpenAI, AzureBlob, AzureStorageAccount, , CognitiveSearch, CosmosDB, , ApiKey, AppConfigAppInsights, CustomKeys,RemoteTool_Preview	Bu belirli türdeki bağlantıları listeleme
defaultConnection	soru	Hayı	Boolean	Varsayılan bağlantı olan bağlantıları listeleme

İstek Başlığı

İsim	Gerekli	Türü	Description
x-ms-client-request-id	Yanlış	String	İstek için opak, genel olarak benzersiz, istemci tarafından oluşturulan bir dize tanımlayıcısı.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	PagedConnection

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-client-request-id		İstek için opak, genel olarak benzersiz, istemci tarafından oluşturulan bir dize tanımlayıcısı.

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	String	Neyin yanlış gittiğini gösteren dize hata kodu.

Bağlantılar - get

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

Bağlantı kimlik bilgilerini doldurmadan ada göre bağlantı alma

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
name	path	Evet	String	Kullanıcı tarafından sağlanan bağlantının kolay adı.

İstek Başlığı

İsim	Gerekli	Türü	Description
x-ms-client-request-id	Yanlış	String	İstek için opak, genel olarak benzersiz, istemci tarafından oluşturulan bir dize tanımlayıcısı.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	Bağlantı

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-client-request-id		İstek için opak, genel olarak benzersiz, istemci tarafından oluşturulan bir dize tanımlayıcısı.

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	String	Neyin yanlış gittiğini gösteren dize hata kodu.

Bağlantılar - kimlik bilgileriyle alma

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

Bağlantı kimlik bilgileriyle ada göre bir bağlantı alın

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
name	path	Evet	String	Kullanıcı tarafından sağlanan bağlantının kolay adı.

İstek Başlığı

İsim	Gerekli	Türü	Description
x-ms-client-request-id	Yanlış	String	İstek için opak, genel olarak benzersiz, istemci tarafından oluşturulan bir dize tanımlayıcısı.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	Bağlantı

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-client-request-id		İstek için opak, genel olarak benzersiz, istemci tarafından oluşturulan bir dize tanımlayıcısı.

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	String	Neyin yanlış gittiğini gösteren dize hata kodu.

Veri Setleri

Veri kümeleri - en son liste

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

Her DatasetVersion'ın en son sürümünü listeleme

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	PagedDatasetVersion

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	String	Neyin yanlış gittiğini gösteren dize hata kodu.

Veri kümeleri - liste sürümleri

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

Verilen DatasetVersion'ın tüm sürümlerini listeleyin

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
name	path	Evet	String	Kaynağın adı

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	PagedDatasetVersion

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	String	Neyin yanlış gittiğini gösteren dize hata kodu.

Veri kümeleri - sürüm alma

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

DatasetVersion'ın belirli bir sürümünü alın. DatasetVersion yoksa hizmet 404 Bulunamadı hatası döndürür.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
name	path	Evet	String	Kaynağın adı
version	path	Evet	String	Alınacak DatasetVersion'ın belirli sürüm kimliği.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	DatasetVersion

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	String	Neyin yanlış gittiğini gösteren dize hata kodu.

Veri kümeleri - sürümü silme

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

DatasetVersion'ın belirli bir sürümünü silin. DatasetVersion başarıyla silindiyse veya DatasetVersion yoksa hizmet 204 İçerik Yok döndürür.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
name	path	Evet	String	Kaynağın adı
version	path	Evet	String	Silinecek DatasetVersion sürümü.

Yanıtlar

Durum Kodu: 204

Açıklama: Bu istek için gönderilecek içerik yok, ancak üst bilgiler yararlı olabilir.

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	String	Neyin yanlış gittiğini gösteren dize hata kodu.

Veri kümeleri - sürüm oluşturma veya güncelleştirme

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

Verilen sürüm kimliğiyle yeni bir DatasetVersion oluşturun veya mevcut bir DatasetVersion'ı güncelleştirin

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
name	path	Evet	String	Kaynağın adı
version	path	Evet	String	Oluşturulacak veya güncelleştirilecek DatasetVersion'ın belirli sürüm kimliği.

İstek Gövdesi

İçerik Türü: application/merge-patch+json

İsim	Türü	Description	Gerekli	Varsayılan
açıklama	String	Varlık açıklaması metni.	Hayı
tags	nesne	Etiket sözlüğü. Etiketler eklenebilir, kaldırılabilir ve güncelleştirilebilir.	Hayı
type	DatasetType	Veri türünü belirlemek için sabit listesi.	Evet

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	DatasetVersion

Durum Kodu: 201

Açıklama: İstek başarılı oldu ve sonuç olarak yeni bir kaynak oluşturuldu.

İçerik Türü	Türü	Açıklama
uygulama/json	DatasetVersion

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	String	Neyin yanlış gittiğini gösteren dize hata kodu.

Veri kümeleri - kimlik bilgilerini alma

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

Veri seti sürümüyle ilişkili storage hesabı access SAS kimlik bilgilerini alın.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
name	path	Evet	String	Kaynağın adı
version	path	Evet	String	Üzerinde çalışılacak DatasetVersion'ın belirli sürüm kimliği.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	AssetCredentialResponse

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	String	Neyin yanlış gittiğini gösteren dize hata kodu.

Veri kümeleri - bekleyen karşıya yükleme sürümünü başlatma

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

Belirli bir sürüm için yeni bir veri kümesi başlatın veya mevcut bekleyen bir veri kümesini karşıya yükleyin.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
name	path	Evet	String	Kaynağın adı
version	path	Evet	String	Üzerinde çalışılacak DatasetVersion'ın belirli sürüm kimliği.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
connectionName (bağlantıadı)	String	Azure Storage Account connection name to use for generate temporary SAS token	Hayı
pendingUploadId	String	PendingUploadId sağlanmazsa, rastgele bir GUID kullanılır.	Hayı
pendingUploadType	enum	BlobReference desteklenen tek türdür. Olası değerler: BlobReference	Evet

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	PendingUploadResponse

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	String	Neyin yanlış gittiğini gösteren dize hata kodu.

Dağıtımlar

Dağıtımlar - liste

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

Projede tüm dağıtılan modelleri listeleyin

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
modelPublisher	soru	Hayı	String	Modelleri filtreleyen model publisher
modelName	soru	Hayı	String	Modelleri filtrelemek için model adı (publisher özel adı)
deploymentType	soru	Hayı	String Olası değerler: ModelDeployment	Listeyi filtreleme ölçütü olarak kullanılacak dağıtım türü

İstek Başlığı

İsim	Gerekli	Türü	Description
x-ms-client-request-id	Yanlış	String	İstek için opak, genel olarak benzersiz, istemci tarafından oluşturulan bir dize tanımlayıcısı.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	PagedDeployment

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-client-request-id		İstek için opak, genel olarak benzersiz, istemci tarafından oluşturulan bir dize tanımlayıcısı.

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	String	Neyin yanlış gittiğini gösteren dize hata kodu.

Dağıtımlar - get

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

Dağıtılan bir model edinin.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
name	path	Evet	String	Dağıtımın adı

İstek Başlığı

İsim	Gerekli	Türü	Description
x-ms-client-request-id	Yanlış	String	İstek için opak, genel olarak benzersiz, istemci tarafından oluşturulan bir dize tanımlayıcısı.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	Dağıtım

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-client-request-id		İstek için opak, genel olarak benzersiz, istemci tarafından oluşturulan bir dize tanımlayıcısı.

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	String	Neyin yanlış gittiğini gösteren dize hata kodu.

Değerlendirme Taksonomileri

Değerlendirme taksonomileri - liste

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

Liste değerlendirme taksonomileri

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
inputName	soru	Hayı	String	Değerlendirme giriş adına göre filtreleyin.
inputType	soru	Hayı	String	Taksonomi giriş türüne göre filtreleyin.

İstek Başlığı

İsim	Gerekli	Türü	Description
Foundry-Features	Doğru	String Olası değerler: Evaluations=V1Preview	Önizleme işlemleri kullanılırken veya kalıcı önizleme kaynaklarını değiştirirken bir özellik bayrağı kabul etmek gerekir.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	PagedEvaluationTaxonomy

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	String	Neyin yanlış gittiğini gösteren dize hata kodu.

Değerlendirme taksonomileri - get

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

Ada göre çalıştırılan bir değerlendirme alın.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
name	path	Evet	String	Kaynağın adı

İstek Başlığı

İsim	Gerekli	Türü	Description
Foundry-Features	Doğru	String Olası değerler: Evaluations=V1Preview	Önizleme işlemleri kullanılırken veya kalıcı önizleme kaynaklarını değiştirirken bir özellik bayrağı kabul etmek gerekir.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	EvaluationTaxonomy

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	String	Neyin yanlış gittiğini gösteren dize hata kodu.

Değerlendirme taksonomileri - silme

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

Bir değerlendirme taksonomisini ada göre silin.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
name	path	Evet	String	Kaynağın adı

İstek Başlığı

İsim	Gerekli	Türü	Description
Foundry-Features	Doğru	String Olası değerler: Evaluations=V1Preview	Önizleme işlemleri kullanılırken veya kalıcı önizleme kaynaklarını değiştirirken bir özellik bayrağı kabul etmek gerekir.

Yanıtlar

Durum Kodu: 204

Açıklama: Bu istek için gönderilecek içerik yok, ancak üst bilgiler yararlı olabilir.

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	String	Neyin yanlış gittiğini gösteren dize hata kodu.

Değerlendirme taksonomileri - oluşturma

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

Bir değerlendirme taksonomisi oluşturun.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
name	path	Evet	String	Değerlendirme taksonomisinin adı.

İstek Başlığı

İsim	Gerekli	Türü	Description
Foundry-Features	Doğru	String Olası değerler: Evaluations=V1Preview	Önizleme işlemleri kullanılırken veya kalıcı önizleme kaynaklarını değiştirirken bir özellik bayrağı kabul etmek gerekir.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
açıklama	String	Varlık açıklaması metni.	Hayı
properties	nesne	Değerlendirme taksonomisi için ek özellikler.	Hayı
tags	nesne	Etiket sözlüğü. Etiketler eklenebilir, kaldırılabilir ve güncelleştirilebilir.	Hayı
taksonomi Kategorileri	TaxonomyCategory dizisi	Taksonomi kategorilerinin listesi.	Hayı
taksonomiInput	EvaluationTaxonomyInput	Değerlendirme taksonomisi için giriş yapılandırması.	Evet
└─ türü	EvaluationTaxonomyInputType	Değerlendirme taksonomisinin giriş türü.	Evet

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	EvaluationTaxonomy

Durum Kodu: 201

Açıklama: İstek başarılı oldu ve sonuç olarak yeni bir kaynak oluşturuldu.

İçerik Türü	Türü	Açıklama
uygulama/json	EvaluationTaxonomy

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	String	Neyin yanlış gittiğini gösteren dize hata kodu.

Değerlendirme taksonomileri - güncelleştirme

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

Değerlendirme taksonomisini güncelleştirin.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
name	path	Evet	String	Değerlendirme taksonomisinin adı.

İstek Başlığı

İsim	Gerekli	Türü	Description
Foundry-Features	Doğru	String Olası değerler: Evaluations=V1Preview	Önizleme işlemleri kullanılırken veya kalıcı önizleme kaynaklarını değiştirirken bir özellik bayrağı kabul etmek gerekir.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
açıklama	String	Varlık açıklaması metni.	Hayı
properties	nesne	Değerlendirme taksonomisi için ek özellikler.	Hayı
tags	nesne	Etiket sözlüğü. Etiketler eklenebilir, kaldırılabilir ve güncelleştirilebilir.	Hayı
taksonomi Kategorileri	TaxonomyCategory dizisi	Taksonomi kategorilerinin listesi.	Hayı
taksonomiInput	EvaluationTaxonomyInputUpdate	Değerlendirme taksonomisi için giriş yapılandırması.	Hayı
└─ türü	EvaluationTaxonomyInputType	Değerlendirme taksonomisinin giriş türü.	Evet

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	EvaluationTaxonomy

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	String	Neyin yanlış gittiğini gösteren dize hata kodu.

Değerlendirme Kuralları

Değerlendirme kuralları - liste

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

Tüm değerlendirme kurallarını listeleyin.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
actionType	soru	Hayı	String Olası değerler: continuousEvaluation, humanEvaluationPreview	Değerlendirme kuralı türüne göre filtreleyin.
ajan adı	soru	Hayı	String	Temsilci adına göre filtreleyin.
etkinleştirildi	soru	Hayı	Boolean	Etkin duruma göre filtreleyin.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	PagedEvaluationRule

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	String	Neyin yanlış gittiğini gösteren dize hata kodu.

Değerlendirme kuralları - get

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

Bir değerlendirme kuralı alın.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
kimlik	path	Evet	String	Değerlendirme kuralı için benzersiz tanımlayıcı.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	EvaluationRule

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	String	Neyin yanlış gittiğini gösteren dize hata kodu.

Değerlendirme kuralları - silme

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

Değerlendirme kuralını silin.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
kimlik	path	Evet	String	Değerlendirme kuralı için benzersiz tanımlayıcı.

Yanıtlar

Durum Kodu: 204

Açıklama: Bu istek için gönderilecek içerik yok, ancak üst bilgiler yararlı olabilir.

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	String	Neyin yanlış gittiğini gösteren dize hata kodu.

Değerlendirme kuralları - oluşturma veya güncelleştirme

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

Değerlendirme kuralı oluşturun veya güncelleştirin.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
kimlik	path	Evet	String	Değerlendirme kuralı için benzersiz tanımlayıcı.

İstek Başlığı

İsim	Gerekli	Türü	Description
Foundry-Features	Yanlış	String Olası değerler: Evaluations=V1Preview	Önizleme işlemleri kullanılırken veya kalıcı önizleme kaynaklarını değiştirirken bir özellik bayrağı kabul etmek gerekir.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
hareket	EvaluationRuleAction	Değerlendirme eylem modeli.	Evet
└─ türü	EvaluationRuleActionType	Değerlendirme eyleminin türü.	Evet
açıklama	String	Değerlendirme kuralının açıklaması.	Hayı
ekran adı	String	Değerlendirme kuralı için Görünen Ad.	Hayı
etkinleştirildi	Boolean	Değerlendirme kuralının etkin olup olmadığını gösterir. Varsayılan değer doğrudur	Evet
eventType	EvaluationRuleEventType	Değerlendirme kuralı olayının türü.	Evet
filtre	EvaluationRuleFilter	Değerlendirme filtresi modeli.	Hayı
└─ ajanName	String	Müşteri temsilcisi adına göre filtreleyin.	Evet
kimlik	dize (salt okunur)	Değerlendirme kuralı için benzersiz tanımlayıcı.	Evet
sistem verileri	object (salt okunur)	Değerlendirme kuralı için sistem meta verileri.	Evet

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	EvaluationRule

Durum Kodu: 201

Açıklama: İstek başarılı oldu ve sonuç olarak yeni bir kaynak oluşturuldu.

İçerik Türü	Türü	Açıklama
uygulama/json	EvaluationRule

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	String	Neyin yanlış gittiğini gösteren dize hata kodu.

Değerlendiriciler

Değerlendiriciler - en son sürümleri listeleme

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

Her değerlendiricinin en son sürümünü listeleyin

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
type	soru	Hayı	String Olası değerler: builtin, custom, all	Değerlendiricileri türe göre filtreleyin. Olası değerler: 'all', 'custom', 'builtin'.
limit	soru	Hayı	tamsayı	Döndürülecek nesne sayısıyla ilgili bir sınır. Sınır 1 ile 100 arasında olabilir ve varsayılan değer 20'dir.

İstek Başlığı

İsim	Gerekli	Türü	Description
Foundry-Features	Doğru	String Olası değerler: Evaluations=V1Preview	Önizleme işlemleri kullanılırken veya kalıcı önizleme kaynaklarını değiştirirken bir özellik bayrağı kabul etmek gerekir.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	PagedEvaluatorVersion

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	String	Neyin yanlış gittiğini gösteren dize hata kodu.

Değerlendiriciler - liste sürümleri

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

Verilen değerlendiricinin tüm sürümlerini listeleyin

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
name	path	Evet	String	Kaynağın adı
type	soru	Hayı	String Olası değerler: builtin, custom, all	Değerlendiricileri türe göre filtreleyin. Olası değerler: 'all', 'custom', 'builtin'.
limit	soru	Hayı	tamsayı	Döndürülecek nesne sayısıyla ilgili bir sınır. Sınır 1 ile 100 arasında olabilir ve varsayılan değer 20'dir.

İstek Başlığı

İsim	Gerekli	Türü	Description
Foundry-Features	Doğru	String Olası değerler: Evaluations=V1Preview	Önizleme işlemleri kullanılırken veya kalıcı önizleme kaynaklarını değiştirirken bir özellik bayrağı kabul etmek gerekir.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	PagedEvaluatorVersion

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	String	Neyin yanlış gittiğini gösteren dize hata kodu.

Değerlendiriciler - sürüm oluşturma

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

Otomatik artırılmış sürüm kimliğiyle yeni bir EvaluatorVersion oluşturma

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
name	path	Evet	String	Kaynağın adı

İstek Başlığı

İsim	Gerekli	Türü	Description
Foundry-Features	Doğru	String Olası değerler: Evaluations=V1Preview	Önizleme işlemleri kullanılırken veya kalıcı önizleme kaynaklarını değiştirirken bir özellik bayrağı kabul etmek gerekir.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
categories	DeğerlendiriciKatgorisi dizisi	Değerlendiricinin kategorileri	Evet
tanım	DeğerlendiriciDefinition	Ayırıcılı temel değerlendirici konfigürasyonu	Evet
└─ data_schema	nesne	Değerlendiricinin giriş verileri için JSON şeması (Taslak 2020-12). Bu, tür, özellikler, gerekli gibi parametreleri içerir.	Hayı
└─ init_parameters	nesne	Değerlendiricinin giriş parametreleri için JSON şeması (Taslak 2020-12). Bu, tür, özellikler, gerekli gibi parametreleri içerir.	Hayı
└─ ölçümler	nesne	Bu değerlendirici tarafından üretilen çıktı metriklerinin listesi	Hayı
└─ türü	EvaluatorDefinitionType	Değerlendirici tanımının türü	Evet
açıklama	String	Varlık açıklaması metni.	Hayı
display_name	String	Değerlendirici için Görünen Ad. AI Foundry'de değerlendiriciyi kolayca bulmak yardımcı olur. Benzersiz olması gerekmez.	Hayı
evaluator_type	Değerlendirici Türü	Değerlendiricinin türü	Evet
metadata	nesne	Değerlendirici hakkında meta veriler	Hayı
tags	nesne	Etiket sözlüğü. Etiketler eklenebilir, kaldırılabilir ve güncelleştirilebilir.	Hayı

Yanıtlar

Durum Kodu: 201

Açıklama: İstek başarılı oldu ve sonuç olarak yeni bir kaynak oluşturuldu.

İçerik Türü	Türü	Açıklama
uygulama/json	EvaluatorVersion

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	String	Neyin yanlış gittiğini gösteren dize hata kodu.

Değerlendiriciler - sürümü alma

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

EvaluatorVersion'ın belirli sürümünü edinin. EvaluatorVersion yoksa hizmet 404 Not Found hatası döndürür.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
name	path	Evet	String	Kaynağın adı
version	path	Evet	String	Alınacak EvaluatorVersion'ın belirli sürüm kimliği.

İstek Başlığı

İsim	Gerekli	Türü	Description
Foundry-Features	Doğru	String Olası değerler: Evaluations=V1Preview	Önizleme işlemleri kullanılırken veya kalıcı önizleme kaynaklarını değiştirirken bir özellik bayrağı kabul etmek gerekir.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	EvaluatorVersion

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	String	Neyin yanlış gittiğini gösteren dize hata kodu.

Değerlendiriciler - sürümü silme

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

EvaluatorVersion'ın belirli sürümünü silin. EvaluatorVersion başarıyla silindiyse veya EvaluatorVersion mevcut değilse hizmet 204 İçerik Yok döndürür.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
name	path	Evet	String	Kaynağın adı
version	path	Evet	String	Silinecek EvaluatorVersion sürümü.

İstek Başlığı

İsim	Gerekli	Türü	Description
Foundry-Features	Doğru	String Olası değerler: Evaluations=V1Preview	Önizleme işlemleri kullanılırken veya kalıcı önizleme kaynaklarını değiştirirken bir özellik bayrağı kabul etmek gerekir.

Yanıtlar

Durum Kodu: 204

Açıklama: Bu istek için gönderilecek içerik yok, ancak üst bilgiler yararlı olabilir.

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	String	Neyin yanlış gittiğini gösteren dize hata kodu.

Değerlendiriciler - güncelleştirme sürümü

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

Mevcut bir EvaluatorVersion'ı verilen sürüm kimliğiyle güncelleyin

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
name	path	Evet	String	Kaynağın adı
version	path	Evet	String	Güncelleştirilecek EvaluatorVersion sürümü.

İstek Başlığı

İsim	Gerekli	Türü	Description
Foundry-Features	Doğru	String Olası değerler: Evaluations=V1Preview	Önizleme işlemleri kullanılırken veya kalıcı önizleme kaynaklarını değiştirirken bir özellik bayrağı kabul etmek gerekir.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
categories	DeğerlendiriciKatgorisi dizisi	Değerlendiricinin kategorileri	Hayı
açıklama	String	Varlık açıklaması metni.	Hayı
display_name	String	Değerlendirici için Görünen Ad. AI Foundry'de değerlendiriciyi kolayca bulmak yardımcı olur. Benzersiz olması gerekmez.	Hayı
metadata	nesne	Değerlendirici hakkında meta veriler	Hayı
tags	nesne	Etiket sözlüğü. Etiketler eklenebilir, kaldırılabilir ve güncelleştirilebilir.	Hayı

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	EvaluatorVersion

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	String	Neyin yanlış gittiğini gösteren dize hata kodu.

Dizinler

Dizinler - en son liste

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

Her Dizinin en son sürümünü listeleyin

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	PagedIndex

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	String	Neyin yanlış gittiğini gösteren dize hata kodu.

Dizinler - liste sürümleri

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

Verilen Dizinin tüm sürümlerini listeleyin

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
name	path	Evet	String	Kaynağın adı

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	PagedIndex

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	String	Neyin yanlış gittiğini gösteren dize hata kodu.

Dizinler - sürüm alma

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

Dizinin belirli bir sürümünü edinin. Dizin yoksa hizmet 404 Bulunamadı hatası döndürür.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
name	path	Evet	String	Kaynağın adı
version	path	Evet	String	Alınacak Dizinin belirli sürüm kimliği.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	Dizin

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	String	Neyin yanlış gittiğini gösteren dize hata kodu.

Dizinler - sürümü silme

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

Dizinin belirli bir sürümünü silin. Hizmet, Dizin başarıyla silindiyse veya Dizin mevcut değilse 204 İçerik Yok döndürür.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
name	path	Evet	String	Kaynağın adı
version	path	Evet	String	Silinecek Dizin sürümü.

Yanıtlar

Durum Kodu: 204

Açıklama: Bu istek için gönderilecek içerik yok, ancak üst bilgiler yararlı olabilir.

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	String	Neyin yanlış gittiğini gösteren dize hata kodu.

Dizinler - sürüm oluşturma veya güncelleştirme

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

Verilen sürüm kimliğiyle yeni bir Dizin oluşturun veya mevcut bir Dizini güncelleyin

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
name	path	Evet	String	Kaynağın adı
version	path	Evet	String	Oluşturulacak veya güncelleştirilecek Dizinin belirli sürüm kimliği.

İstek Gövdesi

İçerik Türü: application/merge-patch+json

İsim	Türü	Description	Gerekli	Varsayılan
açıklama	String	Varlık açıklaması metni.	Hayı
tags	nesne	Etiket sözlüğü. Etiketler eklenebilir, kaldırılabilir ve güncelleştirilebilir.	Hayı
type	IndexType		Evet

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	Dizin

Durum Kodu: 201

Açıklama: İstek başarılı oldu ve sonuç olarak yeni bir kaynak oluşturuldu.

İçerik Türü	Türü	Açıklama
uygulama/json	Dizin

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	String	Neyin yanlış gittiğini gösteren dize hata kodu.

Insights

İçgörüler - oluşturma

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

İçgörüler Oluşturun

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

İsim	Gerekli	Türü	Description
Foundry-Features	Doğru	String Olası değerler: Insights=V1Preview	Önizleme işlemleri kullanılırken veya kalıcı önizleme kaynaklarını değiştirirken bir özellik bayrağı kabul etmek gerekir.
Yinelenebilirlik-Request-ID	Yanlış	String	İstek iktidarını sağlamak için benzersiz, istemci tarafından oluşturulan tanımlayıcı. Yinelenen değerlendirmeleri önlemek için yeniden denemeler için aynı kimliği kullanın.
Yinelenebilirlik-First-Sent	Yanlış	String	Bu isteğin ilk kez ne zaman başlatıldığını gösteren zaman damgası. İdempotens kontrolü için repeatability-request-id ile birlikte kullanılır.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
ekran adı	String	İçgörü için kullanıcı dostu görünen ad.	Evet
kimlik	dize (salt okunur)	İçgörüler raporunun benzersiz tanımlayıcısı.	Evet
metadata	InsightsMetadata (salt okunur)	İçgörülerle ilgili meta veriler.	Evet
└─ tamamlandıAt	String	İçgörülerin tamamlandığı zaman damgası.	Hayı
└─ oluşturuldu	String	İçgörülerin oluşturulduğu zaman damgası.	Evet
request	InsightRequest	İçgörüler raporunun isteği.	Evet
└─ türü	InsightType	İstek türü.	Evet
sonuç	InsightResult (salt okunur)	İçgörülerin sonucu.	Hayı
└─ türü	InsightType	İçgörülerin türü sonucu.	Evet
state	Azure. Core.Foundations.OperationState (yalnızca okunabilir)	İzin verilen işlem durumlarını açıklayan sabit listesi.	Evet

Yanıtlar

Durum Kodu: 201

Açıklama: İstek başarılı oldu ve sonuç olarak yeni bir kaynak oluşturuldu.

İçerik Türü	Türü	Açıklama
uygulama/json	Insight

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	String	Neyin yanlış gittiğini gösteren dize hata kodu.

İçgörüler - liste

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

Tüm içgörüleri ters kronolojik sırayla listeleyin (önce en yeni).

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
type	soru	Hayı	String Olası değerler: EvaluationRunClusterInsight, AgentClusterInsight, EvaluationComparison	Analiz türüne göre filtreleyin.
evalId	soru	Hayı	String	Değerlendirme kimliğine göre filtreleyin.
runId	soru	Hayı	String	Değerlendirme çalıştırma kimliğine göre filtreleyin.
ajan adı	soru	Hayı	String	Temsilci adına göre filtreleyin.
includeCoordinates	soru	Hayı	Boolean	Yanıta görselleştirme için koordinatların dahil edilip edilmeyeceği. Varsayılan değer false'tur.

İstek Başlığı

İsim	Gerekli	Türü	Description
Foundry-Features	Doğru	String Olası değerler: Insights=V1Preview	Önizleme işlemleri kullanılırken veya kalıcı önizleme kaynaklarını değiştirirken bir özellik bayrağı kabul etmek gerekir.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	PagedInsight

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	String	Neyin yanlış gittiğini gösteren dize hata kodu.

İçgörüler - get

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

Kimliğe göre belirli bir içgörü elde edin.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
kimlik	path	Evet	String	İçgörüler raporunun benzersiz tanımlayıcısı.
includeCoordinates	soru	Hayı	Boolean	Yanıta görselleştirme için koordinatların dahil edilip edilmeyeceği. Varsayılan değer false'tur.

İstek Başlığı

İsim	Gerekli	Türü	Description
Foundry-Features	Doğru	String Olası değerler: Insights=V1Preview	Önizleme işlemleri kullanılırken veya kalıcı önizleme kaynaklarını değiştirirken bir özellik bayrağı kabul etmek gerekir.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	Insight

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	String	Neyin yanlış gittiğini gösteren dize hata kodu.

Bellek Depoları

Bellek deposu oluşturma

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

Bir bellek deposu oluşturun.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

İsim	Gerekli	Türü	Description
Foundry-Features	Doğru	String Olası değerler: MemoryStores=V1Preview	Önizleme işlemleri kullanılırken veya kalıcı önizleme kaynaklarını değiştirirken bir özellik bayrağı kabul etmek gerekir.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
tanım	MemoryStoreDefinition	Bellek deposu yapılandırmaları için temel tanım.	Evet
└─ tür	MemoryStoreKind	Bellek deposunun türü.	Evet
açıklama	String	Bellek deposunun okunabilir bir açıklaması. Kısıtlamalar: maxLength: 512	Hayı
metadata	nesne	Bellek deposuyla ilişkilendirilecek rastgele anahtar-değer meta verileri.	Hayı
name	String	Bellek deposunun adı. Kısıtlamalar: maxLength: 256	Evet

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	MemoryStoreObject

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Bellek depolarını listeleme

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

Tüm bellek depolarını listeleyin.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
limit	soru	Hayı	tamsayı	Döndürülecek nesne sayısıyla ilgili bir sınır. Sınır 1 ile 100 arasında olabilir ve varsayılan değer 20'dir.
order	soru	Hayı	String Olası değerler: asc, desc	Düzeni nesnelerin zaman damgasına göre created_at sıralayın. asc artan sırayla ve desc azalan sırayla
after	soru	Hayı	String	Sayfalandırmada kullanılacak bir imleç. after , listedeki yerinizi tanımlayan bir nesne kimliğidir. Örneğin, bir liste isteğinde bulunur ve obj_foo ile biten 100 nesne alırsanız sonraki çağrı, listenin sonraki sayfasını getirmek için after=obj_foo içerebilir.
önce	soru	Hayı	String	Sayfalandırmada kullanılacak bir imleç. before , listedeki yerinizi tanımlayan bir nesne kimliğidir. Örneğin, bir liste isteğinde bulunur ve obj_foo ile biten 100 nesne alırsanız sonraki çağrı, listenin önceki sayfasını getirmek için before=obj_foo içerebilir.
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

İsim	Gerekli	Türü	Description
Foundry-Features	Doğru	String Olası değerler: MemoryStores=V1Preview	Önizleme işlemleri kullanılırken veya kalıcı önizleme kaynaklarını değiştirirken bir özellik bayrağı kabul etmek gerekir.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	nesne	İstenen öğe listesi için yanıt verileri.

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Bellek depolarını güncelleştirme

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

Bellek deposunu güncelleştirin.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
name	path	Evet	String	Güncelleştirilecek bellek deposunun adı.
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

İsim	Gerekli	Türü	Description
Foundry-Features	Doğru	String Olası değerler: MemoryStores=V1Preview	Önizleme işlemleri kullanılırken veya kalıcı önizleme kaynaklarını değiştirirken bir özellik bayrağı kabul etmek gerekir.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
açıklama	String	Bellek deposunun okunabilir bir açıklaması. Kısıtlamalar: maxLength: 512	Hayı
metadata	nesne	Bellek deposuyla ilişkilendirilecek rastgele anahtar-değer meta verileri.	Hayı

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	MemoryStoreObject

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Bellek deposu alma

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

Bir bellek deposu alın.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
name	path	Evet	String	Alınacak bellek deposunun adı.
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

İsim	Gerekli	Türü	Description
Foundry-Features	Doğru	String Olası değerler: MemoryStores=V1Preview	Önizleme işlemleri kullanılırken veya kalıcı önizleme kaynaklarını değiştirirken bir özellik bayrağı kabul etmek gerekir.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	MemoryStoreObject

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Bellek depolarını silme

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

Bellek deposunu silin.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
name	path	Evet	String	Silinecek bellek deposunun adı.
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

İsim	Gerekli	Türü	Description
Foundry-Features	Doğru	String Olası değerler: MemoryStores=V1Preview	Önizleme işlemleri kullanılırken veya kalıcı önizleme kaynaklarını değiştirirken bir özellik bayrağı kabul etmek gerekir.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	DeleteMemoryStoreResponse

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Güncelleştirme sonucunu alma

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

Bellek deposu güncelleme sonucunu alın.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
name	path	Evet	String	Bellek deposunun adı.
update_id	path	Evet	String	Bellek güncelleştirme işleminin kimliği.
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

İsim	Gerekli	Türü	Description
Foundry-Features	Doğru	String Olası değerler: MemoryStores=V1Preview	Önizleme işlemleri kullanılırken veya kalıcı önizleme kaynaklarını değiştirirken bir özellik bayrağı kabul etmek gerekir.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	MemoryStoreUpdateResponse

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Kapsam belleklerini silme

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

Belirli bir kapsamla ilişkili tüm anıları bir bellek deposundan silin.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
name	path	Evet	String	Bellek deposunun adı.
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

İsim	Gerekli	Türü	Description
Foundry-Features	Doğru	String Olası değerler: MemoryStores=V1Preview	Önizleme işlemleri kullanılırken veya kalıcı önizleme kaynaklarını değiştirirken bir özellik bayrağı kabul etmek gerekir.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
kapsam	String	Kullanıcı kimliği gibi silinecek bellekleri mantıksal olarak gruplandıran ve yalıtan ad alanı.	Evet

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	MemoryStoreDeleteScopeResponse

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Anılarda arama

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

Konuşma bağlamına göre bir bellek deposundan ilgili anıları arayın.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
name	path	Evet	String	Aranacak bellek deposunun adı.
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

İsim	Gerekli	Türü	Description
Foundry-Features	Doğru	String Olası değerler: MemoryStores=V1Preview	Önizleme işlemleri kullanılırken veya kalıcı önizleme kaynaklarını değiştirirken bir özellik bayrağı kabul etmek gerekir.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
nesneler	OpenAI.InputItem dizisi	İlgili anıların aranacağı öğeler.	Hayı
options	MemorySearchOptions	Bellek arama seçenekleri.	Hayı
└─ max_memories	tamsayı	Döndürülecek en fazla bellek öğesi sayısı.	Hayı
previous_search_id	String	Önceki arama isteğinin benzersiz kimliği, son işlemin kaldığı yerden artımlı bellek aramasını etkinleştirir.	Hayı
kapsam	String	Kullanıcı kimliği gibi anıları mantıksal olarak gruplandıran ve yalıtan ad alanı.	Evet

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	MemoryStoreSearchResponse

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Bellekleri güncelleştirme

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

Bellek deposunu konuşma anılarıyla güncelleyin.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
name	path	Evet	String	Güncelleştirilecek bellek deposunun adı.
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

İsim	Gerekli	Türü	Description
Foundry-Features	Doğru	String Olası değerler: MemoryStores=V1Preview	Önizleme işlemleri kullanılırken veya kalıcı önizleme kaynaklarını değiştirirken bir özellik bayrağı kabul etmek gerekir.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
nesneler	OpenAI.InputItem dizisi	Anıların çıkarılacağı konuşma öğeleri.	Hayı
previous_update_id	String	Önceki güncelleştirme isteğinin benzersiz kimliği, son işlemin kaldığı yerden artımlı bellek güncelleştirmelerini etkinleştirir.	Hayı
kapsam	String	Kullanıcı kimliği gibi anıları mantıksal olarak gruplandıran ve yalıtan ad alanı.	Evet
update_delay	tamsayı	Bellek güncellemesini saniye cinsinden işlemeden önceki zaman aşımı süresi. Bu süre içinde yeni bir güncelleme isteği alınırsa, mevcut isteği iptal edecek ve zaman aşımını sıfırlayacaktır. Güncellemeyi gecikmeden hemen tetiklemek için 0 olarak ayarlayın. Varsayılan olarak 300'dür (5 dakika).	Hayı	300

Yanıtlar

Durum Kodu: 202

Açıklama: İstek işleme için kabul edildi, ancak işleme henüz tamamlanmadı.

İçerik Türü	Türü	Açıklama
uygulama/json	MemoryStoreUpdateResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
İşlem Konumu	String	İşlem durumunu izleme konumu.

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Konuşma

Konuşma oluşturma

POST {endpoint}/openai/v1/conversations

Konuşma oluşturma.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
nesneler	OpenAI.InputItem dizisi		Hayı
metadata	OpenAI.Metadata (null atanabilir)	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Hayı

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	OpenAI.ConversationResource

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Konuşmaları listeleme

GET {endpoint}/openai/v1/conversations

Tüm konuşmaların listesini döndürür.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
limit	soru	Hayı	tamsayı	Döndürülecek nesne sayısıyla ilgili bir sınır. Sınır 1 ile 100 arasında olabilir ve varsayılan değer 20'dir.
order	soru	Hayı	String Olası değerler: asc, desc	Düzeni nesnelerin zaman damgasına göre created_at sıralayın. asc artan sırayla ve desc azalan sırayla
after	soru	Hayı	String	Sayfalandırmada kullanılacak bir imleç. after , listedeki yerinizi tanımlayan bir nesne kimliğidir. Örneğin, bir liste isteğinde bulunur ve obj_foo ile biten 100 nesne alırsanız sonraki çağrı, listenin sonraki sayfasını getirmek için after=obj_foo içerebilir.
önce	soru	Hayı	String	Sayfalandırmada kullanılacak bir imleç. before , listedeki yerinizi tanımlayan bir nesne kimliğidir. Örneğin, bir liste isteğinde bulunur ve obj_foo ile biten 100 nesne alırsanız sonraki çağrı, listenin önceki sayfasını getirmek için before=obj_foo içerebilir.
agent_name	soru	Hayı	String	Müşteri temsilcisi adına göre filtreleyin. Sağlanırsa, yalnızca belirtilen aracıyla ilişkilendirilmiş öğeler döndürülür.
agent_id	soru	Hayı	String	Aracı kimliğine göre biçiminde name:versionfiltreleyin. Sağlanırsa, yalnızca belirtilen aracı kimliğiyle ilişkilendirilmiş öğeler döndürülür.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	nesne	İstenen öğe listesi için yanıt verileri.

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Konuşmayı güncelleştirme

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

Bir konuşmayı güncelleştirme.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
conversation_id	path	Evet	String	Güncelleştirilecek konuşmanın kimliği.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
metadata	OpenAI.Metadata (null atanabilir)	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Evet

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	OpenAI.ConversationResource

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Konuşma alma

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

Bir konuşmayı alır.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
conversation_id	path	Evet	String	Alınacak konuşmanın kimliği.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	OpenAI.ConversationResource

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Konuşmayı silme

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

Bir konuşmayı siler.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
conversation_id	path	Evet	String	Silinecek konuşmanın kimliği.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	OpenAI.DeletedConversationResource

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Konuşma öğeleri oluşturma

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

Verilen kimlikle bir konuşmada öğeler oluşturun.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
conversation_id	path	Evet	String	Öğenin oluşturulması gereken konuşmanın kimliği.
include	soru	Hayı	dizi	Yanıta eklenecek ek alanlar. include Daha fazla bilgi için Konuşma öğelerini listeleme parametresine bakın.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
nesneler	OpenAI.Item dizisi	Konuşmaya eklenecek öğeler. Bir kerede en fazla 20 öğe ekleyebilirsiniz.	Evet

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	OpenAI.ConversationItemList

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Konuşma öğelerini listeleme

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

Verilen kimlikle bir konuşmanın tüm öğelerini listeleyin.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
conversation_id	path	Evet	String	Öğelerin listelenmesi gereken konuşmanın kimliği.
limit	soru	Hayı	tamsayı	Döndürülecek nesne sayısıyla ilgili bir sınır. Sınır 1 ile 100 arasında olabilir ve varsayılan değer 20'dir.
order	soru	Hayı	String Olası değerler: asc, desc	Düzeni nesnelerin zaman damgasına göre created_at sıralayın. asc artan sırayla ve desc azalan sırayla
after	soru	Hayı	String	Sayfalandırmada kullanılacak bir imleç. after , listedeki yerinizi tanımlayan bir nesne kimliğidir. Örneğin, bir liste isteğinde bulunur ve obj_foo ile biten 100 nesne alırsanız sonraki çağrı, listenin sonraki sayfasını getirmek için after=obj_foo içerebilir.
önce	soru	Hayı	String	Sayfalandırmada kullanılacak bir imleç. before , listedeki yerinizi tanımlayan bir nesne kimliğidir. Örneğin, bir liste isteğinde bulunur ve obj_foo ile biten 100 nesne alırsanız sonraki çağrı, listenin önceki sayfasını getirmek için before=obj_foo içerebilir.
item_type	soru	Hayı	String Olası değerler: message, , , output_message, file_search_call, computer_call, , computer_call_output, web_search_call, function_call, function_call_output, reasoningcompaction, image_generation_callcode_interpreter_call, local_shell_calllocal_shell_call_outputshell_callshell_call_outputapply_patch_call, apply_patch_call_output, mcp_list_tools, , , mcp_approval_request, mcp_approval_response, , , mcp_callcustom_tool_call_outputcustom_tool_callstructured_outputsoauth_consent_requestmemory_search_callworkflow_action	Öğe türüne göre filtreleyin. Sağlanırsa, yalnızca belirtilen türdeki öğeler döndürülür.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	nesne	İstenen öğe listesi için yanıt verileri.

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Konuşma öğesini alma

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

Verilen kimliklerle bir konuşmadan tek bir öğe alın.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
conversation_id	path	Evet	String	Öğeyi içeren konuşmanın kimliği.
item_id	path	Evet	String	Alınacak konuşma öğesinin kimliği.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	OpenAI.OutputItem

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Konuşma öğesini silme

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

Verilen kimliklerle bir konuşmadaki öğeyi silin.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
conversation_id	path	Evet	String	Öğenin silinmesi gereken konuşmanın kimliği.
item_id	path	Evet	String	Silinecek konuşma öğesinin kimliği.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	OpenAI.ConversationResource

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Değerlendirmeler

Değerlendirmeler - değerlendirmeleri listeleme

GET {endpoint}/openai/v1/evals

Tüm değerlendirmeleri listele Bir proje için değerlendirmeleri listeleyin.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
after	soru	Hayı	String	Önceki sayfalandırma isteğindeki son çalıştırma tanımlayıcısı.
limit	soru	Hayı	tamsayı	Alınacak koşu sayısı.
order	soru	Hayı	String Olası değerler: asc, desc	Çalıştırmalar için zaman damgasına göre sıralama düzeni. artan sırayla sıralama için asc veya azalan sırayla sıralama için desc kullanın. Varsayılan olarak asc değerini alır.
sırala_göre	soru	Hayı	String Olası değerler: created_at, updated_at	Değerlendirmeler oluşturma zamanına veya son güncelleştirme zamanına göre sıralanabilir. created_at oluşturma zamanı veya updated_at son güncelleştirme zamanı için kullanın.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	nesne	İstenen öğe listesi için yanıt verileri.

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Değerlendirmeler - değerlendirme oluşturma

POST {endpoint}/openai/v1/evals

Değerlendirme oluşturma Modelin performansını test etmek için kullanılabilecek bir değerlendirmenin yapısını oluşturun. Değerlendirme, değerlendirmede kullanılan verilerin şemasını belirleyen bir dizi test ölçütü ve veri kaynağı yapılandırmasıdır. Değerlendirme oluşturduktan sonra, bunu farklı modellerde ve model parametrelerinde çalıştırabilirsiniz. Çeşitli türlerde not verenleri ve veri kaynaklarını destekliyoruz. Daha fazla bilgi için bkz.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
veri_kaynağı_yapılandırması	OpenAI.CreateEvalCustomDataSourceConfig veya OpenAI.CreateEvalLogsDataSourceConfig veya OpenAI.CreateEvalStoredCompletionsDataSourceConfig veya AzureAIDataSourceConfig	Değerlendirme için kullanılan veri kaynağının yapılandırması çalışır. Değerlendirmede kullanılan verilerin şemasını dikte eder.	Evet
metadata	OpenAI.Metadata (null atanabilir)	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Hayı
name	String	Değerlendirmenin adı.	Hayı
properties	nesne	Ek bilgileri depolamak için bir nesneye eklenebilen sabit 16 anahtar-değer çifti kümesi. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler, uzunluğu en fazla 512 karakter olan dizelerdir.	Hayı
test kriterleri	OpenAI.EvalGraderLabelModel veya OpenAI.EvalGraderStringCheck ya da OpenAI.EvalGraderTextSimilarity veya OpenAI.EvalGraderPython ya da OpenAI.EvalGraderScoreModel veya EvalGraderAzureAIEvaluator dizisi	Bu gruptaki tüm değerlendirme çalıştırmaları için değerlendirici listesi. Not verenler, gibi {{item.variable_name}}çift küme ayracı gösterimini kullanarak veri kaynağındaki değişkenlere başvurabilir. Modelin çıkışına başvurmak için ad alanını sample (örneğin, {{sample.output_text}}) kullanın.	Evet

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	Değerlendirme

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Değerlendirmeler - değerlendirmeyi silme

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

Değerlendirmeyi silme Değerlendirmeyi silin.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
eval_id	path	Evet	String	Silinecek değerlendirmenin kimliği.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	DeleteEvalResponse

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Değerlendirmeler - değerlendirme alma

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

Değerlendirme alma Kimliğine göre değerlendirme alma.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
eval_id	path	Evet	String	Elde edilecek değerlendirmenin kimliği.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	Değerlendirme

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Değerlendirmeler - değerlendirmeyi güncelleştirme

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

Değerlendirmeyi güncelleştirme Değerlendirmenin belirli özelliklerini güncelleştirin.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
eval_id	path	Evet	String	Güncelleştirilecek değerlendirmenin kimliği.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
metadata	OpenAI.Metadata (null atanabilir)	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Hayı
name	String		Hayı
properties	nesne	Ek bilgileri depolamak için bir nesneye eklenebilen sabit 16 anahtar-değer çifti kümesi. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler, uzunluğu en fazla 512 karakter olan dizelerdir.	Hayı

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	Değerlendirme

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Değerlendirmeler - liste çalıştırmaları

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

Değerlendirme için çalıştırmaların listesini alma Değerlendirme için çalıştırmaların listesini alın.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
eval_id	path	Evet	String	Çalıştırmaları almak için kullanılacak değerlendirmenin kimliği.
after	soru	Hayı	String	Önceki sayfalandırma isteğindeki son çalıştırma tanımlayıcısı.
limit	soru	Hayı	tamsayı	Alınacak koşu sayısı.
order	soru	Hayı	String Olası değerler: asc, desc	Çalıştırmalar için zaman damgasına göre sıralama düzeni. artan sırayla sıralama için asc veya azalan sırayla sıralama için desc kullanın. Varsayılan olarak asc değerini alır.
durum	soru	Hayı	String Olası değerler: queued, in_progress, completed, canceled, failed . Filtre duruma göre çalışır. queued, , in_progress, failed, completed. canceled

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	nesne	İstenen öğe listesi için yanıt verileri.

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Değerlendirmeler - değerlendirme çalıştırması oluşturma

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

Değerlendirme çalıştırması oluşturma

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
eval_id	path	Evet	String	Çalıştırma oluşturulacak değerlendirmenin kimliği.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
veri_kaynağı	OpenAI.CreateEvalJsonlRunDataSource veya OpenAI.CreateEvalCompletionsRunDataSource veya OpenAI.CreateEvalResponsesRunDataSource veya EvalRunDataSource	Çalıştırmanın veri kaynağıyla ilgili ayrıntılar.	Evet
metadata	OpenAI.Metadata (null atanabilir)	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Hayı
name	String	Koşunun adı.	Hayı
properties	nesne	Ek bilgileri depolamak için bir nesneye eklenebilen sabit 16 anahtar-değer çifti kümesi. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler, uzunluğu en fazla 512 karakter olan dizelerdir.	Hayı

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	EvalRun

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Değerlendirmeler - değerlendirme çalıştırmayı silme

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

Değerlendirme çalıştırması silme Değerlendirme çalıştırması silme.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
eval_id	path	Evet	String	Silinmesi istenen çalışmanın değerlendirmenin kimliği.
run_id	path	Evet	String	Silinecek çalıştırmanın kimliği.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	DeleteEvalRunResponse

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Değerlendirmeler - değerlendirme çalıştırması alma

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

Değerlendirme çalıştırması alma Id ile değerlendirme çalıştırması alma.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
eval_id	path	Evet	String	Çalıştırmaları almak için kullanılacak değerlendirmenin kimliği.
run_id	path	Evet	String	Alınacak çalıştırmanın kimliği.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	EvalRun

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Değerlendirmeler - değerlendirme çalıştırmayı iptal etme

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

Değerlendirme çalıştırmayı iptal et Devam eden değerlendirme çalıştırmalarını iptal edin.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
eval_id	path	Evet	String	Çalıştırmasını iptal etmek istediğiniz değerlendirmenin kimliği.
run_id	path	Evet	String	İptal edilen çalıştırmanın kimliği.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	EvalRun

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Değerlendirmeler - değerlendirme çalıştırma çıkış öğelerini alma

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

Değerlendirme çalıştırması çıkış öğelerini alma Değerlendirme çalıştırması için çıkış öğelerinin listesini alın.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
eval_id	path	Evet	String
run_id	path	Evet	String	Çıkış öğelerini almak için çalıştırmanın kimliği.
after	soru	Hayı	String	Önceki sayfalandırma isteğindeki son çalıştırma tanımlayıcısı.
limit	soru	Hayı	tamsayı	Alınacak koşu sayısı.
order	soru	Hayı	String Olası değerler: asc, desc	Çalıştırmalar için zaman damgasına göre sıralama düzeni. artan sırayla sıralama için asc veya azalan sırayla sıralama için desc kullanın. Varsayılan olarak asc değerini alır.
durum	soru	Hayı	String Olası değerler: fail, pass	Çıkış öğelerini duruma göre filtreleyin. Başarısız çıkışa göre filtrelemek için kullanın failed veya pass geçirilen çıkış öğelerine göre filtrelemek için.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	nesne	İstenen öğe listesi için yanıt verileri.

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Değerlendirmeler - değerlendirme çalıştırması çıkış öğesini alma

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

Bir değerlendirme çalıştırmasının çıkış öğesini alma Kimliğine göre değerlendirme çalıştırması çıkış öğesi alma.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
eval_id	path	Evet	String	Çalıştırmaları almak için kullanılacak değerlendirmenin kimliği.
run_id	path	Evet	String	Alınacak çalıştırmanın kimliği.
output_item_id	path	Evet	String	Alınacak çıkış öğesinin kimliği.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	EvalRunOutputItem

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Fine-Tuning

İnce ayar işi oluşturma

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

Belirli bir veri kümesinden yeni model oluşturma işlemine başlayan bir ince ayar işi oluşturur.

Yanıt, iş durumu ve tamamlandıktan sonra ince ayarlı modellerin adı da dahil olmak üzere sıralanan işin ayrıntılarını içerir.

İnce ayarlama

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
hiper parametreler	OpenAI.CreateFineTuningJobRequestHyperparameters		Hayı
└─ yığın boyutu	dize veya OpenAI.integer		Hayı	otomatik
└─ öğrenme oranı çarpanı	dize veya OpenAI.numeric		Hayı
└─ n_epochs	dize veya OpenAI.integer		Hayı	otomatik
Entegrasyonlar	OpenAI.CreateFineTuningJobRequestIntegrations dizisi	İnce ayar işiniz için etkinleştirecek tümleştirmelerin listesi.	Hayı
metadata	OpenAI.Metadata (null atanabilir)	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Hayı
method	OpenAI.FineTuneMethod	İnce ayar için kullanılan yöntem.	Hayı
model	dize (aşağıdaki geçerli modellere bakın)	İnce ayar için modelin adı. Aşağıdakilerden birini seçebilirsiniz: destekli modeller.	Evet
seed	OpenAI.integer (null atanabilir)		Hayı
suffix	dize (null atanabilir)	İnce ayarlı model adınıza eklenecek en fazla 64 karakterlik bir dize. Örneğin, suffix "özel model-adı" gibi bir model adı ft:gpt-4o-mini:openai:custom-model-name:7p4lURelüretir. Kısıtlamalar: minLength: 1, maxLength: 64	Hayı
eğitim_dosyası	String	Eğitim verilerini içeren karşıya yüklenen bir dosyanın kimliği. Karşıya dosya yükleme hakkında bilgi için bkz. dosyayı karşıya yükleme. Veri kümeniz JSONL dosyası olarak biçimlendirilmelidir. Ayrıca, dosyanızı amacı fine-tuneile karşıya yüklemeniz gerekir. Dosyanın içeriği, modelin sohbet, tamamlanma biçimi veya ince ayar yönteminin tercih biçimini kullanıp kullanmama durumuna bağlı olarak farklılık göstermelidir. Daha fazla detay için ince ayar rehberi sayfasına bakınız.	Evet
doğrulama_dosyası	dize (null atanabilir)	Doğrulama verilerini içeren karşıya yüklenen bir dosyanın kimliği. Bu dosyayı sağlarsanız, veriler doğrulama oluşturmak için kullanılır ölçümlerini ince ayarlama sırasında düzenli aralıklarla gerçekleştirin. Bu ölçümler ince ayar sonuçları dosyası. Aynı veriler hem eğitme hem de doğrulama dosyalarında bulunmamalıdır. Veri kümeniz JSONL dosyası olarak biçimlendirilmelidir. Dosyanızı amacı fine-tuneile karşıya yüklemeniz gerekir. Daha fazla detay için ince ayar rehberi sayfasına bakınız.	Hayı

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	OpenAI.FineTuningJob

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Sayfalandırılmış ince ayar işlerini listeleme

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

Kuruluşunuzun ince ayar işlerini listeleme

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
after	soru	Hayı	String	Önceki sayfalandırma isteğindeki son işin tanımlayıcısı.
limit	soru	Hayı	tamsayı	Alınacak ince ayar işlerinin sayısı.
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	OpenAI.ListPaginatedFineTuningJobsResponse

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

hassas ayarlama işini alma

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

İnce ayar işi hakkında bilgi edinin.

İnce ayarlama

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
ince_ayarlama_iş_id	path	Evet	String	İnce ayar işinin kimliği.
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	OpenAI.FineTuningJob

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

İnce ayarlama işini iptal etme

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

Hassas ayarlama işini hemen iptal edin.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
ince_ayarlama_iş_id	path	Evet	String	İptal edilecek ince ayar işinin kimliği.
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	OpenAI.FineTuningJob

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

İnce ayar iş denetim noktalarını listeleme

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

bir ince ayar işi için denetim noktalarını listeleyin.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
ince_ayarlama_iş_id	path	Evet	String	Denetim noktalarını almak için ince ayar işinin kimliği.
after	soru	Hayı	String	Önceki sayfalandırma isteğindeki son denetim noktası kimliğinin tanımlayıcısı.
limit	soru	Hayı	tamsayı	Alınacak denetim noktası sayısı.
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	OpenAI.ListFineTuningJobCheckpointsResponse

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

İnce ayar iş olaylarını listeleme

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

hassas ayarlama işi için ayrıntılı durum güncelleştirmeleri alın.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
ince_ayarlama_iş_id	path	Evet	String	Olay almak için ince ayar işinin kimliği.
after	soru	Hayı	String	Önceki sayfalandırma isteğindeki son olayın tanımlayıcısı.
limit	soru	Hayı	tamsayı	Alınacak olay sayısı.
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	OpenAI.ListFineTuningJobEventsResponse

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

İnce ayarlama işini duraklatma

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

Çalışan bir ince ayar işini duraklatma.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
ince_ayarlama_iş_id	path	Evet	String	Duraklatmak için ince ayar işinin kimliği.
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	OpenAI.FineTuningJob

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

hassas ayarlama işini sürdürme

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

Duraklatılmış ince ayar işini sürdürme.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
ince_ayarlama_iş_id	path	Evet	String	Sürdürülecek ince ayar işinin kimliği.
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	OpenAI.FineTuningJob

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Yanıtlar

Yanıt oluşturma - yanıt akışı oluşturma

POST {endpoint}/openai/v1/responses

Model yanıtı oluşturur. Model yanıtı (akış yanıtı) oluşturur.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
agent_reference	AgentReference		Hayı
└─ ad	String	Aracının adı. Kısıtlamalar: maxLength: 256	Evet
└─ türü	enum	Olası değerler: agent_reference	Evet
└─ sürümü	String	Aracının sürüm tanımlayıcısı.	Hayı
arka plan	boole değeri (null atanabilir)		Hayı
konuşma	OpenAI.ConversationParam (null atanabilir)	Bu yanıtın ait olduğu konuşma. Bu konuşmadaki öğeler, bu yanıt isteği için öğesine input_items eklenir. Bu yanıt tamamlandıktan sonra bu yanıttaki giriş öğeleri ve çıkış öğeleri otomatik olarak bu konuşmaya eklenir.	Hayı
include	OpenAI.IncludeEnum dizisi		Hayı
girdi	OpenAI.InputParam	Yanıt oluşturmak için kullanılan modele metin, görüntü veya dosya girişleri. Daha fazla bilgi edinin: - Metin girişleri ve çıktıları - Görüntü girişleri - Dosya girişleri - Konuşma durumu - fonksiyon çağırıyor	Hayı
instructions	dize (null atanabilir)		Hayı
max_output_tokens	OpenAI.integer (null atanabilir)		Hayı
max_tool_calls	OpenAI.integer (null atanabilir)		Hayı
metadata	OpenAI.Metadata (null atanabilir)	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Hayı
model	String	Bu yanıtın oluşturulması için kullanılacak model dağıtımı.	Hayı
paralel araç çağrıları	boole değeri (null atanabilir)		Hayı	Doğru
previous_response_id	dize (null atanabilir)		Hayı
prompt	OpenAI.Prompt	bir istem şablonuna ve değişkenlerine başvuru. Daha fazla bilgi edinin.	Hayı
prompt_cache_key	String	OpenAI tarafından önbellek isabet hızlarınızı iyileştirmek amacıyla benzer isteklere yönelik yanıtları önbelleğe almak için kullanılır. user alanını değiştirir. Daha fazla bilgi edinin.	Hayı
prompt_cache_retention	enum	Olası değerler: in-memory, 24h	Hayı
reasoning	OpenAI.Reasoning (null atanabilir)	yalnızca gpt-5 ve o serisi modeller Için yapılandırma seçenekleri mantıp modelleri.	Hayı
└─ çaba	OpenAI.ReasoningEffort	Akıl yürütme çabasını kısıtlar mantıp modelleri. Şu anda desteklenen değerler none, minimal, low, medium, high, ve xhigh'dir. Azaltma muhakeme çabası daha hızlı yanıtlara ve daha az belirteç kullanılmasına neden olabilir bir yanıtta mantık yürütme. - gpt-5.1 varsayılan olarak noneöğesini kullanır ve mantık yürütmez. Desteklenen gerekçe değerleri gpt-5.1none, low, medium, ve high'dir. Araç çağrıları gpt-5.1'deki tüm akıl yürütme değerleri için desteklenir. - Tüm modeller varsayılan olarak akıl yürütme eforu olmadan gpt-5.1 önce medium ve desteklemeznone. - Model gpt-5-pro varsayılan olarak akıl yürütme eforunu kullanır (ve yalnızca destekler high ). - xhigh , sonrasındaki gpt-5.1-codex-maxtüm modeller için desteklenir.	Hayı
└─ özet oluştur	enum	Olası değerler: auto, concise, detailed	Hayı
└─ özeti	enum	Olası değerler: auto, concise, detailed	Hayı
safety_identifier	String	OpenAI'nin kullanım ilkelerini ihlal eden uygulamanızın kullanıcılarını algılamaya yardımcı olmak için kullanılan kararlı tanımlayıcı. Kimlikler, her kullanıcıyı benzersiz olarak tanımlayan bir dize olmalıdır. Bize herhangi bir tanımlayıcı bilgi göndermemek için kullanıcı adını veya e-posta adresini karma olarak kullanmanızı öneririz. Daha fazla bilgi edinin.	Hayı
hizmet seviyesi	OpenAI.ServiceTier	İsteğin sunulması için kullanılan işleme türünü belirtir. - 'Otomatik' olarak ayarlanırsa, talep Project ayarlarında hizmet katmanı yapılandırılmış şekilde işlenecektir. Başka bir şekilde yapılandırmadıkça, Project 'default' seçeneğini kullanır. - 'varsayılan' olarak ayarlanırsa, istek seçilen model için standart fiyatlandırma ve performansla işlenir. - 'flex' veya 'öncelikli' olarak ayarlanırsa, talep ilgili hizmet katmanıyla işlenecektir. - Ayarlanmadığında, varsayılan davranış 'auto' şeklindedir. service_tier Parametre ayarlandığında, yanıt gövdesi isteğe hizmet etmek için kullanılan işleme moduna göre değeri içerirservice_tier. Bu yanıt değeri, parametresindeki değerden farklı olabilir.	Hayı
store	boole değeri (null atanabilir)		Hayı	Doğru
veri akışı	boole değeri (null atanabilir)		Hayı
stream_options	OpenAI.ResponseStreamOptions (null atanabilir)	Akış yanıtları için seçenekler. Bunu yalnızca ayarladığınızda ayarlayın stream: true.	Hayı
└─ include_obfuscation	Boolean	True olduğunda, akış gizleme etkinleştirilir. Akış gizleme eklemeleri değişiklik olaylarının akışındaki bir obfuscation alana rastgele karakterler yük boyutlarını belirli yan kanal saldırılarına karşı bir azaltma olarak normalleştirin. Bu gizleme alanları varsayılan olarak eklenir, ancak küçük bir miktar eklenir veri akışı için ek yük. Şunu ayarlayabilirsiniz:include_obfuscation arasında ağ bağlantılarına güveniyorsanız bant genişliğini iyileştirmek için false uygulamanızı ve OpenAI API'sini seçin.	Hayı
structured_inputs	nesne	Yanıta, istem şablonu değiştirme veya araç bağımsız değişkeni bağlamalarına katılabilen yapılandırılmış girişler.	Hayı
sıcaklık	OpenAI.numeric (null atanabilir)		Hayı	1
text	OpenAI.ResponseTextParam	Modelden metin yanıtı için yapılandırma seçenekleri. Düz olabilir metin veya yapılandırılmış JSON verileri. Daha fazla bilgi edinin: - Metin girişleri ve çıktıları - Yapılandırılmış Çıktılar	Hayı
tool_choice	OpenAI.ToolChoiceOptions veya OpenAI.ToolChoiceParam		Hayı
araçlar	OpenAI.ToolsArray	Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Siz parametresini ayarlayarak tool_choice hangi aracın kullanılacağını belirtebilir. Aşağıdaki araç kategorilerini destekliyoruz: - Yerleşik araçlar: OpenAI tarafından sağlanan ve işlevselliği genişleten araçlar modelin yetenekleri, örneğin web arama veya file search. Hakkında daha fazla bilgi edinin yerleşik araçlar. - MCP Araçları: Özel MCP sunucuları aracılığıyla üçüncü taraf sistemlerle tümleştirmeler veya Google Drive ve SharePoint gibi önceden tanımlanmış bağlayıcılar. Hakkında daha fazla bilgi edinin MCP Araçları. - İşlev çağrıları (özel araçlar): Sizin tanımladığınız işlevler, modelin kesin olarak yazılan bağımsız değişkenlerle kendi kodunuzu çağırmasını sağlama ve çıkışlarını seçin. Hakkında daha fazla bilgi edinin fonksiyon çağrısı. Ayrıca şunları da kullanabilirsiniz: kendi kodunuzu çağırmak için özel araçlar.	Hayı
top_logprobs	OpenAI.integer (null atanabilir)		Hayı
top_p	OpenAI.numeric (null atanabilir)		Hayı	1
truncation	enum	Olası değerler: auto, disabled	Hayı
user	dize (kullanım dışı)	Bu alan ve safety_identifierile prompt_cache_key değiştiriliyor. Bunun yerine önbelleğe alma iyileştirmelerini korumak için kullanın prompt_cache_key . Son kullanıcılarınız için kararlı bir tanımlayıcı. Benzer istekleri daha iyi demetleyerek önbellek isabet oranlarını artırmak ve OpenAI'nin kötüye kullanımı algılayıp önlemesine yardımcı olmak için kullanılır. Daha fazla bilgi edinin.	Hayı

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	OpenAI.Response
text/event-stream	OpenAI.CreateResponseStreamingResponse

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Yanıtları listeleme

GET {endpoint}/openai/v1/responses

Tüm yanıtların listesini döndürür.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
limit	soru	Hayı	tamsayı	Döndürülecek nesne sayısıyla ilgili bir sınır. Sınır 1 ile 100 arasında olabilir ve varsayılan değer 20'dir.
order	soru	Hayı	String Olası değerler: asc, desc	Düzeni nesnelerin zaman damgasına göre created_at sıralayın. asc artan sırayla ve desc azalan sırayla
after	soru	Hayı	String	Sayfalandırmada kullanılacak bir imleç. after , listedeki yerinizi tanımlayan bir nesne kimliğidir. Örneğin, bir liste isteğinde bulunur ve obj_foo ile biten 100 nesne alırsanız sonraki çağrı, listenin sonraki sayfasını getirmek için after=obj_foo içerebilir.
önce	soru	Hayı	String	Sayfalandırmada kullanılacak bir imleç. before , listedeki yerinizi tanımlayan bir nesne kimliğidir. Örneğin, bir liste isteğinde bulunur ve obj_foo ile biten 100 nesne alırsanız sonraki çağrı, listenin önceki sayfasını getirmek için before=obj_foo içerebilir.
agent_name	soru	Hayı	String	Müşteri temsilcisi adına göre filtreleyin. Sağlanırsa, yalnızca belirtilen aracıyla ilişkilendirilmiş öğeler döndürülür.
agent_id	soru	Hayı	String	Aracı kimliğine göre biçiminde name:versionfiltreleyin. Sağlanırsa, yalnızca belirtilen aracı kimliğiyle ilişkilendirilmiş öğeler döndürülür.
conversation_id	soru	Hayı	String	Konuşma kimliğine göre filtreleyin. Sağlanırsa, yalnızca belirtilen konuşmayla ilişkili yanıtlar döndürülür.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	nesne	İstenen öğe listesi için yanıt verileri.

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Kısa yanıt konuşması

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

Yanıtlar konuşmasının sıkıştırması oluşturur.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
girdi	OpenAI.InputItem dizesi veya dizisi		Hayı
instructions	dize (null atanabilir)		Hayı
model	OpenAI.ModelIdsCompaction	veya gpt-5gibi o3 yanıtı oluşturmak için kullanılan model kimliği. OpenAI farklı özelliklere, performans özelliklerine ve fiyat noktalarına sahip çok çeşitli modeller sunar. Kullanılabilir modellere göz atmak ve modelleri karşılaştırmak için model kılavuzuna bakın.	Evet
previous_response_id	dize (null atanabilir)		Hayı

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	OpenAI.CompactResource

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Yanıt alma - yanıt akışı alma

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

Belirtilen ID numarası ile bir model tepkisi getirir. Verilen kimlikle (akış yanıtı) bir model yanıtı alır.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
response_id	path	Evet	String
include[]	soru	Hayı	dizi
veri akışı	soru	Hayı	Boolean
starting_after	soru	Hayı	tamsayı

İstek Başlığı

İsim	Gerekli	Türü	Description
kabul et	Yanlış	String Olası değerler: text/event-stream

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	OpenAI.Response
text/event-stream	OpenAI.CreateResponseStreamingResponse

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Yanıtı silme

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

Model yanıtlarını siler.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
response_id	path	Evet	String	Silinecek yanıtın kimliği.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	DeleteResponseResult

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Yanıtı iptal et

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

Model yanıtlarını iptal eder.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
response_id	path	Evet	String	İptal edilecek yanıtın kimliği.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	OpenAI.Response

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Giriş öğelerini listeleme

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

Belirli bir yanıt için giriş öğelerinin listesini döndürür.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
response_id	path	Evet	String
limit	soru	Hayı	tamsayı	Döndürülecek nesne sayısıyla ilgili bir sınır. Sınır 1 ile 100 arasında olabilir ve varsayılan değer 20'dir.
order	soru	Hayı	String Olası değerler: asc, desc	Düzeni nesnelerin zaman damgasına göre created_at sıralayın. asc artan sırayla ve desc azalan sırayla
after	soru	Hayı	String	Sayfalandırmada kullanılacak bir imleç. after , listedeki yerinizi tanımlayan bir nesne kimliğidir. Örneğin, bir liste isteğinde bulunur ve obj_foo ile biten 100 nesne alırsanız sonraki çağrı, listenin sonraki sayfasını getirmek için after=obj_foo içerebilir.
önce	soru	Hayı	String	Sayfalandırmada kullanılacak bir imleç. before , listedeki yerinizi tanımlayan bir nesne kimliğidir. Örneğin, bir liste isteğinde bulunur ve obj_foo ile biten 100 nesne alırsanız sonraki çağrı, listenin önceki sayfasını getirmek için before=obj_foo içerebilir.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	nesne	İstenen öğe listesi için yanıt verileri.

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Redteams

Redteams - liste

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

Bir kırmızı takımı adına göre listeleyin.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

İsim	Gerekli	Türü	Description
Foundry-Features	Doğru	String Olası değerler: RedTeams=V1Preview	Önizleme işlemleri kullanılırken veya kalıcı önizleme kaynaklarını değiştirirken bir özellik bayrağı kabul etmek gerekir.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	PagedRedTeam

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	String	Neyin yanlış gittiğini gösteren dize hata kodu.

Redteams -

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

İsme göre bir kırmızı takım alın.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
name	path	Evet	String	Kırmızı takım koşusunun tanımlayıcısı.

İstek Başlığı

İsim	Gerekli	Türü	Description
Foundry-Features	Doğru	String Olası değerler: RedTeams=V1Preview	Önizleme işlemleri kullanılırken veya kalıcı önizleme kaynaklarını değiştirirken bir özellik bayrağı kabul etmek gerekir.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	RedTeam

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	String	Neyin yanlış gittiğini gösteren dize hata kodu.

Redteams - oluşturma

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

Bir redteam çalıştırması oluşturur.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

İsim	Gerekli	Türü	Description
Foundry-Features	Doğru	String Olası değerler: RedTeams=V1Preview	Önizleme işlemleri kullanılırken veya kalıcı önizleme kaynaklarını değiştirirken bir özellik bayrağı kabul etmek gerekir.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
applicationScenario	String	Senaryoya özel saldırılar oluşturmak için kırmızı takım operasyonu için uygulama senaryosu.	Hayı
attackStrategies	AttackStrategy dizisi	Saldırı stratejilerinin listesi veya saldırı stratejilerinin iç içe geçmiş listeleri.	Hayı
ekran adı	String	Kırmızı takım koşusunun adı.	Hayı
kimlik	dize (salt okunur)	Kırmızı takım koşusunun tanımlayıcısı.	Evet
numTurns	tamsayı	Simülasyon turlarının sayısı.	Hayı
properties	nesne	Kırmızı takımın özellikleri. Etiketlerden farklı olarak özellikler yalnızca eklentidir. Bir özellik eklendikten sonra kaldırılamaz.	Hayı
risk Kategorileri	RiskCategory dizisi	Saldırı hedefleri oluşturmak için risk kategorilerinin listesi.	Hayı
simulationOnly	Boolean	Yalnızca simülasyon veya Simülasyon + Değerlendirme. Varsayılan olarak false, doğruysa tarama değerlendirme sonucunu değil konuşma çıktısını verir.	Hayı	Yanlış
durum	dize (salt okunur)	Kırmızı takımın durumu. Hizmet tarafından ayarlanır ve salt okunurdur.	Hayı
tags	nesne	Kırmızı takımın etiketleri. Özelliklerden farklı olarak etiketler tamamen değişebilir.	Hayı
target	TargetConfig	Hedef yapılandırma için soyut sınıf.	Evet
└─ türü	String	Model yapılandırmasının türü.	Evet

Yanıtlar

Durum Kodu: 201

Açıklama: İstek başarılı oldu ve sonuç olarak yeni bir kaynak oluşturuldu.

İçerik Türü	Türü	Açıklama
uygulama/json	RedTeam

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Programlar

Zamanlamalar - liste

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

Tüm programları listeleyin.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
type	soru	Hayı	String Olası değerler: Evaluation, Insight	Zamanlama türüne göre filtreleyin.
etkinleştirildi	soru	Hayı	Boolean	Etkin duruma göre filtreleyin.

İstek Başlığı

İsim	Gerekli	Türü	Description
Foundry-Features	Doğru	String Olası değerler: Schedules=V1Preview	Önizleme işlemleri kullanılırken veya kalıcı önizleme kaynaklarını değiştirirken bir özellik bayrağı kabul etmek gerekir.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	PagedSchedule

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	String	Neyin yanlış gittiğini gösteren dize hata kodu.

Zamanlamalar - silme

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

Bir programı sil.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
kimlik	path	Evet	String	Zamanlamanın tanımlayıcısı.

İstek Başlığı

İsim	Gerekli	Türü	Description
Foundry-Features	Doğru	String Olası değerler: Schedules=V1Preview	Önizleme işlemleri kullanılırken veya kalıcı önizleme kaynaklarını değiştirirken bir özellik bayrağı kabul etmek gerekir.

Yanıtlar

Durum Kodu: 204

Açıklama: Bu istek için gönderilecek içerik yok, ancak üst bilgiler yararlı olabilir.

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	String	Neyin yanlış gittiğini gösteren dize hata kodu.

Zamanlamalar - get

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

Kimliğe göre bir program alın.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
kimlik	path	Evet	String	Zamanlamanın tanımlayıcısı.

İstek Başlığı

İsim	Gerekli	Türü	Description
Foundry-Features	Doğru	String Olası değerler: Schedules=V1Preview	Önizleme işlemleri kullanılırken veya kalıcı önizleme kaynaklarını değiştirirken bir özellik bayrağı kabul etmek gerekir.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	Takvim

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	String	Neyin yanlış gittiğini gösteren dize hata kodu.

Zamanlamalar - oluşturma veya güncelleştirme

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

İşlem şablonu oluşturun veya güncelleştirin.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
kimlik	path	Evet	String	Zamanlamanın tanımlayıcısı.

İstek Başlığı

İsim	Gerekli	Türü	Description
Foundry-Features	Doğru	String Olası değerler: Schedules=V1Preview	Önizleme işlemleri kullanılırken veya kalıcı önizleme kaynaklarını değiştirirken bir özellik bayrağı kabul etmek gerekir.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
açıklama	String	Zamanlamanın açıklaması.	Hayı
ekran adı	String	Zamanlamanın adı.	Hayı
etkinleştirildi	Boolean	Zamanlamanın etkin durumu.	Evet
kimlik	dize (salt okunur)	Zamanlamanın tanımlayıcısı.	Evet
properties	nesne	Schedule'ın özellikleri. Etiketlerden farklı olarak özellikler yalnızca eklentidir. Bir özellik eklendikten sonra kaldırılamaz.	Hayı
provisioningStatus	ScheduleProvisioningStatus (salt okunur)	Sağlama durumunu zamanlayın.	Hayı
sistem verileri	object (salt okunur)	Kaynak için sistem meta verileri.	Evet
tags	nesne	Schedule'un etiketleri. Özelliklerden farklı olarak etiketler tamamen değişebilir.	Hayı
görev	ScheduleTask	Zamanlama görev modeli.	Evet
└─ yapılandırması	nesne	Görev için yapılandırma.	Hayı
└─ türü	ScheduleTaskType	Görevin türü.	Evet
trigger	Trigger	Zamanlamanın tetikleyicisi için temel model.	Evet
└─ türü	TriggerType	Tetikleyicinin türü.	Evet

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	Takvim

Durum Kodu: 201

Açıklama: İstek başarılı oldu ve sonuç olarak yeni bir kaynak oluşturuldu.

İçerik Türü	Türü	Açıklama
uygulama/json	Takvim

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	String	Neyin yanlış gittiğini gösteren dize hata kodu.

Zamanlamalar - liste çalıştırmaları

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

Tüm zamanlama çalıştırmalarını listeleyin.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
kimlik	path	Evet	String	Zamanlamanın tanımlayıcısı.
type	soru	Hayı	String Olası değerler: Evaluation, Insight	Zamanlama türüne göre filtreleyin.
etkinleştirildi	soru	Hayı	Boolean	Etkin duruma göre filtreleyin.

İstek Başlığı

İsim	Gerekli	Türü	Description
Foundry-Features	Doğru	String Olası değerler: Schedules=V1Preview	Önizleme işlemleri kullanılırken veya kalıcı önizleme kaynaklarını değiştirirken bir özellik bayrağı kabul etmek gerekir.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	PagedScheduleRun

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	String	Neyin yanlış gittiğini gösteren dize hata kodu.

Zamanlamalar - çalıştırmayı alma

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

Kimliğe göre çalışan bir program alın.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Foundry Project uç noktası şu şekilde "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Eğer Foundry Hub'ınızda sadece bir Project varsa veya varsayılan Project'i hedeflemek istiyorsanız hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai. azure.com/api/projeler/_project"
schedule_id	path	Evet	String	Zamanlamanın benzersiz tanımlayıcısı.
run_id	path	Evet	String	Zamanlama çalıştırmasının benzersiz tanımlayıcısı.
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

İsim	Gerekli	Türü	Description
Foundry-Features	Doğru	String Olası değerler: Schedules=V1Preview	Önizleme işlemleri kullanılırken veya kalıcı önizleme kaynaklarını değiştirirken bir özellik bayrağı kabul etmek gerekir.

Yanıtlar

Durum Kodu: 200

Açıklama: İstek başarılı oldu.

İçerik Türü	Türü	Açıklama
uygulama/json	ScheduleRun

Durum Kodu: varsayılan

Açıklama: Beklenmeyen bir hata yanıtı.

İçerik Türü	Türü	Açıklama
uygulama/json	ApiErrorResponse

Components

A2APreviewTool

A2A protokolünü uygulayan bir aracı.

İsim	Türü	Description	Gerekli	Varsayılan
agent_card_path	String	Temsilci kartına göre base_urlgiden yol. Sağlanmazsa, varsayılan olarak /.well-known/agent-card.json	Hayı
base_url	String	Aracının temel URL'si.	Hayı
project_connection_id	String	A2A sunucusu için project'teki bağlantı kimliği. Bağlantı, A2A sunucusuna bağlanmak için gereken kimlik doğrulamasını ve diğer bağlantı ayrıntılarını saklar.	Hayı
type	enum	Aracın türü. Her zaman "a2a_preview. Olası değerler: a2a_preview	Evet

AISearchIndexResource

Bir AI Arama Dizini kaynağı.

İsim	Türü	Description	Gerekli	Varsayılan
filtre	String	Arama kaynağı için filtre dizesi. Daha fazlasını buradan öğrenin.	Hayı
index_asset_id	String	Arama kaynağı için dizin varlık kimliği.	Hayı
endeks_adı	String	Bu aracıya bağlı bir IndexResource'taki dizinin adı.	Hayı
project_connection_id	String	Bu aracıya iliştirilmiş bir IndexResource'daki dizin bağlantı kimliği.	Hayı
sorgu_tipi	AzureAISearchQueryType	Azure AI Search tool için mevcut query types.	Hayı
top_k	tamsayı	Aramadan alınacak ve modele sunulacak belge sayısı.	Hayı

AgentClusterInsightRequest

Temsilci Değerlendirme Sonuçları kümesine ilişkin bilgiler

İsim	Türü	Description	Gerekli	Varsayılan
ajan adı	String	Aracının tanımlayıcısı.	Evet
model yapılandırması	InsightModelConfiguration	İçgörü oluşturmada kullanılan modelin yapılandırması.	Hayı
└─ modelDeploymentName	String	Değerlendirilecek model dağıtımı. Dağıtım adını tek başına veya bağlantı adı olarak {connectionName}/<modelDeploymentName>kabul eder.	Evet
type	enum	İstek türü. Olası değerler: AgentClusterInsight	Evet

AgentClusterInsightResult

Aracı küme analizinden elde edilen bilgiler.

İsim	Türü	Description	Gerekli	Varsayılan
clusterInsight	ClusterInsightResult	Küme analizinden elde edilen bilgiler.	Evet
type	enum	İçgörülerin türü sonucu. Olası değerler: AgentClusterInsight	Evet

AgentContainerObject

Bir aracının belirli bir sürümünün kapsayıcısının ayrıntıları.

İsim	Türü	Description	Gerekli	Varsayılan
container	ContainerDetails (salt okunur)	Kapsayıcı hakkında ayrıntılı bilgi.	Hayı
└─ health_state	String	Kapsayıcının sistem durumu.	Evet
└─ provisioning_error	String	Varsa kapsayıcının sağlama hatası.	Hayı
└─ provisioning_state	String	Kapsayıcının sağlama durumu.	Evet
└─ çoğaltmaları	ContainerReplica dizisi	Kapsayıcıdaki çoğaltmaların listesi.	Evet
└─ durumu	String	Konteynerin durumu.	Evet
└─ updated_on	String	Kapsayıcının son güncelleştirme zamanı.	Evet
oluşturulma_tarihi	String	Kapsayıcının oluşturma zamanı.	Evet
error_message	dize (salt okunur)	Varsa, kapsayıcı çalışamadıysa hata iletisi.	Hayı
kimlik	dize (salt okunur)	Kapsayıcının tanımlayıcısı.	Hayı
max_replicas	tamsayı	Kapsayıcı için en fazla çoğaltma sayısı. Varsayılan değer 1'dir.	Hayı
min_replicas	tamsayı	Kapsayıcı için en az çoğaltma sayısı. Varsayılan değer 1'dir.	Hayı
nesne	enum	Her zaman 'agent.container' olan nesne türü. Olası değerler: agent.container	Evet
durum	AgentContainerStatus (salt okunur)	Aracının belirli bir sürümünün kapsayıcısının durumu.	Evet
updated_at	String	Kapsayıcının son güncelleştirme zamanı.	Evet

AgentContainerOperationError

Varsa kapsayıcı işleminin hata ayrıntıları.

İsim	Türü	Description	Gerekli	Varsayılan
kod	String	Varsa kapsayıcı işleminin hata kodu.	Evet
mesaj	String	Varsa kapsayıcı işleminin hata iletisi.	Evet
type	String	Varsa kapsayıcı işleminin hata türü.	Evet

AgentContainerOperationObject

Bir aracının belirli bir sürümü için kapsayıcı işlemi.

İsim	Türü	Description	Gerekli	Varsayılan
agent_id	String	Aracının kimliği.	Evet
agent_version_id	String	Aracı sürümünün kimliği.	Evet
container	AgentContainerObject	Bir aracının belirli bir sürümünün kapsayıcısının ayrıntıları.	Hayı
└─ kapsayıcı	ContainerDetails (salt okunur)	Ayrıntılı kapsayıcı bilgileri.	Hayı
└─ oluşturulma_tarihi	dize (salt okunur)	Kapsayıcının oluşturma zamanı.	Evet
└─ error_message	dize (salt okunur)	Varsa, kapsayıcı çalışamadıysa hata iletisi.	Hayı
└─ kimlik	dize (salt okunur)	Kapsayıcının tanımlayıcısı.	Hayı
└─ max_replicas	tamsayı	Kapsayıcı için en fazla çoğaltma sayısı. Varsayılan değer 1'dir.	Hayı
└─ min_replicas	tamsayı	Kapsayıcı için en az çoğaltma sayısı. Varsayılan değer 1'dir.	Hayı
└─ nesne	enum	Her zaman 'agent.container' olan nesne türü. Olası değerler: agent.container	Evet
└─ durumu	AgentContainerStatus (salt okunur)	Aracının belirli bir sürümünün kapsayıcısının durumu.	Evet
└─ updated_at	dize (salt okunur)	Kapsayıcının son güncelleştirme zamanı.	Evet
hata	AgentContainerOperationError	Varsa kapsayıcı işleminin hata ayrıntıları.	Hayı
└─ kod	String	Varsa kapsayıcı işleminin hata kodu.	Evet
└─ ileti	String	Varsa kapsayıcı işleminin hata iletisi.	Evet
└─ türü	String	Varsa kapsayıcı işleminin hata türü.	Evet
kimlik	String	Kapsayıcı işleminin kimliği. Bu kimlik, sistem genelinde benzersiz bir tanımlayıcıdır.	Evet
durum	AgentContainerOperationStatus	Bir aracının belirli bir sürümü için kapsayıcı işleminin durumu.	Evet

AgentContainerOperationStatus

Bir aracının belirli bir sürümü için kapsayıcı işleminin durumu.

Mülkiyet	Değer
Türü	String
Değerler	NotStarted InProgress Succeeded Failed

AgentContainerStatus

Aracının belirli bir sürümünün kapsayıcısının durumu.

Mülkiyet	Değer
Türü	String
Değerler	Starting Running Stopping Stopped Failed Deleting Deleted Updating

AgentDefinition

AgentDefinition için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini kind kullanır:

Tür Değeri	Şema
prompt	PromptAgentDefinition
workflow	WorkflowAgentDefinition
hosted	HostedAgentDefinition
container_app	ContainerAppAgentDefinition

İsim	Türü	Description	Gerekli	Varsayılan
tür	AgentKind		Evet
rai_config	RaiConfig	Sorumlu Yapay Zeka (RAI) içerik filtreleme ve güvenlik özellikleri için yapılandırma.	Hayı
└─ rai_policy_name	String	Uygulanacak RAI politikasının adı.	Evet

AgentKind

Mülkiyet	Değer
Türü	String
Değerler	prompt hosted container_app workflow

AgentObject

İsim	Türü	Description	Gerekli	Varsayılan
kimlik	String	Aracının benzersiz tanımlayıcısı.	Evet
name	String	Aracının adı. Kısıtlamalar: maxLength: 63	Evet
nesne	enum	Her zaman 'aracı' olan nesne türü. Olası değerler: agent	Evet
versions	nesne	Ajanın en son sürümü.	Evet
└─ en son	AgentVersionObject		Evet

AgentProtocol

Mülkiyet	Değer
Türü	String
Değerler	activity_protocol responses

Temsilci Referansı

İsim	Türü	Description	Gerekli	Varsayılan
name	String	Aracının adı. Kısıtlamalar: maxLength: 256	Evet
type	enum	Olası değerler: agent_reference	Evet
version	String	Aracının sürüm tanımlayıcısı.	Hayı

AgentTaxonomyInput

Giriş türü aracı olduğunda değerlendirme taksonomisi için giriş yapılandırması.

İsim	Türü	Description	Gerekli	Varsayılan
risk Kategorileri	RiskCategory dizisi	Değerlendirilecek risk kategorilerinin listesi.	Evet
target	Hedef	Ayırıcı desteği olan hedefler için temel sınıf.	Evet
└─ türü	String	Hedefin türü.	Evet
type	enum	Değerlendirme taksonomisinin giriş türü. Olası değerler: agent	Evet

AgentTaxonomyInputUpdate

Giriş türü aracı olduğunda değerlendirme taksonomisi için giriş yapılandırması.

İsim	Türü	Description	Gerekli	Varsayılan
risk Kategorileri	RiskCategory dizisi	Değerlendirilecek risk kategorilerinin listesi.	Hayı
target	TargetUpdate	Ayırıcı desteği olan hedefler için temel sınıf.	Hayı
└─ türü	String	Hedefin türü.	Evet
type	enum	Değerlendirme taksonomisinin giriş türü. Olası değerler: agent	Evet

AgentVersionObject

İsim	Türü	Description	Gerekli	Varsayılan
oluşturulma_tarihi	tamsayı	Aracının oluşturulduğu Unix zaman damgası (saniye).	Evet
tanım	AgentDefinition		Evet
açıklama	String	Aracının insan tarafından okunabilir bir açıklaması. Kısıtlamalar: maxLength: 512	Hayı
kimlik	String	Aracı sürümünün benzersiz tanımlayıcısı.	Evet
metadata	object (null atanabilir)	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Evet
name	String	Aracının adı. Ad, aracıyı almak/güncellemek/silmek için kullanılabilir. Kısıtlamalar: maxLength: 256	Evet
nesne	enum	Her zaman 'agent.version' olan nesne türü. Olası değerler: agent.version	Evet
version	String	Aracının sürüm tanımlayıcısı. Aracılar değişmezdir ve her güncelleme, adı aynı tutarak yeni bir sürüm oluşturur.	Evet

AgenticIdentityPreviewCredentials

Aracı kimliği kimlik bilgisi tanımlaması

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Kimlik bilgisi türü Olası değerler: AgenticIdentityToken_Preview	Evet

ApiErrorResponse

API hataları için hata yanıtı.

İsim	Türü	Description	Gerekli	Varsayılan
hata	OpenAI.Error		Evet

ApiKeyCredentials

API Anahtarı Kimlik Bilgisi tanımı

İsim	Türü	Description	Gerekli	Varsayılan
key	dize (salt okunur)	API Anahtarı	Hayı
type	enum	Kimlik bilgisi türü Olası değerler: ApiKey	Evet

AssetCredentialResponse

Tüketim için bir blob başvurusunu temsil eder

İsim	Türü	Description	Gerekli	Varsayılan
blobReference	BlobReference	Blob başvuru ayrıntıları.	Evet
└─ blobUri	String	İstemcinin verileri karşıya yüklemesi için Blob URI yolu. Örnek: https://blob.windows.core.net/Container/Path	Evet
└─ kimlik bilgisi	SasCredential	storage hesabı access kimlik bilgileri.	Evet
└─ storageAccountArmId	String	Kullanılacak storage hesabının ARM ID'si.	Evet

Varlık Kimliği

Kaydedilmiş bir varlığın tanımlayıcısı.

Tür: dize

AttackStrategy

Saldırılar için stratejiler.

Mülkiyet	Değer
Açıklama	Saldırılar için stratejiler.
Türü	String
Değerler	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

Hata nesnesi.

İsim	Türü	Description	Gerekli	Varsayılan
kod	String	Sunucu tanımlı hata kodları kümesinden biri.	Evet
details	Azure dizi. Core.Foundations.Error	Bu bildirilen hataya yol açan belirli hatalar hakkında bir dizi ayrıntı.	Hayı
innererror	Azure. Core.Foundations.InnerError	Hata hakkında daha ayrıntılı bilgi içeren bir nesne. Azure REST API yönergelerine göre - https://aka.ms/AzureRestApiGuidelines#handling-errors.	Hayı
└─ kod	String	Sunucu tanımlı hata kodları kümesinden biri.	Hayı
└─ iç hata	Azure. Core.Foundations.InnerError	İç hata.	Hayı
mesaj	String	Hatanın insan tarafından okunabilir bir gösterimi.	Evet
target	String	Hatanın hedefi.	Hayı

Azure. Core.Foundations.ErrorResponse

Hata ayrıntılarını içeren bir yanıt.

İsim	Türü	Description	Gerekli	Varsayılan
hata	Azure. Core.Foundations.Error	Hata nesnesi.	Evet
└─ kod	String	Sunucu tanımlı hata kodları kümesinden biri.	Evet
└─ ayrıntılar	Azure dizi. Core.Foundations.Error	Bu bildirilen hataya yol açan belirli hatalar hakkında bir dizi ayrıntı.	Hayı
└─ iç hata	Azure. Core.Foundations.InnerError	Hatayla ilgili geçerli nesneden daha belirli bilgiler içeren bir nesne.	Hayı
└─ ileti	String	Hatanın insan tarafından okunabilir bir gösterimi.	Evet
└─ hedef	String	Hatanın hedefi.	Hayı

Azure. Core.Foundations.InnerError

Hata hakkında daha ayrıntılı bilgi içeren bir nesne. Azure REST API yönergelerine göre - https://aka.ms/AzureRestApiGuidelines#handling-errors.

İsim	Türü	Description	Gerekli	Varsayılan
kod	String	Sunucu tanımlı hata kodları kümesinden biri.	Hayı
innererror	Azure. Core.Foundations.InnerError	Hata hakkında daha ayrıntılı bilgi içeren bir nesne. Azure REST API yönergelerine göre - https://aka.ms/AzureRestApiGuidelines#handling-errors.	Hayı
└─ kod	String	Sunucu tanımlı hata kodları kümesinden biri.	Hayı
└─ iç hata	Azure. Core.Foundations.InnerError	İç hata.	Hayı

Azure. Core.Foundations.OperationState

İzin verilen işlem durumlarını açıklayan sabit listesi.

Mülkiyet	Değer
Açıklama	İzin verilen işlem durumlarını açıklayan sabit listesi.
Türü	String
Değerler	NotStarted Running Succeeded Failed Canceled

Azure. Core.uuid

Evrensel Olarak Benzersiz Tanımlayıcı

Tür: dize

Biçim: uuid

AzureAIAgentTarget

Bir Azure AI ajanı belirten bir hedefi temsil eder.

İsim	Türü	Description	Gerekli	Varsayılan
name	String	Azure AI ajanının benzersiz tanımlayıcısı.	Evet
tool_descriptions	ToolDescription dizisi	Metin oluşturma sırasında aracının örnekleme davranışını kontrol etmek için kullanılan parametreler.	Hayı
type	enum	Hedefin türü, her zaman azure_ai_agent. Olası değerler: azure_ai_agent	Evet
version	String	Azure AI ajanının versiyonu.	Hayı

AzureAIAgentTargetUpdate

Bir Azure AI ajanı belirten bir hedefi temsil eder.

İsim	Türü	Description	Gerekli	Varsayılan
name	String	Azure AI ajanının benzersiz tanımlayıcısı.	Hayı
tool_descriptions	ToolDescription dizisi	Metin oluşturma sırasında aracının örnekleme davranışını kontrol etmek için kullanılan parametreler.	Hayı
type	enum	Hedefin türü, her zaman azure_ai_agent. Olası değerler: azure_ai_agent	Evet
version	String	Azure AI ajanının versiyonu.	Hayı

AzureAIDataSourceConfig

İsim	Türü	Description	Gerekli	Varsayılan
senaryo	enum	Veri şeması senaryosu. Olası değerler: red_team, responses, traces_preview, synthetic_data_gen_preview	Evet
şema	nesne	Çalıştırma veri kaynağı öğeleri için genel nesne JSON şeması.	Evet
type	enum	Her zaman azure_ai_sourceolan nesne türü. Olası değerler: azure_ai_source	Evet

AzureAIModelTarget

Model seçimi gerektiren işlemler için bir Azure AI modeli belirten bir hedefi temsil eder.

İsim	Türü	Description	Gerekli	Varsayılan
model	String	Azure AI modelinin benzersiz tanımlayıcısı.	Hayı
Örnekleme_Parametreleri	ModelÖrnekLemeParamları	Metin oluşturma sırasında dil modelinin örnekleme davranışını denetlemek için kullanılan bir parametre kümesini temsil eder.	Hayı
└─ maksimum_önem_bitim_kodları	tamsayı	Tamamlanmada izin verilen en fazla belirteç sayısı.	Evet
└─ tohum	tamsayı	Yeniden üretilebilirlik için rastgele tohum.	Evet
└─ sıcaklık	Numara	Örnekleme için sıcaklık parametresi.	Evet
└─ top_p	Numara	Çekirdek örnekleme için top-p parametresi.	Evet
type	enum	Hedefin türü, her zaman azure_ai_model. Olası değerler: azure_ai_model	Evet

AzureAIModelTargetUpdate

Model seçimi gerektiren işlemler için bir Azure AI modeli belirten bir hedefi temsil eder.

İsim	Türü	Description	Gerekli	Varsayılan
model	String	Azure AI modelinin benzersiz tanımlayıcısı.	Hayı
Örnekleme_Parametreleri	ModelSamplingParamsUpdate	Metin oluşturma sırasında dil modelinin örnekleme davranışını denetlemek için kullanılan bir parametre kümesini temsil eder.	Hayı
└─ maksimum_önem_bitim_kodları	tamsayı	Tamamlanmada izin verilen en fazla belirteç sayısı.	Hayı
└─ tohum	tamsayı	Yeniden üretilebilirlik için rastgele tohum.	Hayı
└─ sıcaklık	Numara	Örnekleme için sıcaklık parametresi.	Hayı
└─ top_p	Numara	Çekirdek örnekleme için top-p parametresi.	Hayı
type	enum	Hedefin türü, her zaman azure_ai_model. Olası değerler: azure_ai_model	Evet

AzureAIResponsesEvalRunDataSource

Sürekli Değerlendirme senaryolarına özgü değerlendirme çalıştırmaları için bir veri kaynağını temsil eder.

İsim	Türü	Description	Gerekli	Varsayılan
event_configuration_id	String	Bu değerlendirme çalıştırmasıyla ilişkili olay yapılandırma adı.	Evet
item_generation_params	ResponseRetrievalItemGenerationParams	Yanıt alma öğesi oluşturma parametrelerini temsil eder.	Evet
└─ data_mapping	nesne	Sohbet geçmişini almak için gereken kaynak alanlardan response_id alanına eşleme.	Evet
└─ max_num_turns	tamsayı	Değerlendirilecek sohbet geçmişinin maksimum dönüş sayısı.	Evet
└─ kaynak	OpenAI.EvalJsonlFileContentSource veya OpenAI.EvalJsonlFileIdSource	JSONL içeriğinin okunduğu kaynak.	Evet
└─ türü	enum	Her zaman response_retrievalolan öğe oluşturma parametrelerinin türü. Olası değerler: response_retrieval	Evet
max_runs_hourly	tamsayı	Saat başına izin verilen en fazla değerlendirme çalıştırması sayısı.	Evet
type	enum	Her zaman azure_ai_responsesveri kaynağı türü. Olası değerler: azure_ai_responses	Evet

Azure AISearch Dizini

Azure AI Search Index Definition

İsim	Türü	Description	Gerekli	Varsayılan
kimlik	dize (salt okunur)	Öğe kimliği, öğe için benzersiz bir tanımlayıcı	Hayı
name	dize (salt okunur)	Kaynağın adı	Evet
type	enum	Endeks türü Olası değerler: AzureSearch	Evet
version	dize (salt okunur)	Kaynağın sürümü	Evet

AzureAISearchIndexUpdate

Azure AI Search Index Definition

İsim	Türü	Description	Gerekli	Varsayılan
açıklama	String	Varlık açıklaması metni.	Hayı
tags	nesne	Etiket sözlüğü. Etiketler eklenebilir, kaldırılabilir ve güncelleştirilebilir.	Hayı
type	enum	Endeks türü Olası değerler: AzureSearch	Evet

AzureAISearchQueryType

Azure AI Search tool için mevcut query types.

Mülkiyet	Değer
Açıklama	Azure AI Search tool için mevcut query types.
Türü	String
Değerler	simple semantic vector vector_simple_hybrid vector_semantic_hybrid

AzureAISearchTool

Bir ajanı yapılandırmak için kullanılan Azure AI search aracı için giriş tanımı bilgisi.

İsim	Türü	Description	Gerekli	Varsayılan
azure_ai_search	AzureAISearchToolResource	azure_ai_search aracı tarafından kullanılan dizin kaynakları kümesi.	Evet
└─ dizinler	AISearchIndexResource dizisi	Bu aracıya bağlı dizinler. En fazla 1 dizin olabilir aracıya bağlı kaynak. Kısıtlamalar: maxItems: 1	Evet
type	enum	Her zaman 'azure_ai_search' olan nesne türü. Olası değerler: azure_ai_search	Evet

AzureAISearchToolResource

azure_ai_search aracı tarafından kullanılan dizin kaynakları kümesi.

İsim	Türü	Description	Gerekli	Varsayılan
Dizin	AISearchIndexResource dizisi	Bu aracıya bağlı dizinler. En fazla 1 dizin olabilir aracıya bağlı kaynak.	Evet

AzureFunctionBinding

storage queue adı ve URI'nin korunması için kullanılan yapı.

İsim	Türü	Description	Gerekli	Varsayılan
storage_queue	AzureFunctionStorageQueue	storage queue adı ve URI'nin korunması için kullanılan yapı.	Evet
└─ queue_name	String	Bir Azure fonksiyon storage kuyruğunun adı.	Evet
└─ queue_service_endpoint	String	Azure Storage Queue hizmetine URI, kuyruğu işlemenizi sağlıyor.	Evet
type	enum	Her zaman 'storage_queue' olan bağlama türü. Olası değerler: storage_queue	Evet

AzureFunctionDefinition

Azure fonksiyonunun tanımı.

İsim	Türü	Description	Gerekli	Varsayılan
function	nesne	azure fonksiyonun tanımı ve parametreleri.	Evet
└─ açıklama	String	İşlevin ne zaman ve nasıl çağrıldığını seçmek için model tarafından kullanılan işlevin ne yaptığının açıklaması.	Hayı
└─ ad	String	Çağrılacak işlevin adı.	Evet
└─ parametreler	nesne	İşlevlerin kabullediği, JSON Şeması nesnesi olarak tanımlanan parametreler.	Evet
input_binding	AzureFunctionBinding	storage queue adı ve URI'nin korunması için kullanılan yapı.	Evet
└─ storage_queue	AzureFunctionStorageQueue	Storage kuyruğu.	Evet
└─ türü	enum	Her zaman 'storage_queue' olan bağlama türü. Olası değerler: storage_queue	Evet
output_binding	AzureFunctionBinding	storage queue adı ve URI'nin korunması için kullanılan yapı.	Evet
└─ storage_queue	AzureFunctionStorageQueue	Storage kuyruğu.	Evet
└─ türü	enum	Her zaman 'storage_queue' olan bağlama türü. Olası değerler: storage_queue	Evet

AzureFunctionStorageQueue

storage queue adı ve URI'nin korunması için kullanılan yapı.

İsim	Türü	Description	Gerekli	Varsayılan
queue_name	String	Bir Azure fonksiyon storage kuyruğunun adı.	Evet
queue_service_endpoint	String	Azure Storage Queue hizmetine URI, kuyruğu işlemenizi sağlıyor.	Evet

AzureFunctionTool

Bir Azure Fonksiyon Aracı için giriş tanım bilgileri, bir Ajanı yapılandırmak için kullanılan bilgiler.

İsim	Türü	Description	Gerekli	Varsayılan
azure_function	AzureFunctionDefinition	Azure fonksiyonunun tanımı.	Evet
└─ işlevi	nesne	azure fonksiyonun tanımı ve parametreleri.	Evet
└─ açıklama	String	İşlevin ne zaman ve nasıl çağrıldığını seçmek için model tarafından kullanılan işlevin ne yaptığının açıklaması.	Hayı
└─ ad	String	Çağrılacak işlevin adı.	Evet
└─ parametreler	nesne	İşlevlerin kabullediği, JSON Şeması nesnesi olarak tanımlanan parametreler.	Evet
└─ input_binding	AzureFunctionBinding	Giriş storage kuyruğu. Queue storage tetikleyicisi, mesajlar eklendikçe bir fonksiyon çalıştırır.	Evet
└─ output_binding	AzureFunctionBinding	Çıkış storage kuyruğu. İşlev, giriş öğeleri işlendiğinde çıkışı bu kuyruğa yazar.	Evet
type	enum	Her zaman 'browser_automation' olan nesne türü. Olası değerler: azure_function	Evet

AzureOpenAIModelConfiguration

Azure OpenAI model configuration. API sürümü, modeli sorgulamak için hizmet tarafından seçilir.

İsim	Türü	Description	Gerekli	Varsayılan
modelDeploymentName	String	AOAI modeli için dağıtım adı. Örnek: AIServices veya bağlantı tabanlı connection_name/deployment_name ise gpt-4o (örn. my-aoai-connection/gpt-4o	Evet
type	enum	Olası değerler: AzureOpenAIModel	Evet

BaseCredentials

Bağlantı kimlik bilgileri için bir temel sınıf

BaseCredentials için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
ApiKey	ApiKeyCredentials
AAD	EntraIDCredentials
CustomKeys	CustomCredential
SAS	SASCredentials
None	NoAuthenticationCredentials
AgenticIdentityToken_Preview	AgenticIdentityPreviewCredentials

İsim	Türü	Description	Gerekli	Varsayılan
type	CredentialType (salt okunur)	Bağlantı tarafından kullanılan kimlik bilgisi türü	Evet

BingCustomSearchConfiguration

Bir bing özel arama konfigürasyonu.

İsim	Türü	Description	Gerekli	Varsayılan
sayı	tamsayı	bing API yanıtında dönecek arama sonuç sayısı	Hayı
freshness	String	Arama sonuçlarını belirli bir zaman aralığına göre filtreleyin. Burada kabul edilen değerlere bakınız.	Hayı
instance_name	String	Yapılandırmaya verilen özel yapılandırma örneğinin adı.	Evet
pazar	String	Sonuçların geldiği pazar.	Hayı
project_connection_id	String	Project bağlantı kimliği bing arama ile topraklama için	Evet
set_lang	String	Bing API çağrılırken kullanıcı arayüzü dizileri için kullanılacak dil.	Hayı

BingCustomSearchPreviewTool

Bir ajanı yapılandırmak için kullanılan Bing özel arama aracı için giriş tanım bilgisi.

İsim	Türü	Description	Gerekli	Varsayılan
bing_custom_search_preview	BingCustomSearchToolParameters	bing özel arama aracı parametreleri.	Evet
└─ search_configurations	BingCustomSearchConfiguration dizisi	Bu araca bağlı proje bağlantıları. En fazla 1 bağlantı olabilir aracına bağlı kaynak. Kısıtlamalar: maxItems: 1	Evet
type	enum	Her zaman 'bing_custom_search_preview' olan nesne türü. Olası değerler: bing_custom_search_preview	Evet

BingCustomSearchToolParameters

bing özel arama aracı parametreleri.

İsim	Türü	Description	Gerekli	Varsayılan
search_configurations	BingCustomSearchConfiguration dizisi	Bu araca bağlı proje bağlantıları. En fazla 1 bağlantı olabilir aracına bağlı kaynak.	Evet

BingGroundingSearchConfiguration

Bing Topraklama için arama yapılandırması

İsim	Türü	Description	Gerekli	Varsayılan
sayı	tamsayı	bing API yanıtında dönecek arama sonuç sayısı	Hayı
freshness	String	Arama sonuçlarını belirli bir zaman aralığına göre filtreleyin. Burada kabul edilen değerlere bakınız.	Hayı
pazar	String	Sonuçların geldiği pazar.	Hayı
project_connection_id	String	Project bağlantı kimliği bing arama ile topraklama için	Evet
set_lang	String	Bing API çağrılırken kullanıcı arayüzü dizileri için kullanılacak dil.	Hayı

BingGroundingSearchToolParameters

bing topraklama arama aracı parametreleri.

İsim	Türü	Description	Gerekli	Varsayılan
search_configurations	BingGroundingSearchConfiguration dizisi	Bu araca eklenen arama yapılandırmaları. En fazla 1 olabilir ara çubuğuna bağlı arama yapılandırma kaynağı.	Evet

BingGroundingTool

Bir ajanı yapılandırmak için kullanılan bing topraklama arama aracı için giriş tanım bilgisi.

İsim	Türü	Description	Gerekli	Varsayılan
bing_grounding	BingGroundingSearchToolParameters	bing topraklama arama aracı parametreleri.	Evet
└─ search_configurations	BingGroundingSearchConfiguration dizisi	Bu araca eklenen arama yapılandırmaları. En fazla 1 olabilir ara çubuğuna bağlı arama yapılandırma kaynağı. Kısıtlamalar: maxItems: 1	Evet
type	enum	Her zaman 'bing_grounding' olan nesne türü. Olası değerler: bing_grounding	Evet

BlobReference

Blob başvuru ayrıntıları.

İsim	Türü	Description	Gerekli	Varsayılan
blobUri	String	İstemcinin verileri karşıya yüklemesi için Blob URI yolu. Örnek: https://blob.windows.core.net/Container/Path	Evet
credential	SasCredential	SAS Kimlik Bilgisi tanımı	Evet
└─ sasUri	dize (salt okunur)	SAS uri'si	Evet
└─ türü	enum	Kimlik bilgisi türü Olası değerler: SAS	Evet
storageAccountArmId	String	Kullanılacak storage hesabının ARM ID'si.	Evet

BrowserAutomationPreviewTool

Bir Aracıyı yapılandırmak için kullanılan bir Tarayıcı Otomasyon Aracı için giriş tanımı bilgileri.

İsim	Türü	Description	Gerekli	Varsayılan
browser_automation_preview	BrowserAutomationToolParameters	Tarayıcı Otomasyon Aracı için giriş parametrelerinin tanımı.	Evet
└─ bağlantı	BrowserAutomationToolConnectionParameters	Tarayıcı Otomasyon Aracı ile ilişkili proje bağlantı parametreleri.	Evet
type	enum	Nesne türü, ki bu her zaman 'browser_automation_preview' olur. Olası değerler: browser_automation_preview	Evet

BrowserAutomationToolConnectionParameters

Tarayıcı Otomasyon Aracı tarafından kullanılan bağlantı için giriş parametrelerinin tanımı.

İsim	Türü	Description	Gerekli	Varsayılan
project_connection_id	String	Azure Playwright kaynağınıza olan project bağlantısının kimliği.	Evet

BrowserAutomationToolParameters

Tarayıcı Otomasyon Aracı için giriş parametrelerinin tanımı.

İsim	Türü	Description	Gerekli	Varsayılan
bağlantı	BrowserAutomationToolConnectionParameters	Tarayıcı Otomasyon Aracı tarafından kullanılan bağlantı için giriş parametrelerinin tanımı.	Evet
└─ project_connection_id	String	Azure Playwright kaynağınıza olan project bağlantısının kimliği.	Evet

CaptureStructuredOutputsTool

Yapılandırılmış çıktıları yakalamak için bir araç

İsim	Türü	Description	Gerekli	Varsayılan
Çıktılar	StructuredOutputDefinition	Aracı tarafından üretilebilen yapılandırılmış bir çıkış.	Evet
└─ açıklama	String	Yayınlanacak çıkışın açıklaması. Çıktının ne zaman yayınlanacağını belirlemek için model tarafından kullanılır.	Evet
└─ ad	String	Yapılandırılmış çıkışın adı.	Evet
└─ şeması	nesne	Yapılandırılmış çıkış için JSON şeması.	Evet
└─ katı	boole değeri (null atanabilir)	Sıkı doğrulamanın uygulanıp uygulanmayacağı. Varsayılan true.	Evet
type	enum	Aracın türü. Her zaman capture_structured_outputs. Olası değerler: capture_structured_outputs	Evet

ChartCoordinate

Analiz tablosu için koordinatlar.

İsim	Türü	Description	Gerekli	Varsayılan
boyut	tamsayı	Grafik öğesinin boyutu.	Evet
x	tamsayı	X ekseni koordinatı.	Evet
y	tamsayı	Y ekseni koordinatı.	Evet

ChatSummaryMemoryItem

Konuşmalardan çıkarılan bir özet içeren bir bellek öğesi.

İsim	Türü	Description	Gerekli	Varsayılan
içerik	String	Belleğin içeriği.	Evet
tür	enum	Hafıza öğesinin türü. Olası değerler: chat_summary	Evet
memory_id	String	Bellek öğesinin benzersiz kimliği.	Evet
kapsam	String	Kullanıcı kimliği gibi anıları mantıksal olarak gruplandıran ve yalıtan ad alanı.	Evet
updated_at	tamsayı	Bellek öğesinin son güncelleme zamanı.	Evet

ClusterInsightResult

Küme analizinden elde edilen bilgiler.

İsim	Türü	Description	Gerekli	Varsayılan
clusters	InsightCluster dizisi	İçgörülerde tanımlanan kümelerin listesi.	Evet
koordinatlar	nesne	Kimliklerin görselleştirme için UX tarafından kullanılan 2B koordinatlara isteğe bağlı eşlenmesi. Eşleme anahtarları dize tanımlayıcılarıdır (örneğin, küme kimliği veya örnek kimlik) ve değerler, 2B grafik üzerinde işleme için koordinatlar ve görsel boyutlardır. İstemci koordinat istemediği sürece bu özellik atlanır (örneğin, bir sorgu parametresi olarak geçirerek includeCoordinates=true ). Örnek: <br> {<br> "cluster-1": { "x": 12, "y": 34, "size": 8 },<br> "sample-123": { "x": 18, "y": 22, "size": 4 }<br> }<br> Koordinatlar yalnızca istemci tarafı görselleştirme için tasarlanmıştır ve kurallı içgörü sonuçlarını değiştirin.	Hayı
summary	InsightSummary	Hata kümesi analizinin özeti.	Evet
└─ yöntemi	String	Kümeleme için kullanılan yöntem.	Evet
└─ sampleCount	tamsayı	Analiz edilen toplam numune sayısı.	Evet
└─ uniqueClusterCount	tamsayı	Benzersiz kümelerin toplam sayısı.	Evet
└─ uniqueSubclusterCount	tamsayı	Benzersiz alt küme etiketlerinin toplam sayısı.	Evet
└─ kullanımı	ClusterTokenUsage	Kümeleme analizi yapılırken belirteç kullanımı	Evet

ClusterTokenUsage

Küme analizi için belirteç kullanımı

İsim	Türü	Description	Gerekli	Varsayılan
inputTokenUsage	tamsayı	Giriş belirteci kullanımı	Evet
outputTokenUsage	tamsayı	Çıkış belirteci kullanımı	Evet
totalTokenUsage	tamsayı	Toplam jeton kullanımı	Evet

CodeBasedEvaluatorDefinition

Python kodunu kullanarak kod tabanlı değerlendirici tanımı

İsim	Türü	Description	Gerekli	Varsayılan
code_text	String	Değerlendirici için satır içi kod metni	Evet
data_schema	nesne	Değerlendiricinin giriş verileri için JSON şeması (Taslak 2020-12). Bu, tür, özellikler, gerekli gibi parametreleri içerir.	Hayı
init_parameters	nesne	Değerlendiricinin giriş parametreleri için JSON şeması (Taslak 2020-12). Bu, tür, özellikler, gerekli gibi parametreleri içerir.	Hayı
metrics	nesne	Bu değerlendirici tarafından üretilen çıktı metriklerinin listesi	Hayı
type	enum	Olası değerler: code	Evet

CompletionMessageToolCallChunk

bir iletinin içindeki araç arama ayrıntıları.

İsim	Türü	Description	Gerekli	Varsayılan
function	FunctionToolCall	İşlev aracı çağrısının ayrıntıları.	Hayı
└─ argümanlar	String	JSON biçiminde model tarafından oluşturulan işlevi çağırmak için bağımsız değişkenler.	Evet
└─ ad	String	Çağrılacak işlevin adı.	Evet
kimlik	String	Araç çağrısının kimliği.	Evet
type	enum	Her zaman "işlev" olan araç çağrısının türü. Olası değerler: function	Evet

Bağlantı

Listeden yanıt alma ve bağlantı alma işlemleri

İsim	Türü	Description	Gerekli	Varsayılan
credentials	BaseCredentials (salt okunur)	Bağlantı kimlik bilgileri için bir temel sınıf	Evet
└─ türü	CredentialType (salt okunur)	Bağlantı tarafından kullanılan kimlik bilgisi türü	Evet
kimlik	dize (salt okunur)	Hizmet tarafından oluşturulan bağlantı için benzersiz bir tanımlayıcı	Evet
Varsayılan	boole (salt okunur)	Bağlantının kendi türünde varsayılan bağlantı olarak etiketlenip etiketlenmediği	Evet
metadata	object (salt okunur)	Bağlantının meta verileri	Evet
name	dize (salt okunur)	Kullanıcı tarafından sağlanan bağlantının kolay adı.	Evet
target	dize (salt okunur)	Bu hizmet için kullanılacak bağlantı URL'si	Evet
type	ConnectionType (salt okunur)	Bağlantının Türü (veya kategorisi)	Evet

BağlantıTürü

Bağlantının Türü (veya kategorisi)

Mülkiyet	Değer
Açıklama	Bağlantının Türü (veya kategorisi)
Türü	String
Değerler	AzureOpenAI AzureBlob AzureStorageAccount CognitiveSearch CosmosDB ApiKey AppConfig AppInsights CustomKeys RemoteTool_Preview

ContainerAppAgentDefinition

Kapsayıcı uygulama aracısı tanımı.

İsim	Türü	Description	Gerekli	Varsayılan
container_app_resource_id	String	Bu ajanı barındıran Azure Container Uygulamasının kaynak kimliği. Sürümler arasında değiştirilemez.	Evet
container_protocol_versions	ProtocolVersionRecord dizisi	Aracının kapsayıcıların giriş iletişimi için desteklediği protokoller.	Evet
ingress_subdomain_suffix	String	Aracıya giriş gönderirken uygulama alt etki alanına uygulanacak sonek. Bu, kapsayıcı uygulamasının varsayılan uç noktasını kullanmak için bir etiket (örneğin, '---geçerli'), belirli bir düzeltme (örneğin, '--0000001') veya boş olabilir.	Evet
tür	enum	Olası değerler: container_app	Evet
rai_config	RaiConfig	Sorumlu Yapay Zeka (RAI) içerik filtreleme ve güvenlik özellikleri için yapılandırma.	Hayı
└─ rai_policy_name	String	Uygulanacak RAI politikasının adı.	Evet

ContainerDetails

Kapsayıcı hakkında ayrıntılı bilgi.

İsim	Türü	Description	Gerekli	Varsayılan
health_state	String	Kapsayıcının sistem durumu.	Evet
provisioning_error	String	Varsa kapsayıcının sağlama hatası.	Hayı
provisioning_state	String	Kapsayıcının sağlama durumu.	Evet
replicas	ContainerReplica dizisi	Kapsayıcıdaki çoğaltmaların listesi.	Evet
state	String	Konteynerin durumu.	Evet
updated_on	String	Kapsayıcının son güncelleştirme zamanı.	Evet

ContainerLogKind

Bir konteynerden akış yapacak kütük türü.

Mülkiyet	Değer
Türü	String
Değerler	console system

ContainerReplica

Kapsayıcı çoğaltması hakkında bilgi.

İsim	Türü	Description	Gerekli	Varsayılan
container_state	String	Çoğaltmanın kapsayıcı durumu.	Evet
name	String	Çoğaltmanın adı.	Evet
state	String	Çoğaltmanın durumu.	Evet

ContinuousEvaluationRuleAction

Sürekli değerlendirme için değerlendirme kuralı eylemi.

İsim	Türü	Description	Gerekli	Varsayılan
evalId	String	Sürekli değerlendirme çalıştırmaları eklemek için Değerlendirme Kimliği.	Evet
maxHourlyRuns	tamsayı	Saat başına izin verilen en fazla değerlendirme çalıştırması sayısı.	Hayı
type	enum	Olası değerler: continuousEvaluation	Evet

CosmosDB Dizini

CosmosDB Vektör Deposu Dizin Tanımı

İsim	Türü	Description	Gerekli	Varsayılan
kimlik	dize (salt okunur)	Öğe kimliği, öğe için benzersiz bir tanımlayıcı	Hayı
name	dize (salt okunur)	Kaynağın adı	Evet
type	enum	Endeks türü Olası değerler: CosmosDBNoSqlVectorStore	Evet
version	dize (salt okunur)	Kaynağın sürümü	Evet

CosmosDBIndexUpdate

CosmosDB Vektör Deposu Dizin Tanımı

İsim	Türü	Description	Gerekli	Varsayılan
açıklama	String	Varlık açıklaması metni.	Hayı
tags	nesne	Etiket sözlüğü. Etiketler eklenebilir, kaldırılabilir ve güncelleştirilebilir.	Hayı
type	enum	Endeks türü Olası değerler: CosmosDBNoSqlVectorStore	Evet

CreateAgentFromManifestRequest

İsim	Türü	Description	Gerekli	Varsayılan
açıklama	String	Aracının insan tarafından okunabilir bir açıklaması. Kısıtlamalar: maxLength: 512	Hayı
manifest_id	String	Aracı sürümünü içeri aktaracak bildirim kimliği.	Evet
metadata	nesne	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Hayı
name	String	Aracıyı tanımlayan benzersiz ad. Ad, aracıyı almak/güncellemek/silmek için kullanılabilir. - Alfasayısal karakterlerle başlayıp bitmelidir, - Ortada kısa çizgi içerebilir - 63 karakteri aşmamalıdır. Kısıtlamalar: maxLength: 63	Evet
parameter_values	nesne	Bildirime yapılan ve tam olarak gerçekleştirilmiş bir Aracı ile sonuçlanacak girişler.	Evet

CreateAgentRequest

İsim	Türü	Description	Gerekli	Varsayılan
tanım	AgentDefinition		Evet
└─ tür	AgentKind		Evet
└─ rai_config	RaiConfig	Sorumlu Yapay Zeka (RAI) içerik filtreleme ve güvenlik özellikleri için yapılandırma.	Hayı
açıklama	String	Aracının insan tarafından okunabilir bir açıklaması. Kısıtlamalar: maxLength: 512	Hayı
metadata	nesne	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Hayı
name	String	Aracıyı tanımlayan benzersiz ad. Ad, aracıyı almak/güncellemek/silmek için kullanılabilir. - Alfasayısal karakterlerle başlayıp bitmelidir, - Ortada kısa çizgi içerebilir - 63 karakteri aşmamalıdır. Kısıtlamalar: maxLength: 63	Evet

CreateAgentVersionFromManifestRequest

İsim	Türü	Description	Gerekli	Varsayılan
açıklama	String	Aracının insan tarafından okunabilir bir açıklaması. Kısıtlamalar: maxLength: 512	Hayı
manifest_id	String	Aracı sürümünü içeri aktaracak bildirim kimliği.	Evet
metadata	nesne	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Hayı
parameter_values	nesne	Bildirime yapılan ve tam olarak gerçekleştirilmiş bir Aracı ile sonuçlanacak girişler.	Evet

CreateAgentVersionRequest

İsim	Türü	Description	Gerekli	Varsayılan
tanım	AgentDefinition		Evet
└─ tür	AgentKind		Evet
└─ rai_config	RaiConfig	Sorumlu Yapay Zeka (RAI) içerik filtreleme ve güvenlik özellikleri için yapılandırma.	Hayı
açıklama	String	Aracının insan tarafından okunabilir bir açıklaması. Kısıtlamalar: maxLength: 512	Hayı
metadata	nesne	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Hayı

Değerlendirme İstek Oluştur

İsim	Türü	Description	Gerekli	Varsayılan
veri_kaynağı_yapılandırması	OpenAI.CreateEvalCustomDataSourceConfig veya OpenAI.CreateEvalLogsDataSourceConfig veya OpenAI.CreateEvalStoredCompletionsDataSourceConfig veya AzureAIDataSourceConfig	Değerlendirme için kullanılan veri kaynağının yapılandırması çalışır. Değerlendirmede kullanılan verilerin şemasını dikte eder.	Evet
metadata	OpenAI.Metadata (null atanabilir)	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Hayı
name	String	Değerlendirmenin adı.	Hayı
properties	nesne	Ek bilgileri depolamak için bir nesneye eklenebilen sabit 16 anahtar-değer çifti kümesi. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler, uzunluğu en fazla 512 karakter olan dizelerdir.	Hayı
test kriterleri	OpenAI.EvalGraderLabelModel veya OpenAI.EvalGraderStringCheck ya da OpenAI.EvalGraderTextSimilarity veya OpenAI.EvalGraderPython ya da OpenAI.EvalGraderScoreModel veya EvalGraderAzureAIEvaluator dizisi	Bu gruptaki tüm değerlendirme çalıştırmaları için değerlendirici listesi. Not verenler, gibi {{item.variable_name}}çift küme ayracı gösterimini kullanarak veri kaynağındaki değişkenlere başvurabilir. Modelin çıkışına başvurmak için ad alanını sample (örneğin, {{sample.output_text}}) kullanın.	Evet

Değerlendirme Çalışması İsteği Oluştur

İsim	Türü	Description	Gerekli	Varsayılan
veri_kaynağı	OpenAI.CreateEvalJsonlRunDataSource veya OpenAI.CreateEvalCompletionsRunDataSource veya OpenAI.CreateEvalResponsesRunDataSource veya EvalRunDataSource	Çalıştırmanın veri kaynağıyla ilgili ayrıntılar.	Evet
metadata	OpenAI.Metadata (null atanabilir)	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Hayı
name	String	Koşunun adı.	Hayı
properties	nesne	Ek bilgileri depolamak için bir nesneye eklenebilen sabit 16 anahtar-değer çifti kümesi. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler, uzunluğu en fazla 512 karakter olan dizelerdir.	Hayı

CredentialType

Bağlantı tarafından kullanılan kimlik bilgisi türü

Mülkiyet	Değer
Açıklama	Bağlantı tarafından kullanılan kimlik bilgisi türü
Türü	String
Değerler	ApiKey AAD SAS CustomKeys None AgenticIdentityToken_Preview

CronTrigger

Cron tabanlı tetikleyici.

İsim	Türü	Description	Gerekli	Varsayılan
endTime	String	ISO 8601 biçiminde cron zamanlaması için bitiş saati.	Hayı
ifade	String	Zamanlama sıklığını tanımlayan cron ifadesi.	Evet
startTime	String	ISO 8601 biçiminde cron zamanlaması için başlangıç saati.	Hayı
timeZone	String	Cron zamanlaması için saat dilimi.	Hayı	UTC (Koordinatlı Evrensel Zaman)
type	enum	Olası değerler: Cron	Evet

CustomCredential

Özel kimlik bilgisi tanımı

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Kimlik bilgisi türü Olası değerler: CustomKeys	Evet

Bu nesne şu tür ek özellikleri de kabul eder: dize

DailyRecurrenceSchedule

Günlük yineleme programı.

İsim	Türü	Description	Gerekli	Varsayılan
hours	tamsayı dizisi	Yinelenme zamanlaması için saatler.	Evet
type	enum	Günlük tekrarlama türü. Olası değerler: Daily	Evet

DataSourceConfig

Ayrıştırıcı desteğiyle veri kaynaklarını çalıştırmak için temel sınıf.

DataSourceConfig için Ayrıştırıcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema

İsim	Türü	Description	Gerekli	Varsayılan
şema	nesne	Çalıştırma veri kaynağı öğeleri için genel nesne JSON şeması.	Evet
type	String	Veri kaynağı türü ayrıştırıcısı.	Evet

DatasetType

Veri türünü belirlemek için sabit listesi.

Mülkiyet	Değer
Açıklama	Veri türünü belirlemek için sabit listesi.
Türü	String
Değerler	uri_file uri_folder

DatasetVersion

DatasetVersion Tanımı

DatasetVersion için Ayrıştırıcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
uri_file	FileDatasetVersion
uri_folder	FolderDatasetVersion

İsim	Türü	Description	Gerekli	Varsayılan
connectionName (bağlantıadı)	String	Azure Storage Account bağlantı adı. Veri Kümesi oluşturulmadan önce startPendingUploadVersion çağrılmadıysa gereklidir	Hayı
dataUri	String	Verilerin URI'si (örnek) Kısıtlamalar: minLength: 1, desen: [a-zA-Z0-9_]	Evet
kimlik	dize (salt okunur)	Öğe kimliği, öğe için benzersiz bir tanımlayıcı	Hayı
isReference	boole (salt okunur)	Veri setinin storage'a referans tuttuğunu veya veri setinin storage'ı kendisi yönetip yönetmediğini gösterir. Doğruysa, veri kümesi sürümü silindiğinde temel alınan veriler silinmez	Hayı
name	dize (salt okunur)	Kaynağın adı	Evet
type	DatasetType	Veri türünü belirlemek için sabit listesi.	Evet
version	dize (salt okunur)	Kaynağın sürümü	Evet

DatasetVersionUpdate

DatasetVersion Tanımı

DatasetVersionUpdate için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
uri_file	FileDatasetVersionUpdate
uri_folder	FolderDatasetVersionUpdate

İsim	Türü	Description	Gerekli	Varsayılan
açıklama	String	Varlık açıklaması metni.	Hayı
tags	nesne	Etiket sözlüğü. Etiketler eklenebilir, kaldırılabilir ve güncelleştirilebilir.	Hayı
type	DatasetType	Veri türünü belirlemek için sabit listesi.	Evet

HaftanınGünü

Tekrarlama zamanlaması için haftanın günleri.

Mülkiyet	Değer
Açıklama	Tekrarlama zamanlaması için haftanın günleri.
Türü	String
Değerler	Sunday Monday Tuesday Wednesday Thursday Friday Saturday

DeleteAgentResponse

Silinmiş bir aracı Nesnesi

İsim	Türü	Description	Gerekli	Varsayılan
silindi	Boolean	Aracının başarıyla silinip silinmediği.	Evet
name	String	Aracının adı.	Evet
nesne	enum	Nesne türü. Her zaman 'agent.deleted'. Olası değerler: agent.deleted	Evet

DeleteAgentVersionResponse

Silinmiş bir aracı sürümü Nesnesi

İsim	Türü	Description	Gerekli	Varsayılan
silindi	Boolean	Aracının başarıyla silinip silinmediği.	Evet
name	String	Aracının adı.	Evet
nesne	enum	Nesne türü. Her zaman 'agent.version.deleted'. Olası değerler: agent.version.deleted	Evet
version	String	Aracının sürüm tanımlayıcısı.	Evet

DeleteEvalResponse

Silinen değerlendirme Nesnesi

İsim	Türü	Description	Gerekli	Varsayılan
silindi	Boolean	Değerlendirmenin başarıyla silinip silinmediği.	Evet
eval_id	String	değerlendirmenin kimliği.	Evet
nesne	enum	Nesne türü. Her zaman 'eval.deleted'. Olası değerler: eval.deleted	Evet

DeleteEvalRunResponse

Silinen değerlendirme çalıştırma nesnesi.

İsim	Türü	Description	Gerekli	Varsayılan
silindi	Boolean	Değerlendirmenin başarıyla silinip silinmediği.	Hayı
nesne	enum	Nesne türü. Her zaman 'eval.deleted'. Olası değerler: eval.deleted	Hayı
run_id	String	değerlendirmenin kimliği.	Hayı

DeleteMemoryStoreResponse

İsim	Türü	Description	Gerekli	Varsayılan
silindi	Boolean	Bellek deposunun başarıyla silinip silinmediği.	Evet
name	String	Bellek deposunun adı.	Evet
nesne	enum	Nesne türü. Her zaman 'memory_store.deleted'. Olası değerler: memory_store.deleted	Evet

DeleteResponseResult

Yanıt silme işleminin sonucu.

İsim	Türü	Description	Gerekli	Varsayılan
silindi	enum	Her zaman true döndür Olası değerler: True	Evet
kimlik	String	İşlem kimliği.	Evet
nesne	enum	Her zaman 'yanıt' döndür. Olası değerler: response	Evet

Dağıtım

Model Dağıtım Tanımı

Dağıtım için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
ModelDeployment	ModelDeployment

İsim	Türü	Description	Gerekli	Varsayılan
name	dize (salt okunur)	Dağıtımın adı	Evet
type	Deploymenttype		Evet

Deploymenttype

Mülkiyet	Değer
Türü	String
Değerler	ModelDeployment

EntraIDCredentials

Entra ID kimlik bilgisi tanımı

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Kimlik bilgisi türü Olası değerler: AAD	Evet

Değerlendirme

Veri kaynağı yapılandırması ve test ölçütlerine sahip bir Değerlendirme nesnesi. Değerlendirme, LLM tümleştirmeniz için yapılacak bir görevi temsil eder. Gibi:

• Sohbet botlarımın kalitesini artırma
• Sohbet botlarımın müşteri desteğini ne kadar iyi işlediğini görün
• O4-mini'nin benim kullanım alanımda gpt-4o'dan daha iyi olup olmadığını denetleyin

İsim	Türü	Description	Gerekli	Varsayılan
oluşturulma_tarihi	tamsayı	Değerlendirmenin oluşturulduğu zaman için Unix zaman damgası (saniye olarak).	Evet
Oluşturan	String	çalıştırmayı oluşturan kişinin adı.	Hayı
veri_kaynağı_yapılandırması	OpenAI.CreateEvalCustomDataSourceConfig veya OpenAI.CreateEvalLogsDataSourceConfig veya OpenAI.CreateEvalStoredCompletionsDataSourceConfig veya AzureAIDataSourceConfig	Değerlendirme çalıştırmalarında kullanılan veri kaynaklarının yapılandırması.	Evet
kimlik	String	Değerlendirme için benzersiz tanımlayıcı.	Evet
metadata	OpenAI.Metadata (null atanabilir)	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Evet
modified_at	integer		Hayı
name	String	Değerlendirmenin adı.	Evet
nesne	enum	Nesne türü. Olası değerler: eval	Evet
properties	nesne	Ek bilgileri depolamak için bir nesneye eklenebilen sabit 16 anahtar-değer çifti kümesi. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler, uzunluğu en fazla 512 karakter olan dizelerdir.	Hayı
test kriterleri	OpenAI.EvalGraderLabelModel veya OpenAI.EvalGraderStringCheck ya da OpenAI.EvalGraderTextSimilarity veya OpenAI.EvalGraderPython ya da OpenAI.EvalGraderScoreModel veya EvalGraderAzureAIEvaluator dizisi	Test ölçütlerinin listesi.	Evet

EvalCsvFileIdSource

Değerlendirme verileri için kaynak olarak kullanılan karşıya yüklenen CSV dosyasına başvuruyu temsil eder.

İsim	Türü	Description	Gerekli	Varsayılan
kimlik	String	Karşıya yüklenen CSV dosyasının tanımlayıcısı.	Evet
type	enum	Kaynak türü, her zaman file_id. Olası değerler: file_id	Evet

EvalCsvRunDataSource

Değerlendirme çalıştırmaları için csv veri kaynağını temsil eder.

İsim	Türü	Description	Gerekli	Varsayılan
kaynak	EvalCsvFileIdSource	Değerlendirme verileri için kaynak olarak kullanılan karşıya yüklenen CSV dosyasına başvuruyu temsil eder.	Evet
└─ kimlik	String	Karşıya yüklenen CSV dosyasının tanımlayıcısı.	Evet
└─ türü	enum	Kaynak türü, her zaman file_id. Olası değerler: file_id	Evet
type	enum	Her zaman csvveri kaynağı türü. Olası değerler: csv	Evet

EvalGraderAzureAIEvaluator

İsim	Türü	Description	Gerekli	Varsayılan
veri eşleme	nesne	Değerlendirme için kullanılacak model. Yapılandırılmış çıktıları destekleme zorunluluğu vardır.	Hayı
evaluator_name	String	Değerlendiricinin adı.	Evet
evaluator_version	String	Değerlendiricinin sürümü. Belirtilmezse en son sürüm.	Hayı
initialization_parameters	nesne	Değerlendirme için başlatma parametreleri. Yapılandırılmış çıktıları destekleme zorunluluğu vardır.	Hayı
name	String	Değerlendiricinin adı.	Evet
type	enum	Her zaman azure_ai_evaluatorolan nesne türü. Olası değerler: azure_ai_evaluator	Evet

EvalResult

Değerlendirme sonucu.

İsim	Türü	Description	Gerekli	Varsayılan
name	String	Çekin adı	Evet
Geçirilen	Boolean	kontrolün başarılı olup olmadığını gösterir	Evet
Puan	Numara	Puan	Evet
type	String	Çekin türü	Evet

EvalRun

Değerlendirme oturumunu temsil eden şema.

İsim	Türü	Description	Gerekli	Varsayılan
oluşturulma_tarihi	tamsayı	Değerlendirme çalıştırması oluşturulduğunda Unix zaman damgası (saniye olarak).	Evet
Oluşturan	String	çalıştırmayı oluşturan kişinin adı.	Hayı
veri_kaynağı	OpenAI.CreateEvalJsonlRunDataSource veya OpenAI.CreateEvalCompletionsRunDataSource veya OpenAI.CreateEvalResponsesRunDataSource veya EvalRunDataSource	Çalıştırmanın veri kaynağı hakkında bilgi.	Evet
hata	OpenAI.EvalApiError	Değerlendirme API'sinden bir hata yanıtını temsil eden nesne.	Evet
eval_id	String	İlişkili değerlendirmenin tanımlayıcısı.	Evet
kimlik	String	Değerlendirme çalışması için benzersiz tanımlayıcı.	Evet
metadata	OpenAI.Metadata (null atanabilir)	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Evet
model	String	Değerlendirilen model, eğer uygulanabiliyorsa.	Evet
modified_at	integer		Hayı
name	String	Değerlendirme çalıştırmasının adı.	Evet
nesne	enum	Nesnenin türü. Her zaman "eval.run". Olası değerler: eval.run	Evet
model_başına_kullanım	OpenAI.EvalRunPerModelUsage dizisi	Değerlendirme çalıştırması sırasında her model için kullanım istatistikleri.	Evet
test_kriterlerine_göre_sonuçlar	OpenAI.EvalRunPerTestingCriteriaResults dizisi	Değerlendirme çalıştırması sırasında uygulanan test kriterlerine göre sonuçlar.	Evet
properties	nesne	Ek bilgileri depolamak için bir nesneye eklenebilen sabit 16 anahtar-değer çifti kümesi. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler, uzunluğu en fazla 512 karakter olan dizelerdir.	Hayı
rapor_url	String	kullanıcı arabirimi panosunda görüntülenen değerlendirme raporunun URL'si.	Evet
sonuç_sayıları	OpenAI.EvalRunResultCounts		Evet
└─ hata	OpenAI.integer		Evet
└─ başarısız oldu	OpenAI.integer		Evet
└─ geçti	OpenAI.integer		Evet
└─ toplam	OpenAI.integer		Evet
durum	String	Çalıştırma değerlendirmesinin durumu.	Evet

EvalRunDataSource

Ayrıştırıcı desteğiyle veri kaynaklarını çalıştırmak için temel sınıf.

EvalRunDataSource için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
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

İsim	Türü	Description	Gerekli	Varsayılan
type	String	Veri kaynağı türü ayrıştırıcısı.	Evet

EvalRunOutputItem

Değerlendirme çalıştırmasının çıkış öğesini temsil eden bir şema.

İsim	Türü	Description	Gerekli	Varsayılan
oluşturulma_tarihi	tamsayı	Değerlendirme çalıştırması oluşturulduğunda Unix zaman damgası (saniye olarak).	Evet
veri kaynağı öğesi	nesne	Giriş veri kaynağı öğesinin ayrıntıları.	Evet
veri_kaynağı_öğe_kimliği	OpenAI.integer		Evet
eval_id	String	Değerlendirme grubunun tanımlayıcısı.	Evet
kimlik	String	Değerlendirme çalıştırma çıkış öğesinin benzersiz tanımlayıcısı.	Evet
nesne	enum	Nesnenin türü. Her zaman "eval.run.output_item". Olası değerler: eval.run.output_item	Evet
results	EvalRunOutputItemResult dizisi	Bu çıkış öğesi için not veren sonuçlarının listesi.	Evet
run_id	String	Bu çıkış öğesiyle ilişkili değerlendirme çalıştırmasının tanımlayıcısı.	Evet
örnek	OpenAI.EvalRunOutputItemSample		Evet
└─ hata	OpenAI.EvalApiError	Değerlendirme API'sinden bir hata yanıtını temsil eden nesne.	Evet
└─ bitiş_nedeni	String		Evet
└─ giriş	EvalRunOutputItemSampleInput dizisi		Evet
└─ maksimum_önem_bitim_kodları	OpenAI.integer		Evet
└─ modeli	String		Evet
└─ çıkış	EvalRunOutputItemSampleOutput dizisi		Evet
└─ tohum	OpenAI.integer		Evet
└─ sıcaklık	OpenAI.numeric		Evet
└─ top_p	OpenAI.numeric		Evet
└─ kullanımı	OpenAI.EvalRunOutputItemSampleUsage		Evet
durum	String	Çalıştırma değerlendirmesinin durumu.	Evet

EvalRunOutputItemResult

Değerlendirme çalıştırması çıkış öğesi için tek bir not veren sonucu.

İsim	Türü	Description	Gerekli	Varsayılan
label	String	Test ölçütü ölçümüyle ilişkili etiket (örneğin, "pass", "fail", "good", "bad").	Hayı
metric	String	Ölçümün adı (örneğin, "akıcılık", "f1_score").	Hayı
name	String	Değerlendiricinin adı.	Evet
Geçirilen	Boolean	Not verenin çıkışı bir geçiş olarak değerlendirip değerlendirmediği.	Evet
properties	nesne	Test ölçütleri ölçümü hakkında ek ayrıntılar.	Hayı
sebep	String	Test ölçütleri ölçüm nedeni.	Hayı
örnek	object (null atanabilir)	Not veren tarafından üretilen isteğe bağlı örnek veya ara veriler.	Hayı
Puan	OpenAI.numeric		Evet
threshold	Numara	Sayısalsa, bu test ölçütlerinin başarılı/başarısız olduğunu belirlemek için kullanılan eşik.	Hayı
type	String	Not veren türü (örneğin, "string-check-grader").	Hayı

Bu nesne ek özellikleri de kabul eder.

EvalRunOutputItemSampleInput

Değerlendirme çalıştırmasında bir ileti.

İsim	Türü	Description	Gerekli	Varsayılan
içerik	String		Evet
role	String		Evet
tool_calls	CompletionMessageToolCallChunk dizisi	Varsa, ileti içinde yapılan araç çağrıları.	Evet

EvalRunOutputItemSampleOutput

Değerlendirme çalıştırmasında bir ileti.

İsim	Türü	Description	Gerekli	Varsayılan
içerik	String		Hayı
role	String		Hayı
tool_calls	CompletionMessageToolCallChunk dizisi	Varsa, ileti içinde yapılan araç çağrıları.	Evet

EvalRunResultCompareItem

Bir tedavi için taban çizgisine karşı metrik karşılaştırma.

İsim	Türü	Description	Gerekli	Varsayılan
deltaEstimate	Numara	Tedavi ve başlangıç arasındaki tahmini fark.	Evet
pValue	Numara	Tedavi etkisi için P değeri.	Evet
treatmentEffect	TreatmentEffectType	Tedavi Etki Türü.	Evet
treatmentRunId	String	Tedavi çalıştırma kimliği.	Evet
treatmentRunSummary	EvalRunResultSummary	Değerlendirme çalıştırmasındaki bir ölçümün özet istatistikleri.	Evet
└─ ortalama	Numara	Değerlendirme çalıştırmasındaki ölçümün ortalama değeri.	Evet
└─ runId	String	Değerlendirme çalıştırma kimliği.	Evet
└─ sampleCount	tamsayı	Değerlendirme çalıştırmasındaki örnek sayısı.	Evet
└─ standardDeviation	Numara	Değerlendirme çalıştırmasında metriğin standart sapması.	Evet

EvalRunResultComparison

Tedavi için karşılaştırma sonuçları taban çizgisine göre çalışır.

İsim	Türü	Description	Gerekli	Varsayılan
baselineRunSummary	EvalRunResultSummary	Değerlendirme çalıştırmasındaki bir ölçümün özet istatistikleri.	Evet
└─ ortalama	Numara	Değerlendirme çalıştırmasındaki ölçümün ortalama değeri.	Evet
└─ runId	String	Değerlendirme çalıştırma kimliği.	Evet
└─ sampleCount	tamsayı	Değerlendirme çalıştırmasındaki örnek sayısı.	Evet
└─ standardDeviation	Numara	Değerlendirme çalıştırmasında metriğin standart sapması.	Evet
compareItems	EvalRunResultCompareItem dizisi	Her tedavi çalışması için karşılaştırma sonuçlarının listesi.	Evet
Değerlendir -ici	String	Bu test kriteri için değerlendiricinin adı.	Evet
metric	String	Metrik değerlendiriliyor.	Evet
testingCriteria	String	Test kriterlerinin adı.	Evet

EvalRunResultSummary

Değerlendirme çalıştırmasındaki bir ölçümün özet istatistikleri.

İsim	Türü	Description	Gerekli	Varsayılan
ortalama	Numara	Değerlendirme çalıştırmasındaki ölçümün ortalama değeri.	Evet
runId	String	Değerlendirme çalıştırma kimliği.	Evet
sampleCount	tamsayı	Değerlendirme çalıştırmasındaki örnek sayısı.	Evet
standardDeviation	Numara	Değerlendirme çalıştırmasında metriğin standart sapması.	Evet

EvaluationComparisonInsightRequest

Değerlendirme Karşılaştırma İsteği

İsim	Türü	Description	Gerekli	Varsayılan
baselineRunId	String	Karşılaştırma için temel çalıştırma kimliği.	Evet
evalId	String	Değerlendirme için tanımlayıcı.	Evet
treatmentRunIds	dize dizisi	Karşılaştırma için tedavi çalıştırma kimliklerinin listesi.	Evet
type	enum	İstek türü. Olası değerler: EvaluationComparison	Evet

EvaluationComparisonInsightResult

Değerlendirme karşılaştırmasından elde edilen bilgiler.

İsim	Türü	Description	Gerekli	Varsayılan
Karşılaştırma	EvalRunResultComparison dizisi	Her tedavi için karşılaştırma sonuçları taban çizgisine göre çalışır.	Evet
method	String	Karşılaştırma için kullanılan istatistiksel yöntem.	Evet
type	enum	İçgörülerin türü sonucu. Olası değerler: EvaluationComparison	Evet

EvaluationResultSample

Değerlendirme sonucundan bir örnek.

İsim	Türü	Description	Gerekli	Varsayılan
correlationInfo	nesne	Analiz örneğinin korelasyonu hakkında bilgi.	Evet
evaluationResult	EvalResult	Değerlendirme sonucu.	Evet
└─ ad	String	Çekin adı	Evet
└─ geçti	Boolean	kontrolün başarılı olup olmadığını gösterir	Evet
└─ puanı	Numara	Puan	Evet
└─ türü	String	Çekin türü	Evet
features	nesne	UX'te verilerin ek filtrelenmesine yardımcı olacak özellikler.	Evet
kimlik	String	Analiz örneğinin benzersiz tanımlayıcısı.	Evet
type	enum	Değerlendirme Sonucu Örnek Türü Olası değerler: EvaluationResultSample	Evet

Değerlendirme Kuralı

Değerlendirme kuralı modeli.

İsim	Türü	Description	Gerekli	Varsayılan
hareket	EvaluationRuleAction	Değerlendirme eylem modeli.	Evet
└─ türü	EvaluationRuleActionType	Değerlendirme eyleminin türü.	Evet
açıklama	String	Değerlendirme kuralının açıklaması.	Hayı
ekran adı	String	Değerlendirme kuralı için Görünen Ad.	Hayı
etkinleştirildi	Boolean	Değerlendirme kuralının etkin olup olmadığını gösterir. Varsayılan değer doğrudur	Evet
eventType	EvaluationRuleEventType	Değerlendirme kuralı olayının türü.	Evet
filtre	EvaluationRuleFilter	Değerlendirme filtresi modeli.	Hayı
└─ ajanName	String	Müşteri temsilcisi adına göre filtreleyin.	Evet
kimlik	dize (salt okunur)	Değerlendirme kuralı için benzersiz tanımlayıcı.	Evet
sistem verileri	object (salt okunur)	Değerlendirme kuralı için sistem meta verileri.	Evet

EvaluationRuleAction

Değerlendirme eylem modeli.

EvaluationRuleAction için Ayrıştırıcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
continuousEvaluation	ContinuousEvaluationRuleAction
humanEvaluationPreview	HumanEvaluationPreviewRuleAction

İsim	Türü	Description	Gerekli	Varsayılan
type	EvaluationRuleActionType	Değerlendirme eyleminin türü.	Evet

EvaluationRuleActionType

Değerlendirme eyleminin türü.

Mülkiyet	Değer
Açıklama	Değerlendirme eyleminin türü.
Türü	String
Değerler	continuousEvaluation humanEvaluationPreview

EvaluationRuleEventType

Değerlendirme kuralı olayının türü.

Mülkiyet	Değer
Açıklama	Değerlendirme kuralı olayının türü.
Türü	String
Değerler	responseCompleted manual

EvaluationRuleFilter

Değerlendirme filtresi modeli.

İsim	Türü	Description	Gerekli	Varsayılan
ajan adı	String	Müşteri temsilcisi adına göre filtreleyin.	Evet

EvaluationRunClusterInsightRequest

Değerlendirme Sonuçları kümesine ilişkin içgörüler

İsim	Türü	Description	Gerekli	Varsayılan
evalId	String	İçgörüler için Değerlendirme Kimliği.	Evet
model yapılandırması	InsightModelConfiguration	İçgörü oluşturmada kullanılan modelin yapılandırması.	Hayı
└─ modelDeploymentName	String	Değerlendirilecek model dağıtımı. Dağıtım adını tek başına veya bağlantı adı olarak {connectionName}/<modelDeploymentName>kabul eder.	Evet
runId'ler	dize dizisi	İçgörüler için değerlendirme çalıştırma kimliklerinin listesi.	Evet
type	enum	İçgörü isteğinin türü. Olası değerler: EvaluationRunClusterInsight	Evet

EvaluationRunClusterInsightResult

Değerlendirmeden elde edilen içgörüler küme analizini çalıştırır.

İsim	Türü	Description	Gerekli	Varsayılan
clusterInsight	ClusterInsightResult	Küme analizinden elde edilen bilgiler.	Evet
type	enum	İçgörülerin türü sonucu. Olası değerler: EvaluationRunClusterInsight	Evet

EvaluationScheduleTask

Zamanlama için değerlendirme görevi.

İsim	Türü	Description	Gerekli	Varsayılan
configuration	nesne	Görev için yapılandırma.	Hayı
evalId	String	Değerlendirme grubunun tanımlayıcısı.	Evet
evalRun	nesne	Değerlendirme çalıştırma yükü.	Evet
type	enum	Olası değerler: Evaluation	Evet

EvaluationTaxonomy

Değerlendirme Taksonomisi Tanımı

İsim	Türü	Description	Gerekli	Varsayılan
kimlik	dize (salt okunur)	Öğe kimliği, öğe için benzersiz bir tanımlayıcı	Hayı
name	dize (salt okunur)	Kaynağın adı	Evet
properties	nesne	Değerlendirme taksonomisi için ek özellikler.	Hayı
taksonomi Kategorileri	TaxonomyCategory dizisi	Taksonomi kategorilerinin listesi.	Hayı
taksonomiInput	EvaluationTaxonomyInput	Değerlendirme taksonomisi için giriş yapılandırması.	Evet
└─ türü	EvaluationTaxonomyInputType	Değerlendirme taksonomisinin giriş türü.	Evet
version	dize (salt okunur)	Kaynağın sürümü	Evet

EvaluationTaxonomyCreateOrUpdate

Değerlendirme Taksonomisi Tanımı

İsim	Türü	Description	Gerekli	Varsayılan
açıklama	String	Varlık açıklaması metni.	Hayı
properties	nesne	Değerlendirme taksonomisi için ek özellikler.	Hayı
tags	nesne	Etiket sözlüğü. Etiketler eklenebilir, kaldırılabilir ve güncelleştirilebilir.	Hayı
taksonomi Kategorileri	TaxonomyCategory dizisi	Taksonomi kategorilerinin listesi.	Hayı
taksonomiInput	EvaluationTaxonomyInput	Değerlendirme taksonomisi için giriş yapılandırması.	Evet
└─ türü	EvaluationTaxonomyInputType	Değerlendirme taksonomisinin giriş türü.	Evet

EvaluationTaxonomyInput

Değerlendirme taksonomisi için giriş yapılandırması.

EvaluationTaxonomyInput için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
agent	AgentTaxonomyInput

İsim	Türü	Description	Gerekli	Varsayılan
type	EvaluationTaxonomyInputType	Değerlendirme taksonomisi girişinin türü.	Evet

EvaluationTaxonomyInputType

Değerlendirme taksonomisi girişinin türü.

Mülkiyet	Değer
Açıklama	Değerlendirme taksonomisi girişinin türü.
Türü	String
Değerler	agent policy

EvaluationTaxonomyInputUpdate

Değerlendirme taksonomisi için giriş yapılandırması.

EvaluationTaxonomyInputUpdate için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
agent	AgentTaxonomyInputUpdate

İsim	Türü	Description	Gerekli	Varsayılan
type	EvaluationTaxonomyInputType	Değerlendirme taksonomisi girişinin türü.	Evet

EvaluationTaxonomyUpdate

Değerlendirme Taksonomisi Tanımı

İsim	Türü	Description	Gerekli	Varsayılan
açıklama	String	Varlık açıklaması metni.	Hayı
properties	nesne	Değerlendirme taksonomisi için ek özellikler.	Hayı
tags	nesne	Etiket sözlüğü. Etiketler eklenebilir, kaldırılabilir ve güncelleştirilebilir.	Hayı
taksonomi Kategorileri	TaxonomyCategory dizisi	Taksonomi kategorilerinin listesi.	Hayı
taksonomiInput	EvaluationTaxonomyInputUpdate	Değerlendirme taksonomisi için giriş yapılandırması.	Hayı
└─ türü	EvaluationTaxonomyInputType	Değerlendirme taksonomisinin giriş türü.	Evet

DeğerlendiriciKategorisi

Değerlendiricinin kategorisi

Mülkiyet	Değer
Açıklama	Değerlendiricinin kategorisi
Türü	String
Değerler	quality safety agents

DeğerlendiriciDefinition

Ayırıcılı temel değerlendirici konfigürasyonu

DeğerlendiriciDefinition için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
code	CodeBasedEvaluatorDefinition
prompt	PromptBasedEvaluatorDefinition

İsim	Türü	Description	Gerekli	Varsayılan
data_schema	nesne	Değerlendiricinin giriş verileri için JSON şeması (Taslak 2020-12). Bu, tür, özellikler, gerekli gibi parametreleri içerir.	Hayı
init_parameters	nesne	Değerlendiricinin giriş parametreleri için JSON şeması (Taslak 2020-12). Bu, tür, özellikler, gerekli gibi parametreleri içerir.	Hayı
metrics	nesne	Bu değerlendirici tarafından üretilen çıktı metriklerinin listesi	Hayı
type	EvaluatorDefinitionType	Değerlendirici tanımının türü	Evet

EvaluatorDefinitionType

Değerlendirici tanımının türü

Mülkiyet	Değer
Açıklama	Değerlendirici tanımının türü
Türü	String
Değerler	prompt code prompt_and_code service openai_graders

DeğerlendiriciÖlçerÖlçer

Değerlendirici Metriği

İsim	Türü	Description	Gerekli	Varsayılan
desirable_direction	DeğerlendiriciMetricDirection	Daha yüksek bir değerin daha iyi, daha düşük bir değerin daha iyi veya nötr olup olmadığını gösteren metriğin yönü	Hayı
is_primary	Boolean	Birden çok ölçüm olduğunda bu ölçümün birincil olup olmadığını gösterir.	Hayı
max_value	Numara	Ölçüm için en yüksek değer. Belirtilmezse, sınırsız olduğu varsayılır.	Hayı
min_value	Numara	Metrik için minimum değer	Hayı
type	DeğerlendiriciMetricType	Değerlendiricinin türü	Hayı

DeğerlendiriciMetricDirection

Daha yüksek bir değerin daha iyi, daha düşük bir değerin daha iyi veya nötr olup olmadığını gösteren metriğin yönü

Mülkiyet	Değer
Açıklama	Daha yüksek bir değerin daha iyi, daha düşük bir değerin daha iyi veya nötr olup olmadığını gösteren metriğin yönü
Türü	String
Değerler	increase decrease neutral

DeğerlendiriciMetricType

Değerlendiricinin türü

Mülkiyet	Değer
Açıklama	Değerlendiricinin türü
Türü	String
Değerler	ordinal continuous boolean

Değerlendirici Türü

Değerlendiricinin türü

Mülkiyet	Değer
Açıklama	Değerlendiricinin türü
Türü	String
Değerler	builtin custom

EvaluatorVersion

Değerlendirici Tanımı

İsim	Türü	Description	Gerekli	Varsayılan
categories	DeğerlendiriciKatgorisi dizisi	Değerlendiricinin kategorileri	Evet
oluşturulma_tarihi	dize (salt okunur)	Değerlendiricinin oluşturulma tarihi/saati	Evet
Oluşturan	dize (salt okunur)	Değerlendiricinin yaratıcısı	Evet
tanım	DeğerlendiriciDefinition	Ayırıcılı temel değerlendirici konfigürasyonu	Evet
└─ data_schema	nesne	Değerlendiricinin giriş verileri için JSON şeması (Taslak 2020-12). Bu, tür, özellikler, gerekli gibi parametreleri içerir.	Hayı
└─ init_parameters	nesne	Değerlendiricinin giriş parametreleri için JSON şeması (Taslak 2020-12). Bu, tür, özellikler, gerekli gibi parametreleri içerir.	Hayı
└─ ölçümler	nesne	Bu değerlendirici tarafından üretilen çıktı metriklerinin listesi	Hayı
└─ türü	EvaluatorDefinitionType	Değerlendirici tanımının türü	Evet
display_name	String	Değerlendirici için Görünen Ad. AI Foundry'de değerlendiriciyi kolayca bulmak yardımcı olur. Benzersiz olması gerekmez.	Hayı
evaluator_type	Değerlendirici Türü	Değerlendiricinin türü	Evet
kimlik	dize (salt okunur)	Öğe kimliği, öğe için benzersiz bir tanımlayıcı	Hayı
metadata	nesne	Değerlendirici hakkında meta veriler	Hayı
modified_at	dize (salt okunur)	Değerlendiricinin son değiştirilme tarihi/saati	Evet
name	dize (salt okunur)	Kaynağın adı	Evet
version	dize (salt okunur)	Kaynağın sürümü	Evet

EvaluatorVersionCreate

Değerlendirici Tanımı

İsim	Türü	Description	Gerekli	Varsayılan
categories	DeğerlendiriciKatgorisi dizisi	Değerlendiricinin kategorileri	Evet
tanım	DeğerlendiriciDefinition	Ayırıcılı temel değerlendirici konfigürasyonu	Evet
└─ data_schema	nesne	Değerlendiricinin giriş verileri için JSON şeması (Taslak 2020-12). Bu, tür, özellikler, gerekli gibi parametreleri içerir.	Hayı
└─ init_parameters	nesne	Değerlendiricinin giriş parametreleri için JSON şeması (Taslak 2020-12). Bu, tür, özellikler, gerekli gibi parametreleri içerir.	Hayı
└─ ölçümler	nesne	Bu değerlendirici tarafından üretilen çıktı metriklerinin listesi	Hayı
└─ türü	EvaluatorDefinitionType	Değerlendirici tanımının türü	Evet
açıklama	String	Varlık açıklaması metni.	Hayı
display_name	String	Değerlendirici için Görünen Ad. AI Foundry'de değerlendiriciyi kolayca bulmak yardımcı olur. Benzersiz olması gerekmez.	Hayı
evaluator_type	Değerlendirici Türü	Değerlendiricinin türü	Evet
metadata	nesne	Değerlendirici hakkında meta veriler	Hayı
tags	nesne	Etiket sözlüğü. Etiketler eklenebilir, kaldırılabilir ve güncelleştirilebilir.	Hayı

EvaluatorVersionUpdate

Değerlendirici Tanımı

İsim	Türü	Description	Gerekli	Varsayılan
categories	DeğerlendiriciKatgorisi dizisi	Değerlendiricinin kategorileri	Hayı
açıklama	String	Varlık açıklaması metni.	Hayı
display_name	String	Değerlendirici için Görünen Ad. AI Foundry'de değerlendiriciyi kolayca bulmak yardımcı olur. Benzersiz olması gerekmez.	Hayı
metadata	nesne	Değerlendirici hakkında meta veriler	Hayı
tags	nesne	Etiket sözlüğü. Etiketler eklenebilir, kaldırılabilir ve güncelleştirilebilir.	Hayı

FabricDataAgentToolParameters

Yapı veri aracısı aracı parametreleri.

İsim	Türü	Description	Gerekli	Varsayılan
project_connections	ToolProjectConnection dizisi	Bu araca bağlı proje bağlantıları. En fazla 1 bağlantı olabilir aracına bağlı kaynak.	Hayı

FileDatasetVersion

FileDatasetVersion Tanımı

İsim	Türü	Description	Gerekli	Varsayılan
connectionName (bağlantıadı)	String	Azure Storage Account bağlantı adı. Veri Kümesi oluşturulmadan önce startPendingUploadVersion çağrılmadıysa gereklidir	Hayı
dataUri	String	Verilerin URI'si (örnek) Kısıtlamalar: minLength: 1, desen: [a-zA-Z0-9_]	Evet
kimlik	dize (salt okunur)	Öğe kimliği, öğe için benzersiz bir tanımlayıcı	Hayı
isReference	boole (salt okunur)	Veri setinin storage'a referans tuttuğunu veya veri setinin storage'ı kendisi yönetip yönetmediğini gösterir. Doğruysa, veri kümesi sürümü silindiğinde temel alınan veriler silinmez	Hayı
name	dize (salt okunur)	Kaynağın adı	Evet
type	enum	Veri kümesi türü Olası değerler: uri_file	Evet
version	dize (salt okunur)	Kaynağın sürümü	Evet

FileDatasetVersionUpdate

FileDatasetVersion Tanımı

İsim	Türü	Description	Gerekli	Varsayılan
açıklama	String	Varlık açıklaması metni.	Hayı
tags	nesne	Etiket sözlüğü. Etiketler eklenebilir, kaldırılabilir ve güncelleştirilebilir.	Hayı
type	enum	Veri kümesi türü Olası değerler: uri_file	Evet

FolderDatasetVersion

FileDatasetVersion Tanımı

İsim	Türü	Description	Gerekli	Varsayılan
connectionName (bağlantıadı)	String	Azure Storage Account bağlantı adı. Veri Kümesi oluşturulmadan önce startPendingUploadVersion çağrılmadıysa gereklidir	Hayı
dataUri	String	Verilerin URI'si (örnek) Kısıtlamalar: minLength: 1, desen: [a-zA-Z0-9_]	Evet
kimlik	dize (salt okunur)	Öğe kimliği, öğe için benzersiz bir tanımlayıcı	Hayı
isReference	boole (salt okunur)	Veri setinin storage'a referans tuttuğunu veya veri setinin storage'ı kendisi yönetip yönetmediğini gösterir. Doğruysa, veri kümesi sürümü silindiğinde temel alınan veriler silinmez	Hayı
name	dize (salt okunur)	Kaynağın adı	Evet
type	enum	Veri kümesi türü Olası değerler: uri_folder	Evet
version	dize (salt okunur)	Kaynağın sürümü	Evet

FolderDatasetVersionUpdate

FileDatasetVersion Tanımı

İsim	Türü	Description	Gerekli	Varsayılan
açıklama	String	Varlık açıklaması metni.	Hayı
tags	nesne	Etiket sözlüğü. Etiketler eklenebilir, kaldırılabilir ve güncelleştirilebilir.	Hayı
type	enum	Veri kümesi türü Olası değerler: uri_folder	Evet

FunctionToolCall

İşlev aracı çağrısının ayrıntıları.

İsim	Türü	Description	Gerekli	Varsayılan
arguments	String	JSON biçiminde model tarafından oluşturulan işlevi çağırmak için bağımsız değişkenler.	Evet
name	String	Çağrılacak işlevin adı.	Evet

HostedAgentDefinition

Barındırılan aracı tanımı.

İsim	Türü	Description	Gerekli	Varsayılan
container_protocol_versions	ProtocolVersionRecord dizisi	Aracının kapsayıcıların giriş iletişimi için desteklediği protokoller.	Evet
cpu	String	Barındırılan aracının CPU yapılandırması.	Evet
environment_variables	nesne	Barındırılan aracı kapsayıcısında ayarlanacak ortam değişkenleri.	Hayı
image	String	Görüntü tabanlı barındırılan aracılar için geçerli olan aracının görüntü kimliği.	Hayı
tür	enum	Olası değerler: hosted	Evet
memory	String	Barındırılan aracının bellek yapılandırması.	Evet
rai_config	RaiConfig	Sorumlu Yapay Zeka (RAI) içerik filtreleme ve güvenlik özellikleri için yapılandırma.	Hayı
└─ rai_policy_name	String	Uygulanacak RAI politikasının adı.	Evet
araçlar	OpenAI.Tool dizisi	Barındırılan aracının modelinin yanıt oluştururken çağırabileceği bir dizi araç. Siz parametresini ayarlayarak tool_choice hangi aracın kullanılacağını belirtebilir.	Hayı

HourlyRecurrenceSchedule

Saatlik yinelenme zamanlaması.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olası değerler: Hourly	Evet

HumanEvaluationPreviewRuleAction

İnsan değerlendirmesi için değerlendirme kuralı eylemi.

İsim	Türü	Description	Gerekli	Varsayılan
şablonId	AssetId	Kaydedilmiş bir varlığın tanımlayıcısı.	Evet
type	enum	Olası değerler: humanEvaluationPreview	Evet

Index

Dizin kaynağı Tanımı

Dizin için Ayrıştırıcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
AzureSearch	AzureAISearchIndex
ManagedAzureSearch	ManagedAzureAISearchIndex
CosmosDBNoSqlVectorStore	CosmosDBIndex

İsim	Türü	Description	Gerekli	Varsayılan
kimlik	dize (salt okunur)	Öğe kimliği, öğe için benzersiz bir tanımlayıcı	Hayı
name	dize (salt okunur)	Kaynağın adı	Evet
type	IndexType		Evet
version	dize (salt okunur)	Kaynağın sürümü	Evet

IndexType

Mülkiyet	Değer
Türü	String
Değerler	AzureSearch CosmosDBNoSqlVectorStore ManagedAzureSearch

IndexUpdate

Dizin kaynağı Tanımı

IndexUpdate için Ayrıştırıcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
AzureSearch	AzureAISearchIndexUpdate
ManagedAzureSearch	ManagedAzureAISearchIndexUpdate
CosmosDBNoSqlVectorStore	CosmosDBIndexUpdate

İsim	Türü	Description	Gerekli	Varsayılan
açıklama	String	Varlık açıklaması metni.	Hayı
tags	nesne	Etiket sözlüğü. Etiketler eklenebilir, kaldırılabilir ve güncelleştirilebilir.	Hayı
type	IndexType		Evet

İçgörü

Küme içgörüleri için yanıt gövdesi.

İsim	Türü	Description	Gerekli	Varsayılan
ekran adı	String	İçgörü için kullanıcı dostu görünen ad.	Evet
kimlik	dize (salt okunur)	İçgörüler raporunun benzersiz tanımlayıcısı.	Evet
metadata	InsightsMetadata (salt okunur)	İçgörülerle ilgili meta veriler.	Evet
└─ tamamlandıAt	String	İçgörülerin tamamlandığı zaman damgası.	Hayı
└─ oluşturuldu	String	İçgörülerin oluşturulduğu zaman damgası.	Evet
request	InsightRequest	İçgörüler raporunun isteği.	Evet
└─ türü	InsightType	İstek türü.	Evet
sonuç	InsightResult (salt okunur)	İçgörülerin sonucu.	Hayı
└─ türü	InsightType	İçgörülerin türü sonucu.	Evet
state	Azure. Core.Foundations.OperationState (yalnızca okunabilir)	İzin verilen işlem durumlarını açıklayan sabit listesi.	Evet

InsightCluster

Analiz örneklerinden oluşan bir küme.

İsim	Türü	Description	Gerekli	Varsayılan
açıklama	String	Analiz kümesinin açıklaması.	Evet
kimlik	String	Analiz kümesinin kimliği.	Evet
label	String	Küme için etiket	Evet
Örnekleri	InsightSample dizisi	Bu kümeye ait örneklerin listesi. Örnekler alt kümelerin parçasıysa boşaltın.	Hayı
alt kümeler	InsightCluster dizisi	Bu küme içindeki alt kümelerin listesi. Alt küme yoksa boştur.	Hayı
öneri	String	Küme için öneri	Evet
suggestionTitle	String	Küme için önerinin başlığı	Evet
weight	tamsayı	Analiz kümesinin ağırlığı. Bu, kümedeki örnek sayısını gösterir.	Evet

InsightModelConfiguration

İçgörü oluşturmada kullanılan modelin yapılandırması.

İsim	Türü	Description	Gerekli	Varsayılan
modelDeploymentName	String	Değerlendirilecek model dağıtımı. Dağıtım adını tek başına veya bağlantı adı olarak {connectionName}/<modelDeploymentName>kabul eder.	Evet

InsightRequest

İçgörüler raporunun isteği.

InsightRequest için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
EvaluationRunClusterInsight	EvaluationRunClusterInsightRequest
AgentClusterInsight	AgentClusterInsightRequest
EvaluationComparison	EvaluationComparisonInsightRequest

İsim	Türü	Description	Gerekli	Varsayılan
type	InsightType	İçgörülerin isteği.	Evet

InsightResult

İçgörülerin sonucu.

InsightResult için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
EvaluationComparison	EvaluationComparisonInsightResult
EvaluationRunClusterInsight	EvaluationRunClusterInsightResult
AgentClusterInsight	AgentClusterInsightResult

İsim	Türü	Description	Gerekli	Varsayılan
type	InsightType	İçgörülerin isteği.	Evet

InsightSample

Analizden bir örnek.

InsightSample için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
EvaluationResultSample	EvaluationResultSample

İsim	Türü	Description	Gerekli	Varsayılan
correlationInfo	nesne	Analiz örneğinin korelasyonu hakkında bilgi.	Evet
features	nesne	UX'te verilerin ek filtrelenmesine yardımcı olacak özellikler.	Evet
kimlik	String	Analiz örneğinin benzersiz tanımlayıcısı.	Evet
type	Sampletype	Analizde kullanılan numunenin türü.	Evet

InsightScheduleTask

Zamanlama için içgörü görevi.

İsim	Türü	Description	Gerekli	Varsayılan
configuration	nesne	Görev için yapılandırma.	Hayı
içgörü	Insight	Küme içgörüleri için yanıt gövdesi.	Evet
└─ displayName	String	İçgörü için kullanıcı dostu görünen ad.	Evet
└─ kimlik	dize (salt okunur)	İçgörüler raporunun benzersiz tanımlayıcısı.	Evet
└─ meta veriler	InsightsMetadata (salt okunur)	İçgörüler raporuyla ilgili meta veriler.	Evet
└─ isteği	InsightRequest	İçgörü analizi için talepte bulunun.	Evet
└─ sonuç	InsightResult (salt okunur)	İçgörüler raporunun sonucu.	Hayı
└─ durumu	Azure. Core.Foundations.OperationState (yalnızca okunabilir)	İçgörülerin mevcut durumu.	Evet
type	enum	Olası değerler: Insight	Evet

InsightSummary

Hata kümesi analizinin özeti.

İsim	Türü	Description	Gerekli	Varsayılan
method	String	Kümeleme için kullanılan yöntem.	Evet
sampleCount	tamsayı	Analiz edilen toplam numune sayısı.	Evet
uniqueClusterCount	tamsayı	Benzersiz kümelerin toplam sayısı.	Evet
uniqueSubclusterCount	tamsayı	Benzersiz alt küme etiketlerinin toplam sayısı.	Evet
usage	ClusterTokenUsage	Küme analizi için belirteç kullanımı	Evet
└─ inputTokenUsage	tamsayı	Giriş belirteci kullanımı	Evet
└─ outputTokenUsage	tamsayı	Çıkış belirteci kullanımı	Evet
└─ totalTokenUsage	tamsayı	Toplam jeton kullanımı	Evet

InsightType

İçgörülerin isteği.

Mülkiyet	Değer
Açıklama	İçgörülerin isteği.
Türü	String
Değerler	EvaluationRunClusterInsight AgentClusterInsight EvaluationComparison

InsightsMetadata

İçgörülerle ilgili meta veriler.

İsim	Türü	Description	Gerekli	Varsayılan
completedAt	String	İçgörülerin tamamlandığı zaman damgası.	Hayı
createdAt	String	İçgörülerin oluşturulduğu zaman damgası.	Evet

ItemGenerationParams

Öğe oluşturma işlemlerini denetlemek için kullanılan parametre kümesini temsil eder.

ItemGenerationParams için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
red_team	RedTeamItemGenerationParams
red_team_seed_prompts	RedTeamSeedPromptsItemGenerationParams
red_team_taxonomy	RedTeamTaxonomyItemGenerationParams
response_retrieval	ResponseRetrievalItemGenerationParams

İsim	Türü	Description	Gerekli	Varsayılan
type	ItemGenerationParamsType	Kırmızı takım öğesi oluşturma için parametre türleri.	Evet

ItemGenerationParamsType

Kırmızı takım öğesi oluşturma için parametre türleri.

Mülkiyet	Değer
Açıklama	Kırmızı takım öğesi oluşturma için parametre türleri.
Türü	String
Değerler	red_team response_retrieval red_team_seed_prompts red_team_taxonomy synthetic_data_gen_preview

ManagedAzureAISearchIndex

Managed Azure AI Search Index Definition

İsim	Türü	Description	Gerekli	Varsayılan
kimlik	dize (salt okunur)	Öğe kimliği, öğe için benzersiz bir tanımlayıcı	Hayı
name	dize (salt okunur)	Kaynağın adı	Evet
type	enum	Endeks türü Olası değerler: ManagedAzureSearch	Evet
version	dize (salt okunur)	Kaynağın sürümü	Evet

ManagedAzureAISearchIndexUpdate

Managed Azure AI Search Index Definition

İsim	Türü	Description	Gerekli	Varsayılan
açıklama	String	Varlık açıklaması metni.	Hayı
tags	nesne	Etiket sözlüğü. Etiketler eklenebilir, kaldırılabilir ve güncelleştirilebilir.	Hayı
type	enum	Endeks türü Olası değerler: ManagedAzureSearch	Evet

MemoryItem

Bellek deposunda saklanan, içerik ve meta verileri içeren tek bir bellek öğesi.

MemoryItem için Ayrıştırıcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini kind kullanır:

Tür Değeri	Şema
user_profile	UserProfileMemoryItem
chat_summary	ChatSummaryMemoryItem

İsim	Türü	Description	Gerekli	Varsayılan
içerik	String	Belleğin içeriği.	Evet
tür	MemoryItemKind	Bellek öğesi türü.	Evet
memory_id	String	Bellek öğesinin benzersiz kimliği.	Evet
kapsam	String	Kullanıcı kimliği gibi anıları mantıksal olarak gruplandıran ve yalıtan ad alanı.	Evet
updated_at	tamsayı	Bellek öğesinin son güncelleme zamanı.	Evet

MemoryItemKind

Bellek öğesi türü.

Mülkiyet	Değer
Açıklama	Bellek öğesi türü.
Türü	String
Değerler	user_profile chat_summary

MemoryOperation

Bir bellek öğesi üzerinde gerçekleştirilen tek bir bellek işlemini (oluşturma, güncelleştirme veya silme) temsil eder.

İsim	Türü	Description	Gerekli	Varsayılan
tür	MemoryOperationKind	Bellek işlemi türü.	Evet
memory_item	MemoryItem	Bellek deposunda saklanan, içerik ve meta verileri içeren tek bir bellek öğesi.	Evet
└─ içerik	String	Belleğin içeriği.	Evet
└─ tür	MemoryItemKind	Hafıza öğesinin türü.	Evet
└─ memory_id	String	Bellek öğesinin benzersiz kimliği.	Evet
└─ kapsam	String	Kullanıcı kimliği gibi anıları mantıksal olarak gruplandıran ve yalıtan ad alanı.	Evet
└─ updated_at	tamsayı	Bellek öğesinin son güncelleme zamanı.	Evet

MemoryOperationKind

Bellek işlemi türü.

Mülkiyet	Değer
Açıklama	Bellek işlemi türü.
Türü	String
Değerler	create update delete

MemorySearchItem

Bellek aramasından alınan bir bellek öğesi.

İsim	Türü	Description	Gerekli	Varsayılan
memory_item	MemoryItem	Bellek deposunda saklanan, içerik ve meta verileri içeren tek bir bellek öğesi.	Evet
└─ içerik	String	Belleğin içeriği.	Evet
└─ tür	MemoryItemKind	Hafıza öğesinin türü.	Evet
└─ memory_id	String	Bellek öğesinin benzersiz kimliği.	Evet
└─ kapsam	String	Kullanıcı kimliği gibi anıları mantıksal olarak gruplandıran ve yalıtan ad alanı.	Evet
└─ updated_at	tamsayı	Bellek öğesinin son güncelleme zamanı.	Evet

MemorySearchOptions

Bellek arama seçenekleri.

İsim	Türü	Description	Gerekli	Varsayılan
max_memories	tamsayı	Döndürülecek en fazla bellek öğesi sayısı.	Hayı

MemorySearchPreviewTool

Anıları aracıya entegre etmek için bir araç.

İsim	Türü	Description	Gerekli	Varsayılan
memory_store_name	String	Kullanılacak bellek deposunun adı.	Evet
kapsam	String	Kullanıcı kimliği gibi anıları gruplandırmak ve yalıtmak için kullanılan ad alanı. Hangi anıların alınabileceğini veya güncellenebileceğini sınırlar. Belleklerin kapsamını geçerli oturum açmış kullanıcıya genişletmek için özel değişken {{$userId}} kullanın.	Evet
search_options	MemorySearchOptions	Bellek arama seçenekleri.	Hayı
└─ max_memories	tamsayı	Döndürülecek en fazla bellek öğesi sayısı.	Hayı
type	enum	Aracın türü. Her zaman memory_search_preview. Olası değerler: memory_search_preview	Evet
update_delay	tamsayı	Hareketsizlikten sonra anıları güncellemeden önce bekleme süresi (saniye). Varsayılan 300.	Hayı	300

MemorySearchToolCallItemParam

İsim	Türü	Description	Gerekli	Varsayılan
results	MemorySearchItem dizisi	Bellek aramasından döndürülen sonuçlar.	Hayı
type	enum	Olası değerler: memory_search_call	Evet

MemorySearchToolCallItemResource

İsim	Türü	Description	Gerekli	Varsayılan
agent_reference	AgentReference		Hayı
└─ ad	String	Aracının adı. Kısıtlamalar: maxLength: 256	Evet
└─ türü	enum	Olası değerler: agent_reference	Evet
└─ sürümü	String	Aracının sürüm tanımlayıcısı.	Hayı
response_id	String	Öğenin oluşturulduğu yanıt.	Hayı
results	MemorySearchItem dizisi	Bellek aramasından döndürülen sonuçlar.	Hayı
durum	enum	Bellek arama aracı çağrısının durumu. Bunlardan biri in_progress searching, completedveya incompletefailed, Olası değerler: in_progress, searching, completed, incomplete, failed	Evet
type	enum	Olası değerler: memory_search_call	Evet

MemoryStoreDefaultDefinition

Varsayılan bellek deposu uygulaması.

İsim	Türü	Description	Gerekli	Varsayılan
chat_model	String	Bellek işleme için kullanılan sohbet tamamlama modeli dağıtımının adı veya tanımlayıcısı.	Evet
embedding_model	String	Bellek işleme için kullanılan ekleme modeli dağıtımının adı veya tanımlayıcısı.	Evet
tür	enum	Bellek deposunun türü. Olası değerler: default	Evet
options	MemoryStoreDefaultOptions	Varsayılan bellek deposu yapılandırmaları.	Hayı
└─ chat_summary_enabled	Boolean	Sohbet özetini açıp açma ve storage'ı etkinleştirip etkinleştirmediğiniz. Varsayılan değer doğrudur	Evet	Doğru
└─ user_profile_details	String	Ayıklanacak ve saklanacak belirli kategoriler veya kullanıcı profili bilgisi türleri.	Hayı
└─ user_profile_enabled	Boolean	Kullanıcı profili çıkarma ve storage'ı etkinleştirip etkinleştirilmeyeceği. Varsayılan değer doğrudur	Evet	Doğru

MemoryStoreDefaultOptions

Varsayılan bellek deposu yapılandırmaları.

İsim	Türü	Description	Gerekli	Varsayılan
chat_summary_enabled	Boolean	Sohbet özetini açıp açma ve storage'ı etkinleştirip etkinleştirmediğiniz. Varsayılan değer doğrudur	Evet	Doğru
user_profile_details	String	Ayıklanacak ve saklanacak belirli kategoriler veya kullanıcı profili bilgisi türleri.	Hayı
user_profile_enabled	Boolean	Kullanıcı profili çıkarma ve storage'ı etkinleştirip etkinleştirilmeyeceği. Varsayılan değer doğrudur	Evet	Doğru

MemoryStoreDefinition

Bellek deposu yapılandırmaları için temel tanım.

MemoryStoreDefinition için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini kind kullanır:

Tür Değeri	Şema
default	MemoryStoreDefaultDefinition

İsim	Türü	Description	Gerekli	Varsayılan
tür	MemoryStoreKind	Kullanılacak bellek deposu uygulamasının türü.	Evet

MemoryStoreDeleteScopeResponse

Bir kapsamdan anıları silme yanıtı.

İsim	Türü	Description	Gerekli	Varsayılan
silindi	Boolean	Silme işleminin başarılı olup olmadığı.	Evet
name	String	Bellek deposunun adı.	Evet
nesne	enum	Nesne türü. Her zaman 'memory_store.scope.deleted'. Olası değerler: memory_store.scope.deleted	Evet
kapsam	String	Anıların silindiği kapsam.	Evet

MemoryStoreKind

Kullanılacak bellek deposu uygulamasının türü.

Mülkiyet	Değer
Açıklama	Kullanılacak bellek deposu uygulamasının türü.
Türü	String
Değerler	default

MemoryStoreObject

Kullanıcı anılarını depolayabilen ve alabilen bir bellek deposu.

İsim	Türü	Description	Gerekli	Varsayılan
oluşturulma_tarihi	tamsayı	Bellek deposunun oluşturulduğu Unix zaman damgası (saniye).	Evet
tanım	MemoryStoreDefinition	Bellek deposu yapılandırmaları için temel tanım.	Evet
└─ tür	MemoryStoreKind	Bellek deposunun türü.	Evet
açıklama	String	Bellek deposunun okunabilir bir açıklaması. Kısıtlamalar: maxLength: 512	Hayı
kimlik	String	Bellek deposunun benzersiz tanımlayıcısı.	Evet
metadata	nesne	Bellek deposuyla ilişkilendirilecek rastgele anahtar-değer meta verileri.	Hayı
name	String	Bellek deposunun adı. Kısıtlamalar: maxLength: 256	Evet
nesne	enum	Her zaman 'memory_store' olan nesne türü. Olası değerler: memory_store	Evet
updated_at	tamsayı	Bellek deposunun en son güncellendiği Unix zaman damgası (saniye).	Evet

MemoryStoreOperationUsage

Bellek deposu işleminin kullanım istatistikleri.

İsim	Türü	Description	Gerekli	Varsayılan
embedding_tokens	tamsayı	Ekleme belirteçlerinin sayısı.	Evet
input_tokens	OpenAI.integer		Evet
input_tokens_details	OpenAI.ResponseUsageInputTokensDetails		Evet
└─ önbelleğe alınmış jetonlar	OpenAI.integer		Evet
output_tokens	OpenAI.integer		Evet
output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails		Evet
└─ akıl yürütme_tokenlar	OpenAI.integer		Evet
total_tokens	OpenAI.integer		Evet

MemoryStoreSearchResponse

Bellek arama yanıtı.

İsim	Türü	Description	Gerekli	Varsayılan
Anıları	MemorySearchItem dizisi	Arama işlemi sırasında bulunan ilgili bellek öğeleri.	Evet
search_id	String	Bu arama isteğinin benzersiz kimliği. Artımlı aramalar gerçekleştirmek için sonraki isteklerde previous_search_id olarak bu değeri kullanın.	Evet
usage	MemoryStoreOperationUsage	Bellek deposu işleminin kullanım istatistikleri.	Evet
└─ embedding_tokens	tamsayı	Ekleme belirteçlerinin sayısı.	Evet
└─ girdi_simgeleri	OpenAI.integer	Giriş belirteçlerinin sayısı.	Evet
└─ giriş_jeton_detayları	OpenAI.ResponseUsageInputTokensDetails	Giriş belirteçlerinin ayrıntılı dökümü.	Evet
└─ çıkış_birimleri	OpenAI.integer	Çıkış belirteçlerinin sayısı.	Evet
└─ output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails	Çıkış belirteçlerinin ayrıntılı dökümü.	Evet
└─ toplam_jetonlar	OpenAI.integer	Kullanılan toplam belirteç sayısı.	Evet

MemoryStoreUpdateCompletedResult

Bellek güncelleme sonucu.

İsim	Türü	Description	Gerekli	Varsayılan
memory_operations	MemoryOperation dizisi	Güncelleştirme sırasında gerçekleştirilen tek tek bellek işlemlerinin listesi.	Evet
usage	MemoryStoreOperationUsage	Bellek deposu işleminin kullanım istatistikleri.	Evet
└─ embedding_tokens	tamsayı	Ekleme belirteçlerinin sayısı.	Evet
└─ girdi_simgeleri	OpenAI.integer	Giriş belirteçlerinin sayısı.	Evet
└─ giriş_jeton_detayları	OpenAI.ResponseUsageInputTokensDetails	Giriş belirteçlerinin ayrıntılı dökümü.	Evet
└─ çıkış_birimleri	OpenAI.integer	Çıkış belirteçlerinin sayısı.	Evet
└─ output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails	Çıkış belirteçlerinin ayrıntılı dökümü.	Evet
└─ toplam_jetonlar	OpenAI.integer	Kullanılan toplam belirteç sayısı.	Evet

MemoryStoreUpdateResponse

Bellek deposu güncelleştirme işleminin durumunu sağlar.

İsim	Türü	Description	Gerekli	Varsayılan
hata	OpenAI.Error		Hayı
└─ ekBilgi	nesne		Hayı
└─ kod	dize (null atanabilir)		Evet
└─ debugInfo	nesne		Hayı
└─ ayrıntılar	OpenAI.Error dizisi		Hayı
└─ ileti	String		Evet
└─ parametre	dize (null atanabilir)		Hayı
└─ türü	String		Hayı
sonuç	MemoryStoreUpdateCompletedResult	Bellek güncelleme sonucu.	Hayı
└─ memory_operations	MemoryOperation dizisi	Güncelleştirme sırasında gerçekleştirilen tek tek bellek işlemlerinin listesi.	Evet
└─ kullanımı	MemoryStoreOperationUsage	Bellek güncelleştirme işlemiyle ilişkili kullanım istatistikleri.	Evet
durum	MemoryStoreUpdateStatus	Bellek deposu güncelleştirme işleminin durumu.	Evet
superseded_by	String	İşlemin yerini aldığı update_id, durumun "yerine geçen" zamandır.	Hayı
update_id	String	Bu güncelleştirme isteğinin benzersiz kimliği. Artımlı güncelleştirmeler gerçekleştirmek için sonraki isteklerde bu değeri previous_update_id olarak kullanın.	Evet

MemoryStoreUpdateStatus

Bellek deposu güncelleştirme işleminin durumu.

Mülkiyet	Değer
Türü	String
Değerler	queued in_progress completed failed superseded

MicrosoftFabricPreviewTool

Bir ajanı yapılandırmak için kullanılan Microsoft Fabric aracı için giriş tanım bilgileri.

İsim	Türü	Description	Gerekli	Varsayılan
fabric_dataagent_preview	FabricDataAgentToolParameters	Yapı veri aracısı aracı parametreleri.	Evet
└─ project_connections	ToolProjectConnection dizisi	Bu araca bağlı proje bağlantıları. En fazla 1 bağlantı olabilir aracına bağlı kaynak. Kısıtlamalar: maxItems: 1	Hayı
type	enum	Her zaman 'fabric_dataagent_preview' olan nesne türü. Olası değerler: fabric_dataagent_preview	Evet

ModelDeployment

Model Dağıtım Tanımı

İsim	Türü	Description	Gerekli	Varsayılan
capabilities	object (salt okunur)	Dağıtılan modelin yetenekleri	Evet
connectionName (bağlantıadı)	dize (salt okunur)	Dağıtımın geldiği bağlantının adı	Hayı
modelName	dize (salt okunur)	Publisher'a özgü olarak kullanılan modelin adı	Evet
modelPublisher	dize (salt okunur)	Dağıtılan modelin publisher	Evet
modelVersion	dize (salt okunur)	Publisher'a özgü dağıtım modeli	Evet
name	dize (salt okunur)	Dağıtımın adı	Evet
sku	Sku (salt okunur)	Sku bilgileri	Evet
└─ kapasite	tamsayı	Sku kapasitesi	Evet
└─ aile	String	Sku ailesi	Evet
└─ ad	String	Sku adı	Evet
└─ boyutu	String	Sku boyutu	Evet
└─ katmanı	String	Sku katmanı	Evet
type	enum	Dağıtımın türü Olası değerler: ModelDeployment	Evet

ModelÖrnekLemeParamları

Metin oluşturma sırasında dil modelinin örnekleme davranışını denetlemek için kullanılan bir parametre kümesini temsil eder.

İsim	Türü	Description	Gerekli	Varsayılan
max_completion_tokens	tamsayı	Tamamlanmada izin verilen en fazla belirteç sayısı.	Evet
seed	tamsayı	Yeniden üretilebilirlik için rastgele tohum.	Evet
sıcaklık	Numara	Örnekleme için sıcaklık parametresi.	Evet
top_p	Numara	Çekirdek örnekleme için top-p parametresi.	Evet

ModelSamplingParamsUpdate

Metin oluşturma sırasında dil modelinin örnekleme davranışını denetlemek için kullanılan bir parametre kümesini temsil eder.

İsim	Türü	Description	Gerekli	Varsayılan
max_completion_tokens	tamsayı	Tamamlanmada izin verilen en fazla belirteç sayısı.	Hayı
seed	tamsayı	Yeniden üretilebilirlik için rastgele tohum.	Hayı
sıcaklık	Numara	Örnekleme için sıcaklık parametresi.	Hayı
top_p	Numara	Çekirdek örnekleme için top-p parametresi.	Hayı

MonthlyRecurrenceSchedule

Aylık yinelenme zamanlaması.

İsim	Türü	Description	Gerekli	Varsayılan
daysOfMonth	tamsayı dizisi	Yinelenme zamanlaması için ayın günleri.	Evet
type	enum	Aylık yinelenme türü. Olası değerler: Monthly	Evet

NoAuthenticationCredentials

Kimlik doğrulaması gerektirmeyen kimlik bilgileri

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Kimlik bilgisi türü Olası değerler: None	Evet

OAuthConsentRequestOutputItem

Hizmetten kullanıcının OAuth onayı gerçekleştirmesini isteyin.

İsim	Türü	Description	Gerekli	Varsayılan
agent_reference	AgentReference		Hayı
└─ ad	String	Aracının adı. Kısıtlamalar: maxLength: 256	Evet
└─ türü	enum	Olası değerler: agent_reference	Evet
└─ sürümü	String	Aracının sürüm tanımlayıcısı.	Hayı
consent_link	String	Kullanıcının OAuth onayı gerçekleştirmek için kullanabileceği bağlantı.	Evet
kimlik	String		Evet
response_id	String	Öğenin oluşturulduğu yanıt.	Hayı
sunucu etiketi	String	OAuth onay isteğinin sunucu etiketi.	Evet
type	enum	Olası değerler: oauth_consent_request	Evet

OneTimeTrigger

Tek seferlik tetikleyici.

İsim	Türü	Description	Gerekli	Varsayılan
timeZone	String	Tek seferlik tetikleyici için saat dilimi.	Hayı	UTC (Koordinatlı Evrensel Zaman)
triggerAt	String	ISO 8601 biçiminde tek seferlik tetikleyicinin tarih ve saati.	Evet
type	enum	Olası değerler: OneTime	Evet

OpenAI.Annotation

Çıkış metninin yayılma alanına uygulanan bir ek açıklama.

OpenAI.Annotation için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
file_citation	OpenAI.FileCitationBody
url_citation	OpenAI.UrlCitationBody
container_file_citation	OpenAI.ContainerFileCitationBody
file_path	OpenAI.FilePath

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.AnnotationType		Evet

OpenAI.AnnotationType

Mülkiyet	Değer
Türü	String
Değerler	file_citation url_citation container_file_citation file_path

OpenAI.ApplyPatchCallOutputStatus

Mülkiyet	Değer
Türü	String
Değerler	completed failed

OpenAI.ApplyPatchCallOutputStatusParam

apply_patch araç çağrısı çıktıları için raporlanan sonuç değerleri.

Mülkiyet	Değer
Türü	String
Değerler	completed failed

OpenAI.ApplyPatchCallStatus

Mülkiyet	Değer
Türü	String
Değerler	in_progress completed

OpenAI.ApplyPatchCallStatusParam

apply_patch araç çağrıları için raporlanan durum değerleri.

Mülkiyet	Değer
Türü	String
Değerler	in_progress completed

OpenAI.ApplyPatchCreateFileOperation

apply_patch aracı aracılığıyla dosya oluşturmayı açıklayan yönerge.

İsim	Türü	Description	Gerekli	Varsayılan
Fark	String	Uygulanacak fark.	Evet
path	String	Oluşturulacak dosyanın yolu.	Evet
type	enum	Sağlanan fark ile yeni bir dosya oluşturun. Olası değerler: create_file	Evet

OpenAI.ApplyPatchCreateFileOperationParam

apply_patch aracı aracılığıyla yeni bir dosya oluşturma talimatı.

İsim	Türü	Description	Gerekli	Varsayılan
Fark	String	Dosya oluşturulurken uygulanacak birleşik farklı içerikler. Kısıtlamalar: maxLength: 10485760	Evet
path	String	Dosyanın çalışma alanı köküne göre oluşturulacak yolu. Kısıtlamalar: minLength: 1	Evet
type	enum	İşlem türü. Her zaman create_file. Olası değerler: create_file	Evet

OpenAI.ApplyPatchDeleteFileOperation

apply_patch aracı aracılığıyla bir dosyanın nasıl silineceği hakkında yönergeler.

İsim	Türü	Description	Gerekli	Varsayılan
path	String	Silinecek dosyanın yolu.	Evet
type	enum	Belirtilen dosyayı silin. Olası değerler: delete_file	Evet

OpenAI.ApplyPatchDeleteFileOperationParam

apply_patch aracı aracılığıyla mevcut bir dosyayı silme talimatı.

İsim	Türü	Description	Gerekli	Varsayılan
path	String	Dosyanın çalışma alanı köküne göre silme yolu. Kısıtlamalar: minLength: 1	Evet
type	enum	İşlem türü. Her zaman delete_file. Olası değerler: delete_file	Evet

OpenAI.ApplyPatchFileOperation

apply_patch aracılığıyla uygulanan create_file, delete_file veya update_file işlemlerinden biri.

OpenAI.ApplyPatchFileOperation için Ayrıştırıcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
create_file	OpenAI.ApplyPatchCreateFileOperation
delete_file	OpenAI.ApplyPatchDeleteFileOperation
update_file	OpenAI.ApplyPatchUpdateFileOperation

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.ApplyPatchFileOperationType		Evet

OpenAI.ApplyPatchFileOperationType

Mülkiyet	Değer
Türü	String
Değerler	create_file delete_file update_file

OpenAI.ApplyPatchOperationParam

apply_patch aracına sağlanan create_file, delete_file veya update_file işlemlerden biri.

OpenAI.ApplyPatchOperationParam için Ayrıştırıcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
create_file	OpenAI.ApplyPatchCreateFileOperationParam
delete_file	OpenAI.ApplyPatchDeleteFileOperationParam
update_file	OpenAI.ApplyPatchUpdateFileOperationParam

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.ApplyPatchOperationParamType		Evet

OpenAI.ApplyPatchOperationParamType

Mülkiyet	Değer
Türü	String
Değerler	create_file delete_file update_file

OpenAI.ApplyPatchToolParam

Asistanın dosyaları birleşik farklılıklar kullanarak oluşturmasına, silmesine veya güncellemesine olanak tanır.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Aracın türü. Her zaman apply_patch. Olası değerler: apply_patch	Evet

OpenAI.ApplyPatchUpdateFileOperation

apply_patch aracı aracılığıyla bir dosyanın nasıl güncelleştirileceklerini açıklayan yönerge.

İsim	Türü	Description	Gerekli	Varsayılan
Fark	String	Uygulanacak fark.	Evet
path	String	Güncelleştirilecek dosyanın yolu.	Evet
type	enum	Mevcut bir dosyayı sağlanan farkla güncelleştirin. Olası değerler: update_file	Evet

OpenAI.ApplyPatchUpdateFileOperationParam

apply_patch aracı aracılığıyla mevcut bir dosyayı güncelleme talimatı.

İsim	Türü	Description	Gerekli	Varsayılan
Fark	String	Mevcut dosyaya uygulanacak birleşik farklı içerikler. Kısıtlamalar: maxLength: 10485760	Evet
path	String	Dosyanın çalışma alanı köküne göre güncellenme yolu. Kısıtlamalar: minLength: 1	Evet
type	enum	İşlem türü. Her zaman update_file. Olası değerler: update_file	Evet

OpenAI.YaklaşıkKonum

İsim	Türü	Description	Gerekli	Varsayılan
city	dize (null atanabilir)		Hayı
country	dize (null atanabilir)		Hayı
region	dize (null atanabilir)		Hayı
timezone	dize (null atanabilir)		Hayı
type	enum	Konum yaklaşımının türü. Her zaman approximate. Olası değerler: approximate	Evet

OpenAI Sohbet Tamamlama Aracı

Yanıt oluşturmak için kullanılabilecek bir işlev aracı.

İsim	Türü	Description	Gerekli	Varsayılan
function	OpenAI.FunctionObject		Evet
type	enum	Aracın türü. Şu anda yalnızca function desteklenmektedir. Olası değerler: function	Evet

OpenAI.ChatModel

Mülkiyet	Değer
Türü	String
Değerler	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

Mülkiyet	Değer
Türü	String
Değerler	left right wheel back forward

OpenAI.ClickParam

Tıklama eylemi.

İsim	Türü	Description	Gerekli	Varsayılan
düğme	OpenAI.ClickButtonType		Evet
type	enum	Olay türünü belirtir. Tıklama hareketi için bu özellik her clickzaman . Olası değerler: click	Evet
x	OpenAI.integer		Evet
y	OpenAI.integer		Evet

OpenAI.CodeInterpreterContainerAuto

Kod yorumlayıcı kapsayıcısı için yapılandırma. İsteğe bağlı olarak kodun çalıştırıldığı dosyaların kimliklerini belirtin.

İsim	Türü	Description	Gerekli	Varsayılan
dosya_kimlikleri	dize dizisi	Kodunuz için kullanılabilir hale getirmek üzere yüklenen dosyaların isteğe bağlı bir listesi.	Hayı
bellek sınırı	OpenAI.ContainerMemoryLimit (null atanabilir)		Hayı
type	enum	Her zaman auto. Olası değerler: auto	Evet

OpenAI.CodeInterpreterOutputImage

Kod yorumlayıcıdan görüntü çıkışı.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Çıktının türü. Her zaman image. Olası değerler: image	Evet
url	String	Kod yorumlayıcıdan görüntü çıkışının URL'si.	Evet

OpenAI.CodeInterpreterOutputLogs

Günlükler kod yorumlayıcıdan çıkar.

İsim	Türü	Description	Gerekli	Varsayılan
logs	String	Günlükler kod yorumlayıcıdan çıkar.	Evet
type	enum	Çıktının türü. Her zaman logs. Olası değerler: logs	Evet

OpenAI.CodeInterpreterTool

Bir istem için yanıt oluşturmaya yardımcı olmak için Python kodu çalıştıran bir araç.

İsim	Türü	Description	Gerekli	Varsayılan
container	string veya OpenAI.CodeInterpreterContainerAuto	Kod yorumlayıcı kapsayıcısı. Kapsayıcı kimliği veya bir nesne olabilir , kodunuz için kullanılabilir hale getirmek için karşıya yüklenen dosya kimliklerini ve bir isteğe bağlı memory_limit ayarına bakın. Sağlanmadıysa, hizmet otomatik olarak kabul edilir.	Hayı
type	enum	Kod yorumlayıcı aracının türü. Her zaman code_interpreter. Olası değerler: code_interpreter	Evet

OpenAI.CompactResource

İsim	Türü	Description	Gerekli	Varsayılan
oluşturulma_tarihi	tamsayı	Sıkıştırılmış konuşmanın oluşturulduğu Unix zaman damgası (saniye).	Evet
kimlik	String	Sıkıştırılmış yanıtın benzersiz tanımlayıcısı.	Evet
nesne	enum	Nesne türü. Her zaman response.compaction. Olası değerler: response.compaction	Evet
çıktı	OpenAI.OutputItem dizisi	Sıkıştırılmış çıkış öğeleri listesi. Bu, tüm kullanıcı iletilerinin ve ardından tek bir sıkıştırma öğesinin listesidir.	Evet
usage	OpenAI.ResponseUsage	Giriş belirteçleri, çıkış belirteçleri dahil olmak üzere belirteç kullanım ayrıntılarını temsil eder. çıkış belirteçlerinin ve kullanılan toplam belirteçlerin dökümü.	Evet
└─ girdi_simgeleri	OpenAI.integer	Giriş belirteçlerinin sayısı.	Evet
└─ giriş_jeton_detayları	OpenAI.ResponseUsageInputTokensDetails	Giriş belirteçlerinin ayrıntılı dökümü.	Evet
└─ çıkış_birimleri	OpenAI.integer	Çıkış belirteçlerinin sayısı.	Evet
└─ output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails	Çıkış belirteçlerinin ayrıntılı dökümü.	Evet
└─ toplam_jetonlar	OpenAI.integer	Kullanılan toplam belirteç sayısı.	Evet

OpenAI.CompactResponseMethodPublicBody

İsim	Türü	Description	Gerekli	Varsayılan
girdi	OpenAI.InputItem dizesi veya dizisi		Hayı
instructions	dize (null atanabilir)		Hayı
model	OpenAI.ModelIdsCompaction	veya gpt-5gibi o3 yanıtı oluşturmak için kullanılan model kimliği. OpenAI farklı özelliklere, performans özelliklerine ve fiyat noktalarına sahip çok çeşitli modeller sunar. Kullanılabilir modellere göz atmak ve modelleri karşılaştırmak için model kılavuzuna bakın.	Evet
previous_response_id	dize (null atanabilir)		Hayı

OpenAI.KıyaslamaFiltresi

Tanımlı bir karşılaştırma işlemi kullanarak belirtilen öznitelik anahtarını belirli bir değerle karşılaştırmak için kullanılan filtre.

İsim	Türü	Description	Gerekli	Varsayılan
key	String	Değerle karşılaştırmak için anahtar.	Evet
type	enum	Karşılaştırma operatörünü belirtir: eq, ne, gt, gteltlteinnin. - eq:Eşit -tir - ne: eşit değil - gt: büyüktür - gte: büyüktür veya eşittir - lt: daha azdır - lte: küçüktür veya eşittir - in:Inç - nin: içinde değil Olası değerler: eq, ne, gt, gte, , lt, lte	Evet
değer	dize veya OpenAI.numeric ya da boole ya da OpenAI.ComparisonFilterValueItems dizisi	Öznitelik anahtarıyla karşılaştıracak değer; dize, sayı veya boole türlerini destekler.	Evet

OpenAI.ComparisonFilterValueItems

Tür: dize veya OpenAI.numeric

OpenAI.CompoundFilter

and veya or kullanarak birden çok filtreyi birleştirin.

İsim	Türü	Description	Gerekli	Varsayılan
filters	OpenAI.ComparisonFilter dizisi veya nesnesi	Birleştirilecek filtreler dizisi. Öğeler ComparisonFilter veya CompoundFilter olabilir.	Evet
type	enum	İşlem türü: and veya or. Olası değerler: and, or	Evet

OpenAI.ComputerAction

OpenAI.ComputerAction için Ayrıştırıcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
click	OpenAI.ClickParam
double_click	OpenAI.DoubleClickAction
drag	OpenAI.Drag
keypress	OpenAI.KeyPressAction
move	OpenAI.Move
screenshot	OpenAI.Ekran Görüntüsü
scroll	OpenAI.Scroll
type	OpenAI.Type
wait	OpenAI.Wait

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.ComputerActionType		Evet

OpenAI.ComputerActionType

Mülkiyet	Değer
Türü	String
Değerler	click double_click drag keypress move screenshot scroll type wait

OpenAI.ComputerCallSafetyCheckParam

Bilgisayar çağrısı için bekleyen bir güvenlik denetimi.

İsim	Türü	Description	Gerekli	Varsayılan
kod	dize (null atanabilir)		Hayı
kimlik	String	Bekleyen güvenlik denetiminin kimliği.	Evet
mesaj	dize (null atanabilir)		Hayı

OpenAI.ComputerEnvironment

Mülkiyet	Değer
Türü	String
Değerler	windows mac linux ubuntu browser

OpenAI.ComputerScreenshotContent

Bilgisayarın ekran görüntüsü.

İsim	Türü	Description	Gerekli	Varsayılan
dosya_kimlik	dize (null atanabilir)		Evet
image_url	String		Evet
type	enum	Olay türünü belirtir. Bilgisayar ekran görüntüsü için bu özellik her zaman olarak computer_screenshotayarlanır. Olası değerler: computer_screenshot	Evet

OpenAI.ComputerScreenshotImage

Bilgisayar kullanım aracıyla kullanılan bir bilgisayar ekran görüntüsü.

İsim	Türü	Description	Gerekli	Varsayılan
dosya_kimlik	String	Yüklenmiş dosyanın, ekran görüntüsünü içeren kimliği.	Hayı
image_url	String	Ekran görüntüsü URL'si.	Hayı
type	enum	Olay türünü belirtir. Bir bilgisayar ekran görüntüsü için bu özellik şu şekildedir: her zaman computer_screenshot olarak ayarlanır. Olası değerler: computer_screenshot	Evet

OpenAI Bilgisayar Kullanımı Önizleme Aracı

Sanal bilgisayarı denetleyebilen bir araç.

İsim	Türü	Description	Gerekli	Varsayılan
görüntü yüksekliği	OpenAI.integer		Evet
görüntü genişliği	OpenAI.integer		Evet
environment	OpenAI.ComputerEnvironment		Evet
type	enum	Bilgisayar kullanım aracının türü. Her zaman computer_use_preview. Olası değerler: computer_use_preview	Evet

OpenAI.ContainerFileCitationBody

Model yanıtı oluşturmak için kullanılan bir konteyner dosyası için bir atıf.

İsim	Türü	Description	Gerekli	Varsayılan
container_id	String	Konteyner dosyasının kimliği.	Evet
end_index	OpenAI.integer		Evet
dosya_kimlik	String	Dosyanın kimliği.	Evet
filename	String	Bahsedilen konteyner dosyasının dosya adı.	Evet
start_index	OpenAI.integer		Evet
type	enum	Konteyner dosyası atıfının türü. Her zaman container_file_citation. Olası değerler: container_file_citation	Evet

OpenAI.ContainerMemoryLimit

Mülkiyet	Değer
Türü	String
Değerler	1g 4g 16g 64g

OpenAI.ConversationItem

Konuşma içinde tek bir öğe. Olası türler kümesi, output türüyle aynıdır.

OpenAI.ConversationItem için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
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

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.ConversationItemType		Evet

OpenAI.ConversationItemApplyPatchToolCall

Dosya oluşturarak, silerek veya güncelleştirerek dosya farklarını uygulayan bir araç çağrısı.

İsim	Türü	Description	Gerekli	Varsayılan
call_id	String	Model tarafından oluşturulan uygulama yama aracı çağrısının benzersiz kimliği.	Evet
Oluşturan	String	Bu araç çağrısını oluşturan varlığın kimliği.	Hayı
kimlik	String	Düzeltme eki uygulama aracı çağrısının benzersiz kimliği. Bu öğe, API aracılığıyla iade edildiğinde doldurulur.	Evet
Operasyon	OpenAI.ApplyPatchFileOperation	apply_patch aracılığıyla uygulanan create_file, delete_file veya update_file işlemlerinden biri.	Evet
└─ türü	OpenAI.ApplyPatchFileOperationType		Evet
durum	OpenAI.ApplyPatchCallStatus		Evet
type	enum	Öğenin türü. Her zaman apply_patch_call. Olası değerler: apply_patch_call	Evet

OpenAI.ConversationItemApplyPatchToolCallOutput

Bir düzeltme eki uygulama aracı çağrısı tarafından yayılan çıkış.

İsim	Türü	Description	Gerekli	Varsayılan
call_id	String	Model tarafından oluşturulan uygulama yama aracı çağrısının benzersiz kimliği.	Evet
Oluşturan	String	Bu aracı oluşturan varlığın kimliği çağrı çıktısı.	Hayı
kimlik	String	Düzeltme eki uygulama aracı çağrı çıkışının benzersiz kimliği. Bu öğe, API aracılığıyla iade edildiğinde doldurulur.	Evet
çıktı	dize (null atanabilir)		Hayı
durum	OpenAI.ApplyPatchCallOutputStatus		Evet
type	enum	Öğenin türü. Her zaman apply_patch_call_output. Olası değerler: apply_patch_call_output	Evet

OpenAI.ConversationItemCodeInterpreterToolCall

Kodu çalıştırmak için bir araç çağrısı.

İsim	Türü	Description	Gerekli	Varsayılan
kod	dize (null atanabilir)		Evet
container_id	String	Kodu çalıştırmak için kullanılan kapsayıcının kimliği.	Evet
kimlik	String	Kod yorumlayıcısı araç çağrısının benzersiz kimliği.	Evet
Çıktılar	OpenAI.CodeInterpreterOutputLogs veya OpenAI.CodeInterpreterOutputImage dizisi		Evet
durum	enum	Kod yorumlayıcı aracı çağrısının durumu. Geçerli değerler : in_progress, completed, incomplete, interpretingve failed. Olası değerler: in_progress, completed, incomplete, interpreting, failed	Evet
type	enum	Kod yorumlayıcı aracı çağrısının türü. Her zaman code_interpreter_call. Olası değerler: code_interpreter_call	Evet

OpenAI.ConversationItemComputerToolCall

Bilgisayar kullanım araçlarına bir araç komutu verme. Daha fazla bilgi için bilgisayar kullanım rehberi adresine bakınız.

İsim	Türü	Description	Gerekli	Varsayılan
hareket	OpenAI.ComputerAction		Evet
call_id	String	Çıkış verisi ile araç çağrısına yanıt verirken kullanılan tanımlayıcı.	Evet
kimlik	String	Bilgisayar çağrısının benzersiz tanımlayıcısı.	Evet
pending_safety_checks	OpenAI.ComputerCallSafetyCheckParam dizisi	Bilgisayar çağrısı için bekleyen güvenlik denetimleri.	Evet
durum	enum	Öğenin durumu. in_progress, completed, veya bunlardan biri incomplete. Öğeler API aracılığıyla döndürülürken doldurulur. Olası değerler: in_progress, completed, incomplete	Evet
type	enum	Bilgisayar çağrısının türü. Her zaman computer_call. Olası değerler: computer_call	Evet

OpenAI.ConversationItemComputerToolCallOutputResource

İsim	Türü	Description	Gerekli	Varsayılan
acknowledged_safety_checks	OpenAI.ComputerCallSafetyCheckParam dizisi	API tarafından bildirilen ve kabul edilen güvenlik kontrolleri geliştirici.	Hayı
call_id	String	Çıktı üreten bilgisayar aracı çağrısının kimliği.	Evet
kimlik	String	Bilgisayar aracı çağrısı çıkış kimliği.	Hayı
çıktı	OpenAI.ComputerScreenshotImage	Bilgisayar kullanım aracıyla kullanılan bir bilgisayar ekran görüntüsü.	Evet
durum	enum	İleti girişinin durumu. in_progress, completed, veya bunlardan biri incomplete. API aracılığıyla giriş öğeleri döndürüldüğünde doldurulur. Olası değerler: in_progress, completed, incomplete	Hayı
type	enum	Bilgisayar araçlarının çağrı çıktısının türü. Her zaman computer_call_output. Olası değerler: computer_call_output	Evet

OpenAI.ConversationItemCustomToolCall

Model tarafından oluşturulan özel bir araca çağrı.

İsim	Türü	Description	Gerekli	Varsayılan
call_id	String	Bu özel araç çağrısını bir araç çağrısı çıktısına eşlemek için kullanılan bir tanımlayıcı.	Evet
kimlik	String	OpenAI platformundaki özel araç çağrısının benzersiz kimliği.	Hayı
girdi	String	Model tarafından oluşturulan özel araç çağrısı için girdi.	Evet
name	String	Çağrılan özel aracın adı.	Evet
type	enum	Özel araç çağrısının türü. Her zaman custom_tool_call. Olası değerler: custom_tool_call	Evet

OpenAI.ConversationItemCustomToolCallOutput

Kodunuzdan özel bir araç çağrısının çıktısı, modele geri gönderiliyor.

İsim	Türü	Description	Gerekli	Varsayılan
call_id	String	Çağrı kimliği, bu özel araç çağrısı çıktısını özel bir araç çağrısına eşlemek için kullanılır.	Evet
kimlik	String	OpenAI platformunda çıkan özel araç çağrısının benzersiz kimliği.	Hayı
çıktı	OpenAI.FunctionAndCustomToolCallOutput dizesi veya dizisi	Kodunuz tarafından oluşturulan özel araç çağrısından çıkan çıktı. Bir dizi veya çıkış içeriği listesi olabilir.	Evet
type	enum	Özel araç çağrısı çıkışının türü. Her zaman custom_tool_call_output. Olası değerler: custom_tool_call_output	Evet

OpenAI.ConversationItemFileSearchToolCall

Dosya arama aracı çağrısının sonuçları. Daha fazla bilgi için dosya arama rehberi adresine bakınız.

İsim	Türü	Description	Gerekli	Varsayılan
kimlik	String	Dosya arama aracı çağrısının benzersiz kimliği.	Evet
queries	dize dizisi	Dosyaları aramak için kullanılan sorgular.	Evet
results	OpenAI.FileSearchToolCallResults dizisi		Hayı
durum	enum	Dosya arama aracı çağrısının durumu. Bunlardan biri in_progress searching, incomplete veya failed, Olası değerler: in_progress, searching, completed, incomplete, failed	Evet
type	enum	Dosya arama aracı çağrısının türü. Her zaman file_search_call. Olası değerler: file_search_call	Evet

OpenAI.ConversationItemFunctionShellCall

Yönetilen bir ortamda bir veya daha fazla kabuk komutu yürüten bir araç çağrısı.

İsim	Türü	Description	Gerekli	Varsayılan
hareket	OpenAI.FunctionShellAction	Bir kabuk komutu yürütür.	Evet
└─ komutları	dize dizisi		Evet
└─ max_output_length	OpenAI.integer (null atanabilir)		Evet
└─ timeout_ms	OpenAI.integer (null atanabilir)		Evet
call_id	String	Model tarafından oluşturulan shell araç çağrısının benzersiz kimliği.	Evet
Oluşturan	String	Bu araç çağrısını oluşturan varlığın kimliği.	Hayı
kimlik	String	Kabuk aracı çağrısının benzersiz kimliği. Bu öğe, API aracılığıyla iade edildiğinde doldurulur.	Evet
durum	OpenAI.LocalShellCallStatus		Evet
type	enum	Öğenin türü. Her zaman shell_call. Olası değerler: shell_call	Evet

OpenAI.ConversationItemFunctionShellCallOutput

Yayılan bir kabuk aracı çağrısının çıktısı.

İsim	Türü	Description	Gerekli	Varsayılan
call_id	String	Model tarafından oluşturulan shell araç çağrısının benzersiz kimliği.	Evet
Oluşturan	String	Öğeyi oluşturan aktörün tanımlayıcısı.	Hayı
kimlik	String	Kabuk çağrısı çıkışının benzersiz kimliği. Bu öğe, API aracılığıyla iade edildiğinde doldurulur.	Evet
max_output_length	OpenAI.integer (null atanabilir)		Evet
çıktı	OpenAI.FunctionShellCallOutputContent dizisi	Kabuk çağrısı çıkış içeriği dizisi	Evet
type	enum	Kabuk çağrısı çıkışının türü. Her zaman shell_call_output. Olası değerler: shell_call_output	Evet

OpenAI.ConversationItemFunctionToolCallOutputResource

İsim	Türü	Description	Gerekli	Varsayılan
call_id	String	Model tarafından oluşturulan işlev aracı çağrısının benzersiz kimliği.	Evet
kimlik	String	İşlev aracının çağrı çıkışının benzersiz kimliği. Bu öğe doldurulduğunda API aracılığıyla döndürülür.	Hayı
çıktı	OpenAI.FunctionAndCustomToolCallOutput dizesi veya dizisi	Kodunuz tarafından oluşturulan işlev çağrısının çıktısı. Bir dizi veya çıkış içeriği listesi olabilir.	Evet
durum	enum	Öğenin durumu. in_progress, completed, veya bunlardan biri incomplete. Öğeler API aracılığıyla döndürülürken doldurulur. Olası değerler: in_progress, completed, incomplete	Hayı
type	enum	İşlev aracının çağrı çıktısının türü. Her zaman function_call_output. Olası değerler: function_call_output	Evet

OpenAI.ConversationItemFunctionToolCallResource

İsim	Türü	Description	Gerekli	Varsayılan
arguments	String	İşleve geçirecek bağımsız değişkenlerin JSON dizesi.	Evet
call_id	String	Model tarafından oluşturulan işlev aracı çağrısının benzersiz kimliği.	Evet
kimlik	String	İşlev aracı çağrısının benzersiz kimliği.	Hayı
name	String	Çalıştırılacak işlevin adı.	Evet
durum	enum	Öğenin durumu. in_progress, completed, veya bunlardan biri incomplete. Öğeler API aracılığıyla döndürülürken doldurulur. Olası değerler: in_progress, completed, incomplete	Hayı
type	enum	İşlev aracı çağrısının türü. Her zaman function_call. Olası değerler: function_call	Evet

OpenAI.ConversationItemImageGenToolCall

Model tarafından yapılan bir görüntü oluşturma isteği.

İsim	Türü	Description	Gerekli	Varsayılan
kimlik	String	Görüntü oluşturma çağrısının benzersiz kimliği.	Evet
sonuç	dize (null atanabilir)		Evet
durum	enum	Görüntü oluşturma çağrısının durumu. Olası değerler: in_progress, completed, generating, failed	Evet
type	enum	Görüntü oluşturma çağrısının türü. Her zaman image_generation_call. Olası değerler: image_generation_call	Evet

OpenAI.ConversationItemList

Konuşma öğelerinin listesi.

İsim	Türü	Description	Gerekli	Varsayılan
veriler	OpenAI.ConversationItem dizisi	Konuşma öğelerinin listesi.	Evet
ilk_kimlik	String	Listedeki ilk öğenin kimliği.	Evet
daha_fazla	Boolean	Kullanılabilir daha fazla öğe olup olmadığı.	Evet
son_kimlik	String	Listedeki son öğenin kimliği.	Evet
nesne	enum	Döndürülen nesnenin türü olmalıdır list. Olası değerler: list	Evet

OpenAI.ConversationItemLocalShellToolCall

Yerel kabukta komut çalıştırmak için bir araç çağrısı.

İsim	Türü	Description	Gerekli	Varsayılan
hareket	OpenAI.LocalShellExecAction	Sunucuda bir kabuk komutu yürütür.	Evet
call_id	String	Model tarafından oluşturulan yerel kabuk aracı çağrısının benzersiz kimliği.	Evet
kimlik	String	Yerel shell çağrısının benzersiz kimliği.	Evet
durum	enum	Yerel shell çağrısının durumu. Olası değerler: in_progress, completed, incomplete	Evet
type	enum	Yerel shell call'ın türü. Her zaman local_shell_call. Olası değerler: local_shell_call	Evet

OpenAI.ConversationItemLocalShellToolCallOutput

Yerel kabuk aracı çağrısının çıktısı.

İsim	Türü	Description	Gerekli	Varsayılan
kimlik	String	Model tarafından oluşturulan yerel kabuk aracı çağrısının benzersiz kimliği.	Evet
çıktı	String	Yerel kabuk aracı çağrısının çıkışının JSON dizesi.	Evet
durum	enum	Olası değerler: in_progress, completed, incomplete	Hayı
type	enum	Yerel kabuk aracı çağrı çıkışının türü. Her zaman local_shell_call_output. Olası değerler: local_shell_call_output	Evet

OpenAI.ConversationItemMcpApprovalRequest

Bir araç çağrısı işlemi için insan onayı isteği.

İsim	Türü	Description	Gerekli	Varsayılan
arguments	String	Araç için bir JSON bağımsız değişken dizesi.	Evet
kimlik	String	Onay talebinin benzersiz kimliği.	Evet
name	String	Çalıştırılacak aracın adı.	Evet
sunucu etiketi	String	İsteği yapan MCP sunucusunun etiketi.	Evet
type	enum	Öğenin türü. Her zaman mcp_approval_request. Olası değerler: mcp_approval_request	Evet

OpenAI.ConversationItemMcpApprovalResponseResource

MCP onay isteğine yanıt.

İsim	Türü	Description	Gerekli	Varsayılan
approval_request_id	String	Yanıtlanan onay isteğinin ID'si.	Evet
approve	Boolean	İsteğin onaylanıp onaylanmadı.	Evet
kimlik	String	Onay yanıtının benzersiz kimliği	Evet
sebep	dize (null atanabilir)		Hayı
type	enum	Öğenin türü. Her zaman mcp_approval_response. Olası değerler: mcp_approval_response	Evet

OpenAI.ConversationItemMcpListTools

MCP sunucusunda kullanılabilen araçların listesi.

İsim	Türü	Description	Gerekli	Varsayılan
hata	dize (null atanabilir)		Hayı
kimlik	String	Listenin benzersiz kimliği.	Evet
sunucu etiketi	String	MCP sunucusunun etiketi.	Evet
araçlar	OpenAI.MCPListToolsTool dizisi	Sunucuda bulunan araçlar.	Evet
type	enum	Öğenin türü. Her zaman mcp_list_tools. Olası değerler: mcp_list_tools	Evet

OpenAI.ConversationItemMcpToolCall

MCP sunucusundaki bir aracın çağrılması.

İsim	Türü	Description	Gerekli	Varsayılan
approval_request_id	dize (null atanabilir)		Hayı
arguments	String	Araca geçirilen bağımsız değişkenlerin JSON dizesi.	Evet
hata	dize (null atanabilir)		Hayı
kimlik	String	Araç çağrısının benzersiz kimliği.	Evet
name	String	Çalıştırılan aracın adı.	Evet
çıktı	dize (null atanabilir)		Hayı
sunucu etiketi	String	Aracı çalıştıran MCP sunucusunun etiketi.	Evet
durum	OpenAI.MCPToolCallStatus		Hayı
type	enum	Öğenin türü. Her zaman mcp_call. Olası değerler: mcp_call	Evet

OpenAI.ConversationItemMessage

Modele veya modelden gelen bir ileti.

İsim	Türü	Description	Gerekli	Varsayılan
içerik	OpenAI.MessageContent dizisi	İletinin içeriği	Evet
kimlik	String	İletinin benzersiz kimliği.	Evet
role	OpenAI.MessageRole		Evet
durum	OpenAI.MessageStatus		Evet
type	enum	İletinin türü. Her zaman messageolarak ayarlayın. Olası değerler: message	Evet

OpenAI.ConversationItemReasoningItem

Bir yanıt oluştururken bir akıl yürütme modeli tarafından kullanılan düşünce zincirinin açıklaması. Eğer konuşmanın sonraki turlarında bu öğeleri bağlam yönetiyorsanız ile manuel olarak konuşuyorsanız, Responses API'ye input hesabınıza dahil edin.

İsim	Türü	Description	Gerekli	Varsayılan
içerik	OpenAI.ReasoningTextContent dizisi	Metin içeriğini akıl yürütme.	Hayı
encrypted_content	dize (null atanabilir)		Hayı
kimlik	String	Akıl yürütme içeriğinin benzersiz tanımlayıcısı.	Evet
durum	enum	Öğenin durumu. in_progress, completed, veya bunlardan biri incomplete. Öğeler API aracılığıyla döndürülürken doldurulur. Olası değerler: in_progress, completed, incomplete	Hayı
summary	OpenAI.Summary dizisi	Akıl yürütme özeti içeriği.	Evet
type	enum	Nesnenin türü. Her zaman reasoning. Olası değerler: reasoning	Evet

OpenAI.ConversationItemType

Mülkiyet	Değer
Türü	String
Değerler	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

Bir web arama aracı çağrısının sonuçları. Daha fazla bilgi için web arama rehberi adresine bakınız.

İsim	Türü	Description	Gerekli	Varsayılan
hareket	OpenAI.WebSearchActionSearch veya OpenAI.WebSearchActionOpenPage veya OpenAI.WebSearchActionFind	Bu web arama çağrısında gerçekleştirilen belirli eylemi açıklayan bir nesne. Modelin web'i nasıl kullandığına ilişkin ayrıntıları içerir (arama, open_page, bulma).	Evet
kimlik	String	Web arama aracının benzersiz kimliği çağrı.	Evet
durum	enum	Web arama aracı çağrısının durumu. Olası değerler: in_progress, searching, completed, failed	Evet
type	enum	Web arama aracının türü. Her zaman web_search_call. Olası değerler: web_search_call	Evet

OpenAI.ConversationParam

Bu yanıtın ait olduğu konuşma. Bu konuşmadaki öğeler, bu yanıt isteği için öğesine input_items eklenir. Bu yanıt tamamlandıktan sonra bu yanıttaki giriş öğeleri ve çıkış öğeleri otomatik olarak bu konuşmaya eklenir.

Tür: dize veya OpenAI.ConversationParam-2

Bu yanıtın ait olduğu konuşma. Bu konuşmadaki öğeler, bu yanıt isteği için öğesine input_items eklenir. Bu yanıt tamamlandıktan sonra bu yanıttaki giriş öğeleri ve çıkış öğeleri otomatik olarak bu konuşmaya eklenir.

OpenAI.ConversationParam-2

Bu yanıtın ait olduğu konuşma.

İsim	Türü	Description	Gerekli	Varsayılan
kimlik	String	Konuşmanın benzersiz kimliği.	Evet

OpenAI.ConversationReference

Bu yanıtın ait olduğu konuşma. Bu yanıttaki giriş öğeleri ve çıkış öğeleri bu konuşmaya otomatik olarak eklendi.

İsim	Türü	Description	Gerekli	Varsayılan
kimlik	String	Bu yanıtın ilişkilendirildiği konuşmanın benzersiz kimliği.	Evet

OpenAI.ConversationResource

İsim	Türü	Description	Gerekli	Varsayılan
oluşturulma_tarihi	tamsayı	Unix döneminin ardından saniye cinsinden ölçülen konuşmanın oluşturulduğu zaman.	Evet
kimlik	String	Konuşmanın benzersiz kimliği.	Evet
metadata	OpenAI.Metadata	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Evet
nesne	enum	Her zaman conversationolan nesne türü. Olası değerler: conversation	Evet

OpenAI.CreateChatCompletionRequestResponseFormat

Modelin çıkış yapması gereken biçimi belirten bir nesne. ayarı, { "type": "json_schema", "json_schema": {...} } modelin sağlanan JSON şemanızla eşleşmesini sağlayan Yapılandırılmış Çıkışları etkinleştirir. Structured Outputs rehberi için daha fazla bilgi edinebilirsiniz. ayarı { "type": "json_object" } , modelin oluşturduğu iletinin geçerli JSON olduğundan emin olan eski JSON modunu etkinleştirir. Destekleyen modeller için json_schema kullanılması tercih edilir.

OpenAI.CreateChatCompletionRequestResponseFormat için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
text	OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText
json_object	OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.CreateChatCompletionRequestResponseFormatType		Evet

OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject

JSON nesne yanıt biçimi. JSON yanıtları oluşturmanın eski bir yöntemi. Bunu destekleyen modeller için kullanılması json_schema önerilir. Modelin, bir sistem veya kullanıcı mesajı olmadan JSON oluşturmayacağını unutmayın, bunu to do etmelidir.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Tanımlanan yanıt biçiminin türü. Her zaman json_object. Olası değerler: json_object	Evet

OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText

Varsayılan yanıt biçimi. Metin yanıtları oluşturmak için kullanılır.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Tanımlanan yanıt biçiminin türü. Her zaman text. Olası değerler: text	Evet

OpenAI.CreateChatCompletionRequestResponseFormatType

Mülkiyet	Değer
Türü	String
Değerler	text json_schema json_object

OpenAI.CreateConversationBody

İsim	Türü	Description	Gerekli	Varsayılan
nesneler	OpenAI.InputItem dizisi		Hayı
metadata	OpenAI.Metadata (null atanabilir)	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Hayı

OpenAI.CreateEvalCompletionsRunDataSource

Model örnekleme yapılandırmasını açıklayan CompletionsRunDataSource nesnesi.

İsim	Türü	Description	Gerekli	Varsayılan
input_mesajları	OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesTemplate veya OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference	Modelden örnekleme yaparken kullanılır. Modele geçirilen iletilerin yapısını dikte eder. Önceden oluşturulmuş bir yörüngeye (örn item.input_trajectory. ) başvuru veya ad alanına değişken başvuruları item içeren bir şablon olabilir.	Hayı
model	String	Tamamlanmaları oluşturmak için kullanılacak modelin adı (örneğin, "o3-mini").	Hayı
Örnekleme_Parametreleri	OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams		Hayı
kaynak	OpenAI.EvalJsonlFileContentSource veya OpenAI.EvalJsonlFileIdSource veya OpenAI.EvalStoredCompletionsSource	Bu çalıştırmanın veri kaynağındaki ad alanını item neyin dolduracaklarını belirler.	Evet
type	enum	Çalıştırma veri kaynağının türü. Her zaman completions. Olası değerler: completions	Evet

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference

İsim	Türü	Description	Gerekli	Varsayılan
item_reference	String		Evet
type	enum	Olası değerler: item_reference	Evet

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesTemplate

İsim	Türü	Description	Gerekli	Varsayılan
şablon	OpenAI.EasyInputMessage veya OpenAI.EvalItem dizisi		Evet
type	enum	Olası değerler: template	Evet

OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams

İsim	Türü	Description	Gerekli	Varsayılan
max_completion_tokens	OpenAI.integer		Hayı
akıl yürütme çabası	OpenAI.ReasoningEffort	Akıl yürütme çabasını kısıtlar mantıp modelleri. Şu anda desteklenen değerler none, minimal, low, medium, high, ve xhigh'dir. Azaltma muhakeme çabası daha hızlı yanıtlara ve daha az belirteç kullanılmasına neden olabilir bir yanıtta mantık yürütme. - gpt-5.1 varsayılan olarak noneöğesini kullanır ve mantık yürütmez. Desteklenen gerekçe değerleri gpt-5.1none, low, medium, ve high'dir. Araç çağrıları gpt-5.1'deki tüm akıl yürütme değerleri için desteklenir. - Tüm modeller varsayılan olarak akıl yürütme eforu olmadan gpt-5.1 önce medium ve desteklemeznone. - Model gpt-5-pro varsayılan olarak akıl yürütme eforunu kullanır (ve yalnızca destekler high ). - xhigh , sonrasındaki gpt-5.1-codex-maxtüm modeller için desteklenir.	Hayı
yanıt formatı	OpenAI.ResponseFormatText veya OpenAI.ResponseFormatJsonSchema veya OpenAI.ResponseFormatJsonObject		Hayı
seed	OpenAI.integer		Hayı	42
sıcaklık	OpenAI.numeric		Hayı	1
araçlar	OpenAI.ChatCompletionTool dizisi		Hayı
top_p	OpenAI.numeric		Hayı	1

OpenAI.CreateEvalCustomDataSourceConfig

Değerlendirme çalıştırmaları için kullanılan veri kaynağının şemasını tanımlayan customDataSourceConfig nesnesi. Bu şema, aşağıdaki verilerin şeklini tanımlamak için kullanılır:

• Test ölçütlerinizi tanımlamak için kullanılır ve
• Çalıştırma oluştururken hangi veriler gereklidir?

İsim	Türü	Description	Gerekli	Varsayılan
örnek_şema_dahil_et	Boolean	Değerlendirmenin örnek ad alanını doldurmanızı beklemesi gerekip gerekmediği (örneğin, veri kaynağınızdan yanıt oluşturarak)	Hayı
öğe şeması	nesne	Veri kaynağındaki her satır için json şeması.	Evet
type	enum	Veri kaynağının türü. Her zaman custom. Olası değerler: custom	Evet

OpenAI.CreateEvalJsonlRunDataSource

Değerlendirmeyle eşleşen JSONL dosyasını belirten bir JsonlRunDataSource nesnesi

İsim	Türü	Description	Gerekli	Varsayılan
kaynak	OpenAI.EvalJsonlFileContentSource veya OpenAI.EvalJsonlFileIdSource	Veri kaynağındaki ad alanını item neyin doldurdığını belirler.	Evet
type	enum	Veri kaynağının türü. Her zaman jsonl. Olası değerler: jsonl	Evet

OpenAI.CreateEvalLogsDataSourceConfig

Günlükler sorgunuzun meta veri özelliğini belirten bir veri kaynağı yapılandırması. Bu genellikle usecase=chatbot, prompt-version=v2 gibi meta veridir vb.

İsim	Türü	Description	Gerekli	Varsayılan
metadata	nesne	Log veri kaynağı için meta veri filtreleri.	Hayı
type	enum	Veri kaynağının türü. Her zaman logs. Olası değerler: logs	Evet

OpenAI.CreateEvalResponsesRunDataSource

Model örnekleme yapılandırmasını açıklayan Bir ResponsesRunDataSource nesnesi.

İsim	Türü	Description	Gerekli	Varsayılan
input_mesajları	OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate veya OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference	Modelden örnekleme yaparken kullanılır. Modele geçirilen iletilerin yapısını dikte eder. Önceden oluşturulmuş bir yörüngeye (örn item.input_trajectory. ) başvuru veya ad alanına değişken başvuruları item içeren bir şablon olabilir.	Hayı
model	String	Tamamlanmaları oluşturmak için kullanılacak modelin adı (örneğin, "o3-mini").	Hayı
Örnekleme_Parametreleri	OpenAI.CreateEvalResponsesRunDataSourceSamplingParams		Hayı
kaynak	OpenAI.EvalJsonlFileContentSource veya OpenAI.EvalJsonlFileIdSource veya OpenAI.EvalResponsesSource	Bu çalıştırmanın veri kaynağındaki ad alanını item neyin dolduracaklarını belirler.	Evet
type	enum	Çalıştırma veri kaynağının türü. Her zaman responses. Olası değerler: responses	Evet

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference

İsim	Türü	Description	Gerekli	Varsayılan
item_reference	String		Evet
type	enum	Olası değerler: item_reference	Evet

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate

İsim	Türü	Description	Gerekli	Varsayılan
şablon	object dizisi veya OpenAI.EvalItem		Evet
type	enum	Olası değerler: template	Evet

OpenAI.CreateEvalResponsesRunDataSourceSamplingParams

İsim	Türü	Description	Gerekli	Varsayılan
max_completion_tokens	OpenAI.integer		Hayı
akıl yürütme çabası	OpenAI.ReasoningEffort	Akıl yürütme çabasını kısıtlar mantıp modelleri. Şu anda desteklenen değerler none, minimal, low, medium, high, ve xhigh'dir. Azaltma muhakeme çabası daha hızlı yanıtlara ve daha az belirteç kullanılmasına neden olabilir bir yanıtta mantık yürütme. - gpt-5.1 varsayılan olarak noneöğesini kullanır ve mantık yürütmez. Desteklenen gerekçe değerleri gpt-5.1none, low, medium, ve high'dir. Araç çağrıları gpt-5.1'deki tüm akıl yürütme değerleri için desteklenir. - Tüm modeller varsayılan olarak akıl yürütme eforu olmadan gpt-5.1 önce medium ve desteklemeznone. - Model gpt-5-pro varsayılan olarak akıl yürütme eforunu kullanır (ve yalnızca destekler high ). - xhigh , sonrasındaki gpt-5.1-codex-maxtüm modeller için desteklenir.	Hayı
seed	OpenAI.integer		Hayı	42
sıcaklık	OpenAI.numeric		Hayı	1
text	OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText		Hayı
araçlar	OpenAI.Tool dizisi		Hayı
top_p	OpenAI.numeric		Hayı	1

OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText

İsim	Türü	Description	Gerekli	Varsayılan
format	OpenAI.TextResponseFormatConfiguration	Modelin çıkış yapması gereken biçimi belirten bir nesne. Yapılandırma { "type": "json_schema" } , Yapılandırılmış Çıkışları etkinleştirir, modelin sağlanan JSON şemanızla eşleşmesini sağlar. Daha fazla bilgi için Varsayılan biçim { "type": "text" } ek seçenek yoktur. *gpt-4o ve daha yeni modeller için önerilmez:** { "type": "json_object" } ayarı, eski JSON modunu etkinleştirir. modelin oluşturduğu iletinin geçerli JSON olduğundan emin olur. json_schema’ı kullanma Bu özelliği destekleyen modeller için tercih edilir.	Hayı

OpenAI.CreateEvalStoredCompletionsDataSourceConfig

LogsDataSourceConfig yerine kullanım dışı bırakıldı.

İsim	Türü	Description	Gerekli	Varsayılan
metadata	nesne	Depolanan tamamlamalar veri kaynağı için meta veri filtreleri.	Hayı
type	enum	Veri kaynağının türü. Her zaman stored_completions. Olası değerler: stored_completions	Evet

OpenAI.CreateFineTuningJobRequest

Geçerli modeller:

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

İsim	Türü	Description	Gerekli	Varsayılan
hiper parametreler	OpenAI.CreateFineTuningJobRequestHyperparameters		Hayı
└─ yığın boyutu	dize veya OpenAI.integer		Hayı	otomatik
└─ öğrenme oranı çarpanı	dize veya OpenAI.numeric		Hayı
└─ n_epochs	dize veya OpenAI.integer		Hayı	otomatik
Entegrasyonlar	OpenAI.CreateFineTuningJobRequestIntegrations dizisi	İnce ayar işiniz için etkinleştirecek tümleştirmelerin listesi.	Hayı
metadata	OpenAI.Metadata (null atanabilir)	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Hayı
method	OpenAI.FineTuneMethod	İnce ayar için kullanılan yöntem.	Hayı
model	dize (aşağıdaki geçerli modellere bakın)	İnce ayar için modelin adı. Aşağıdakilerden birini seçebilirsiniz: destekli modeller.	Evet
seed	OpenAI.integer (null atanabilir)		Hayı
suffix	dize (null atanabilir)	İnce ayarlı model adınıza eklenecek en fazla 64 karakterlik bir dize. Örneğin, suffix "özel model-adı" gibi bir model adı ft:gpt-4o-mini:openai:custom-model-name:7p4lURelüretir. Kısıtlamalar: minLength: 1, maxLength: 64	Hayı
eğitim_dosyası	String	Eğitim verilerini içeren karşıya yüklenen bir dosyanın kimliği. Karşıya dosya yükleme hakkında bilgi için bkz. dosyayı karşıya yükleme. Veri kümeniz JSONL dosyası olarak biçimlendirilmelidir. Ayrıca, dosyanızı amacı fine-tuneile karşıya yüklemeniz gerekir. Dosyanın içeriği, modelin sohbet, tamamlanma biçimi veya ince ayar yönteminin tercih biçimini kullanıp kullanmama durumuna bağlı olarak farklılık göstermelidir. Daha fazla detay için ince ayar rehberi sayfasına bakınız.	Evet
doğrulama_dosyası	dize (null atanabilir)	Doğrulama verilerini içeren karşıya yüklenen bir dosyanın kimliği. Bu dosyayı sağlarsanız, veriler doğrulama oluşturmak için kullanılır ölçümlerini ince ayarlama sırasında düzenli aralıklarla gerçekleştirin. Bu ölçümler ince ayar sonuçları dosyası. Aynı veriler hem eğitme hem de doğrulama dosyalarında bulunmamalıdır. Veri kümeniz JSONL dosyası olarak biçimlendirilmelidir. Dosyanızı amacı fine-tuneile karşıya yüklemeniz gerekir. Daha fazla detay için ince ayar rehberi sayfasına bakınız.	Hayı

OpenAI.CreateFineTuningJobRequestHyperparameters

İsim	Türü	Description	Gerekli	Varsayılan
küme_boyutu	dize veya OpenAI.integer		Hayı
öğrenme oranı çarpanı	dize veya OpenAI.numeric		Hayı
n_devir	dize veya OpenAI.integer		Hayı

OpenAI.CreateFineTuningJobRequestIntegrations

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olası değerler: wandb	Evet
wandb	OpenAI.CreateFineTuningJobRequestIntegrationsWandb		Evet

OpenAI.CreateFineTuningJobRequestIntegrationsWandb

İsim	Türü	Description	Gerekli	Varsayılan
varlık	dize (null atanabilir)		Hayı
name	dize (null atanabilir)		Hayı
project	String		Evet
tags	dize dizisi		Hayı

OpenAI.CreateResponseStreamingResponse

Tür: OpenAI.ResponseAudioDeltaEvent veya OpenAI.ResponseAudioTranscriptDeltaEvent veya OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent veya OpenAI.ResponseCodeInterpreterCallInProgressEvent veya OpenAI.ResponseCodeInterpreterCallInterpretingEvent veya OpenAI.ResponseContentPartAddedEvent veya OpenAI.ResponseCreatedEvent veya OpenAI.ResponseErrorEvent veya OpenAI.ResponseFileSearchCallInProgressEvent veya OpenAI.ResponseFileSearchCallSearchingEvent veya OpenAI.ResponseFunctionCallArgumentsDeltaEvent veya OpenAI.ResponseInProgressEvent veya OpenAI.ResponseFailedEvent veya OpenAI.ResponseIncompleteEvent veya OpenAI.ResponseOutputItemAddedEvent veya OpenAI.ResponseReasoningSummaryPartAddedEvent veya OpenAI.ResponseReasoningSummaryTextDeltaEvent veya OpenAI.ResponseReasoningTextDeltaEvent veya OpenAI.ResponseRefusalDeltaEvent veya OpenAI.ResponseTextDeltaEvent veya OpenAI.ResponseWebSearchCallInProgressEvent veya OpenAI.ResponseWebSearchCallSearchingEvent veya OpenAI.ResponseImageGenCallGeneratingEvent veya OpenAI.ResponseImageGenCallInProgressEvent veya OpenAI.ResponseImageGenCallPartialImageEvent veya OpenAI.ResponseMCPCallArgumentsDeltaEvent veya OpenAI.ResponseMCPCallFailedEvent veya OpenAI.ResponseMCPCallInProgressEvent veya OpenAI.ResponseMCPListToolsFailedEvent veya OpenAI.ResponseMCPListToolsInProgressEvent veya OpenAI.ResponseOutputTextAnnotationAddedEvent veya OpenAI.ResponseQueuedEvent veya OpenAI.ResponseCustomToolCallInputDeltaEvent veya OpenAI.ResponseAudioDoneEvent veya OpenAI.ResponseAudioTranscriptDoneEvent veya OpenAI.ResponseCodeInterpreterCallCodeDoneEvent veya OpenAI.ResponseCodeInterpreterCallCompletedEvent veya OpenAI.ResponseCompletedEvent veya OpenAI.ResponseContentPartDoneEvent veya OpenAI.ResponseFileSearchCallCompletedEvent veya OpenAI.ResponseFunctionCallArgumentsDoneEvent veya OpenAI.ResponseOutputItemDoneEvent veya OpenAI.ResponseReasoningSummaryPartDoneEvent veya OpenAI.ResponseReasoningSummaryTextDoneEvent veya OpenAI.ResponseReasoningTextDoneEvent veya OpenAI.ResponseRefusalDoneEvent veya OpenAI.ResponseTextDoneEvent veya OpenAI.ResponseWebSearchCallCompletedEvent veya OpenAI.ResponseImageGenCallCompletedEvent veya OpenAI.ResponseMCPCallArgumentsDoneEvent veya OpenAI.ResponseMCPCallCompletedEvent veya OpenAI.ResponseMCPListToolsCompletedEvent veya OpenAI.ResponseCustomToolCallInputDoneEvent

OpenAI.CustomGrammarFormatParam

Kullanıcı tarafından tanımlanan bir dilbilgisi.

İsim	Türü	Description	Gerekli	Varsayılan
tanım	String	Dilbilgisi tanımı.	Evet
syntax	OpenAI.GrammarSyntax1		Evet
type	enum	Dilbilgisi formatı. Her zaman grammar. Olası değerler: grammar	Evet

OpenAI.CustomTextFormatParam

Sınırsız serbest biçimli metin.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Sınırsız metin formatı. Her zaman text. Olası değerler: text	Evet

OpenAI.CustomToolParam

Belirli bir formatla girdiyi işleyen özel bir araç. özel araçlar

İsim	Türü	Description	Gerekli	Varsayılan
açıklama	String	Daha fazla bağlam sağlamak için kullanılan özel aracın isteğe bağlı açıklaması.	Hayı
format	OpenAI.CustomToolParamFormat	Özel araç için giriş formatı. Varsayılan metin sınırsız olur.	Hayı
└─ türü	OpenAI.CustomToolParamFormatType		Evet
name	String	Özel aracın adı, aracı çağırmalarda tanımlamak için kullanılır.	Evet
type	enum	Özel aracın türü. Her zaman custom. Olası değerler: custom	Evet

OpenAI.CustomToolParamFormat

Özel araç için giriş formatı. Varsayılan metin sınırsız olur.

OpenAI.CustomToolParamFormat için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
text	OpenAI.CustomTextFormatParam
grammar	OpenAI.CustomGrammarFormatParam

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.CustomToolParamFormatType		Evet

OpenAI.CustomToolParamFormatType

Mülkiyet	Değer
Türü	String
Değerler	text grammar

OpenAI.DeletedConversationResource

İsim	Türü	Description	Gerekli	Varsayılan
silindi	Boolean		Evet
kimlik	String		Evet
nesne	enum	Olası değerler: conversation.deleted	Evet

OpenAI.DetailEnum

Mülkiyet	Değer
Türü	String
Değerler	low high auto

OpenAI.DoubleClickAction

Çift tıklama eylemi.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olay türünü belirtir. Çift tıklama eylemi için bu özellik her zaman olarak double_clickayarlanır. Olası değerler: double_click	Evet
x	OpenAI.integer		Evet
y	OpenAI.integer		Evet

OpenAI.Drag

Sürükleme eylemi.

İsim	Türü	Description	Gerekli	Varsayılan
path	OpenAI.DragPoint dizisi	Sürükleme eyleminin yolunu temsil eden koordinat dizisi. Koordinatlar bir dizi olarak görünür nesnelerin, örneğin <br> [<br> { x: 100, y: 200 },<br> { x: 200, y: 300 }<br> ]<br>	Evet
type	enum	Olay türünü belirtir. Sürükleme eylemi için bu özellik her zaman drag olarak ayarlanır. Olası değerler: drag	Evet

OpenAI.DragPoint

X/y koordinat çifti, örneğin. { x: 100, y: 200 }

İsim	Türü	Description	Gerekli	Varsayılan
x	OpenAI.integer		Evet
y	OpenAI.integer		Evet

OpenAI.EasyInputMessage

Modele, hiyerarşiyi izleyen yönergeyi belirten bir rol içeren bir ileti girişi. developer veya system rolüyle verilen yönergeler, user rolüyle verilen yönergelerden önceliklidir. assistant rolüne sahip iletilerin, önceki etkileşimlerde model tarafından oluşturulduğu varsayılır.

İsim	Türü	Description	Gerekli	Varsayılan
içerik	string veya OpenAI.InputMessageContentList	Yanıt oluşturmak için kullanılan modele metin, görüntü veya ses girişi. Önceki yardımcı yanıtlarını da içerebilir.	Evet
role	enum	İleti girişinin rolü. user, assistant, system'den biri developer. Olası değerler: user, assistant, system, developer	Evet
durum	enum	Öğenin durumu. in_progress, completed, veya bunlardan biri incomplete. Öğeler API aracılığıyla döndürülürken doldurulur. Olası değerler: in_progress, completed, incomplete	Hayı
type	enum	İleti girişinin türü. Her zaman message. Olası değerler: message	Evet

OpenAI.Error

İsim	Türü	Description	Gerekli	Varsayılan
ek bilgi	nesne		Hayı
kod	dize (null atanabilir)		Evet
hata ayıklama bilgisi	nesne		Hayı
details	OpenAI.Error dizisi		Hayı
mesaj	String		Evet
param	dize (null atanabilir)		Hayı
type	String		Hayı

OpenAI.EvalApiError

Değerlendirme API'sinden bir hata yanıtını temsil eden nesne.

İsim	Türü	Description	Gerekli	Varsayılan
kod	String	Hata kodu.	Evet
mesaj	String	Hata iletisi.	Evet

OpenAI.EvalGraderLabelModel

İsim	Türü	Description	Gerekli	Varsayılan
girdi	OpenAI.EvalItem dizisi		Evet
labels	dize dizisi	Değerlendirmedeki her öğeye atanacak etiketler.	Evet
model	String	Değerlendirme için kullanılacak model. Yapılandırılmış çıktıları destekleme zorunluluğu vardır.	Evet
name	String	Değerlendiricinin adı.	Evet
geçen etiketler	dize dizisi	Geçen sonucu belirten etiketler. Etiketlerin bir alt kümesi olmalıdır.	Evet
type	enum	Her zaman label_modelolan nesne türü. Olası değerler: label_model	Evet

OpenAI.EvalGraderPython

İsim	Türü	Description	Gerekli	Varsayılan
image_tag	String	Python betiği için kullanılacak görüntü etiketi.	Hayı
name	String	Değerlendiricinin adı.	Evet
eşik_geçiş	OpenAI.numeric		Hayı
kaynak	String	Python betiğinin kaynak kodu.	Evet
type	enum	Her zaman pythonolan nesne türü. Olası değerler: python	Evet

OpenAI.EvalGraderScoreModel

İsim	Türü	Description	Gerekli	Varsayılan
girdi	OpenAI.EvalItem dizisi	Not veren tarafından değerlendirilen giriş iletileri. Metin, çıkış metni, giriş görüntüsü ve giriş ses içerik bloklarını destekler ve şablon dizeleri içerebilir.	Evet
model	String	Değerlendirme için kullanılacak model.	Evet
name	String	Değerlendiricinin adı.	Evet
eşik_geçiş	OpenAI.numeric		Hayı
menzil	OpenAI.numeric dizisi	Puan aralığı. Varsayılan olarak [0, 1] değerini alır.	Hayı
Örnekleme_Parametreleri	OpenAI.EvalGraderScoreModelSamplingParams		Hayı
└─ max_completions_tokens	OpenAI.integer (null atanabilir)		Hayı
└─ akıl yürütme çabası	OpenAI.ReasoningEffort	Akıl yürütme çabasını kısıtlar mantıp modelleri. Şu anda desteklenen değerler none, minimal, low, medium, high, ve xhigh'dir. Azaltma muhakeme çabası daha hızlı yanıtlara ve daha az belirteç kullanılmasına neden olabilir bir yanıtta mantık yürütme. - gpt-5.1 varsayılan olarak noneöğesini kullanır ve mantık yürütmez. Desteklenen gerekçe değerleri gpt-5.1none, low, medium, ve high'dir. Araç çağrıları gpt-5.1'deki tüm akıl yürütme değerleri için desteklenir. - Tüm modeller varsayılan olarak akıl yürütme eforu olmadan gpt-5.1 önce medium ve desteklemeznone. - Model gpt-5-pro varsayılan olarak akıl yürütme eforunu kullanır (ve yalnızca destekler high ). - xhigh , sonrasındaki gpt-5.1-codex-maxtüm modeller için desteklenir.	Hayı
└─ tohum	OpenAI.integer (null atanabilir)		Hayı
└─ sıcaklık	OpenAI.numeric (null atanabilir)		Hayı
└─ top_p	OpenAI.numeric (null atanabilir)		Hayı	1
type	enum	Her zaman score_modelolan nesne türü. Olası değerler: score_model	Evet

OpenAI.EvalGraderScoreModelSamplingParams

İsim	Türü	Description	Gerekli	Varsayılan
max_completions_tokens	OpenAI.integer (null atanabilir)		Hayı
akıl yürütme çabası	OpenAI.ReasoningEffort	Akıl yürütme çabasını kısıtlar mantıp modelleri. Şu anda desteklenen değerler none, minimal, low, medium, high, ve xhigh'dir. Azaltma muhakeme çabası daha hızlı yanıtlara ve daha az belirteç kullanılmasına neden olabilir bir yanıtta mantık yürütme. - gpt-5.1 varsayılan olarak noneöğesini kullanır ve mantık yürütmez. Desteklenen gerekçe değerleri gpt-5.1none, low, medium, ve high'dir. Araç çağrıları gpt-5.1'deki tüm akıl yürütme değerleri için desteklenir. - Tüm modeller varsayılan olarak akıl yürütme eforu olmadan gpt-5.1 önce medium ve desteklemeznone. - Model gpt-5-pro varsayılan olarak akıl yürütme eforunu kullanır (ve yalnızca destekler high ). - xhigh , sonrasındaki gpt-5.1-codex-maxtüm modeller için desteklenir.	Hayı
seed	OpenAI.integer (null atanabilir)		Hayı
sıcaklık	OpenAI.numeric (null atanabilir)		Hayı
top_p	OpenAI.numeric (null atanabilir)		Hayı	1

OpenAI.EvalGraderStringCheck

İsim	Türü	Description	Gerekli	Varsayılan
girdi	String	Giriş metni. Bu, şablon dizelerini içerebilir.	Evet
name	String	Değerlendiricinin adı.	Evet
Operasyon	enum	Gerçekleştirilecek dize denetimi işlemi. eq, ne, like veya ilike. Olası değerler: eq, ne, like, ilike	Evet
referans	String	Başvuru metni. Bu, şablon dizelerini içerebilir.	Evet
type	enum	Her zaman string_checkolan nesne türü. Olası değerler: string_check	Evet

OpenAI.EvalGraderTextSimilarity

İsim	Türü	Description	Gerekli	Varsayılan
değerlendirme ölçütü	enum	Kullanılacak değerlendirme ölçümü. cosine, , fuzzy_match, bleu, gleu, meteor, rouge_1, , rouge_2, rouge_3, rouge_4, rouge_5, veya rouge_l. Olası değerler: cosine, fuzzy_match, bleu, , gleu, meteor, , rouge_1, rouge_2rouge_3, rouge_4rouge_5,rouge_l	Evet
girdi	String	Notlanan metin.	Evet
name	String	Değerlendiricinin adı.	Evet
eşik_geçiş	OpenAI.numeric		Evet
referans	String	Değerlendirmenin yapıldığı metin.	Evet
type	enum	Not verenin türü. Olası değerler: text_similarity	Evet

OpenAI.EvalItem

Modele, hiyerarşiyi izleyen yönergeyi belirten bir rol içeren bir ileti girişi. developer veya system rolüyle verilen yönergeler, user rolüyle verilen yönergelerden önceliklidir. assistant rolüne sahip iletilerin, önceki etkileşimlerde model tarafından oluşturulduğu varsayılır.

İsim	Türü	Description	Gerekli	Varsayılan
içerik	OpenAI.EvalItemContent	Modele girişler - şablon dizeleri içerebilir. Tek bir öğe veya öğe dizisi olarak metin, çıkış metni, giriş görüntüleri ve giriş sesini destekler.	Evet
role	enum	İleti girişinin rolü. user, assistant, system'den biri developer. Olası değerler: user, assistant, system, developer	Evet
type	enum	İleti girişinin türü. Her zaman message. Olası değerler: message	Hayı

OpenAI.EvalItemContent

Modele girişler - şablon dizeleri içerebilir. Tek bir öğe veya öğe dizisi olarak metin, çıkış metni, giriş görüntüleri ve giriş sesini destekler.

Tür: OpenAI.EvalItemContentItem veya OpenAI.EvalItemContentArray

Modele girişler - şablon dizeleri içerebilir. Tek bir öğe veya öğe dizisi olarak metin, çıkış metni, giriş görüntüleri ve giriş sesini destekler.

OpenAI.EvalItemContentArray

Her biri giriş metni, çıkış metni, giriş görüntüsü veya giriş ses nesnesi olabilecek girişlerin listesi.

Dizisi: OpenAI.EvalItemContentItem

OpenAI.EvalItemContentItem

Tek bir içerik öğesi: giriş metni, çıkış metni, giriş görüntüsü veya giriş sesi.

Tür: OpenAI.EvalItemContentText veya OpenAI.EvalItemContentItemObject

Tek bir içerik öğesi: giriş metni, çıkış metni, giriş görüntüsü veya giriş sesi.

OpenAI.EvalItemContentItemObject

Tek bir içerik öğesi: giriş metni, çıkış metni, giriş görüntüsü veya giriş sesi.

OpenAI.EvalItemContentItemObject için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
output_text	OpenAI.EvalItemContentOutputText
input_image	OpenAI.EvalItemInputImage
input_audio	OpenAI.InputAudio
input_text	OpenAI.EvalItemContentItemObjectInputTextContent

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.EvalItemContentItemObjectType		Evet

OpenAI.EvalItemContentItemObjectInputTextContent

Modele metin girişi.

İsim	Türü	Description	Gerekli	Varsayılan
text	String	Modele metin girişi.	Evet
type	enum	Giriş öğesinin türü. Her zaman input_text. Olası değerler: input_text	Evet

OpenAI.EvalItemContentItemObjectType

Mülkiyet	Değer
Türü	String
Değerler	input_text output_text input_image input_audio

OpenAI.EvalItemContentOutputText

Modelden bir metin çıktısı.

İsim	Türü	Description	Gerekli	Varsayılan
text	String	Modelden metin çıkışı.	Evet
type	enum	Çıkış metninin türü. Her zaman output_text. Olası değerler: output_text	Evet

OpenAI.EvalItemContentText

Modele metin girişi.

Tür: dize

OpenAI.EvalItemInputImage

EvalItem içerik dizilerinde kullanılan bir görüntü giriş bloğu.

İsim	Türü	Description	Gerekli	Varsayılan
detail	String	Modele gönderilecek görüntünün ayrıntı düzeyi. high, lowveya auto. Varsayılan olarak auto değerini alır.	Hayı
image_url	String	Görüntü girişinin URL'si.	Evet
type	enum	Görüntü girişinin türü. Her zaman input_image. Olası değerler: input_image	Evet

OpenAI.EvalJsonlFileContentSource

İsim	Türü	Description	Gerekli	Varsayılan
içerik	OpenAI.EvalJsonlFileContentSourceContent dizisi	jsonl dosyasının içeriği.	Evet
type	enum	Jsonl kaynağının türü. Her zaman file_content. Olası değerler: file_content	Evet

OpenAI.EvalJsonlFileContentSourceContent

İsim	Türü	Description	Gerekli	Varsayılan
öğe	nesne		Evet
örnek	nesne		Hayı

OpenAI.EvalJsonlFileIdSource

İsim	Türü	Description	Gerekli	Varsayılan
kimlik	String	Dosyanın tanımlayıcısı.	Evet
type	enum	Jsonl kaynağının türü. Her zaman file_id. Olası değerler: file_id	Evet

OpenAI.EvalResponsesSource

Çalıştırma veri kaynağı yapılandırmasını açıklayan bir EvalResponsesSource nesnesi.

İsim	Türü	Description	Gerekli	Varsayılan
oluşturulma_tarihi_sonrası	OpenAI.integer (null atanabilir)		Hayı
önceden oluşturulmuş	OpenAI.integer (null atanabilir)		Hayı
instructions_search	dize (null atanabilir)		Hayı
metadata	object (null atanabilir)		Hayı
model	dize (null atanabilir)		Hayı
akıl yürütme çabası	OpenAI.ReasoningEffort (null atanabilir)	Akıl yürütme çabasını kısıtlar mantıp modelleri. Şu anda desteklenen değerler none, minimal, low, medium, high, ve xhigh'dir. Azaltma muhakeme çabası daha hızlı yanıtlara ve daha az belirteç kullanılmasına neden olabilir bir yanıtta mantık yürütme. - gpt-5.1 varsayılan olarak noneöğesini kullanır ve mantık yürütmez. Desteklenen gerekçe değerleri gpt-5.1none, low, medium, ve high'dir. Araç çağrıları gpt-5.1'deki tüm akıl yürütme değerleri için desteklenir. - Tüm modeller varsayılan olarak akıl yürütme eforu olmadan gpt-5.1 önce medium ve desteklemeznone. - Model gpt-5-pro varsayılan olarak akıl yürütme eforunu kullanır (ve yalnızca destekler high ). - xhigh , sonrasındaki gpt-5.1-codex-maxtüm modeller için desteklenir.	Hayı
sıcaklık	OpenAI.numeric (null atanabilir)		Hayı
araçlar	dize dizisi		Hayı
top_p	OpenAI.numeric (null atanabilir)		Hayı
type	enum	Çalıştırma veri kaynağının türü. Her zaman responses. Olası değerler: responses	Evet
users	dize dizisi		Hayı

OpenAI.EvalRunOutputItemSample

İsim	Türü	Description	Gerekli	Varsayılan
hata	OpenAI.EvalApiError	Değerlendirme API'sinden bir hata yanıtını temsil eden nesne.	Evet
bitiş_nedeni	String		Evet
girdi	EvalRunOutputItemSampleInput dizisi		Evet
max_completion_tokens	OpenAI.integer		Evet
model	String		Evet
çıktı	EvalRunOutputItemSampleOutput dizisi		Evet
seed	OpenAI.integer		Evet
sıcaklık	OpenAI.numeric		Evet
top_p	OpenAI.numeric		Evet
usage	OpenAI.EvalRunOutputItemSampleUsage		Evet

OpenAI.EvalRunOutputItemSampleUsage

İsim	Türü	Description	Gerekli	Varsayılan
cached_tokens	OpenAI.integer		Evet
completion_tokens	OpenAI.integer		Evet
prompt_tokens	OpenAI.integer		Evet
total_tokens	OpenAI.integer		Evet

OpenAI.EvalRunPerModelUsage

İsim	Türü	Description	Gerekli	Varsayılan
cached_tokens	OpenAI.integer		Evet
completion_tokens	OpenAI.integer		Evet
invocation_count	OpenAI.integer		Evet
model_name	String		Evet
prompt_tokens	OpenAI.integer		Evet
total_tokens	OpenAI.integer		Evet

OpenAI.EvalRunPerTestingCriteriaResults

İsim	Türü	Description	Gerekli	Varsayılan
başarısız	OpenAI.integer		Evet
Geçirilen	OpenAI.integer		Evet
test kriterleri	String		Evet

OpenAI.EvalRunResultCounts

İsim	Türü	Description	Gerekli	Varsayılan
hata oluştu	OpenAI.integer		Evet
başarısız	OpenAI.integer		Evet
Geçirilen	OpenAI.integer		Evet
toplam	OpenAI.integer		Evet

OpenAI.EvalStoredCompletionsSource

Bir filtre kümesini açıklayan StoredCompletionsRunDataSource yapılandırması

İsim	Türü	Description	Gerekli	Varsayılan
oluşturulma_tarihi_sonrası	OpenAI.integer (null atanabilir)		Hayı
önceden oluşturulmuş	OpenAI.integer (null atanabilir)		Hayı
limit	OpenAI.integer (null atanabilir)		Hayı
metadata	OpenAI.Metadata (null atanabilir)	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Hayı
model	dize (null atanabilir)		Hayı
type	enum	Kaynak türü. Her zaman stored_completions. Olası değerler: stored_completions	Evet

OpenAI.FileCitationBody

Bir dosyaya referans.

İsim	Türü	Description	Gerekli	Varsayılan
dosya_kimlik	String	Dosyanın kimliği.	Evet
filename	String	Belirtilen dosyanın dosya adı.	Evet
indeks	OpenAI.integer		Evet
type	enum	Dosya alıntısının türü. Her zaman file_citation. Olası değerler: file_citation	Evet

OpenAI.FilePath

Bir dosyaya giden yol.

İsim	Türü	Description	Gerekli	Varsayılan
dosya_kimlik	String	Dosyanın kimliği.	Evet
indeks	OpenAI.integer		Evet
type	enum	Dosya yolunun türü. Her zaman file_path. Olası değerler: file_path	Evet

OpenAI.FileSearchTool

Yüklenen dosyalardan ilgili içeriği arayan bir araç.

İsim	Türü	Description	Gerekli	Varsayılan
filters	OpenAI.Filters (null atanabilir)		Hayı
maks_sonuç_sayısı	OpenAI.integer		Hayı
Sıralama_seçenekleri	OpenAI.RankingOptions		Hayı
└─ hybrid_search	OpenAI.HybridSearchOptions	Hibrit arama etkinleştirildiğinde karşılıklı sıralama birleşiminin anlamsal gömütme eşleşmeleri ile seyrek anahtar kelime eşleşmelerini nasıl dengelediğini kontrol eden ağırlıklar.	Hayı
└─ sıralama yapıcı	OpenAI.RankerVersionType	Dosya araması için kullanılacak dereceleyici.	Hayı
└─ skor_eşiği	OpenAI.numeric	Dosya araması için puan eşiği, 0 ile 1 arasında bir sayı. 1'e yakın sayılar yalnızca en uygun sonuçları döndürmeye çalışır, ancak daha az sonuç döndürebilir.	Hayı
type	enum	Dosya arama aracının türü. Her zaman file_search. Olası değerler: file_search	Evet
vector_store_ids	dize dizisi	Aranacak vektör depolarının kimlikleri.	Evet

OpenAI.FileSearchToolCallResults

İsim	Türü	Description	Gerekli	Varsayılan
attributes	OpenAI.VectorStoreFileAttributes (null atanabilir)	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar dizedir en fazla 64 karakter uzunluğunda. Değerler, en yüksek değere sahip dizelerdir 512 karakter uzunluğu, booleanlar veya sayılar.	Hayı
dosya_kimlik	String		Hayı
filename	String		Hayı
Puan	Numara		Hayı
text	String		Hayı

OpenAI.Filters

Tür: OpenAI.ComparisonFilter veya OpenAI.CompoundFilter

OpenAI.FineTuneDPOHyperparameters

DPO hassas ayarlama işi için kullanılan hiper parametreler.

İsim	Türü	Description	Gerekli	Varsayılan
küme_boyutu	dize veya OpenAI.integer	Her toplu işlemdeki örnek sayısı. Daha büyük bir toplu iş boyutu, model parametrelerinin daha az sıklıkta, ancak daha düşük varyansla güncelleştirildiğini gösterir.	Hayı
beta	dize veya OpenAI.numeric	DPO yönteminin beta değeri. Daha yüksek bir beta değeri, ilke ve başvuru modeli arasındaki cezanın ağırlığını artırır.	Hayı
öğrenme oranı çarpanı	dize veya OpenAI.numeric	Öğrenme oranı için ölçeklendirme faktörü. Aşırı uydurmayı önlemek için daha düşük bir öğrenme oranı yararlı olabilir.	Hayı
n_devir	dize veya OpenAI.integer	Modelin eğitileceği epok sayısı. Dönem, eğitim veri kümesindeki bir tam döngüyü ifade eder.	Hayı

OpenAI.FineTuneDPOMethod

DPO ince ayarlama yöntemi için yapılandırma.

İsim	Türü	Description	Gerekli	Varsayılan
hiper parametreler	OpenAI.FineTuneDPOHyperparameters	DPO hassas ayarlama işi için kullanılan hiper parametreler.	Hayı

OpenAI.FineTuneMethod

İnce ayar için kullanılan yöntem.

İsim	Türü	Description	Gerekli	Varsayılan
dpo	OpenAI.FineTuneDPOMethod	DPO ince ayarlama yöntemi için yapılandırma.	Hayı
Takviye	OpenAI.FineTuneReinforcementMethod	Pekiştirici ince ayar yöntemi için yapılandırma.	Hayı
Denetimli	OpenAI.FineTuneSupervisedMethod	Denetimli ince ayar yöntemi için yapılandırma.	Hayı
type	enum	Yöntemin türü. supervised, dpoveya reinforcementşeklindedir. Olası değerler: supervised, dpo, reinforcement	Evet

OpenAI.FineTuneReinforcementHyperparameters

Pekiştirici ince ayarlama işi için kullanılan hiper parametreler.

İsim	Türü	Description	Gerekli	Varsayılan
küme_boyutu	dize veya OpenAI.integer	Her toplu işlemdeki örnek sayısı. Daha büyük bir toplu iş boyutu, model parametrelerinin daha az sıklıkta, ancak daha düşük varyansla güncelleştirildiğini gösterir.	Hayı
compute_multiplier	dize veya OpenAI.numeric	Eğitim sırasında arama alanını keşfetmek için kullanılan işlem miktarının çarpanı.	Hayı
eval_interval	dize veya OpenAI.integer	Değerlendirme çalıştırmaları arasındaki eğitim adımlarının sayısı.	Hayı
eval_samples	dize veya OpenAI.integer	Eğitim adımı başına oluşturulacak değerlendirme örneklerinin sayısı.	Hayı
öğrenme oranı çarpanı	dize veya OpenAI.numeric	Öğrenme oranı için ölçeklendirme faktörü. Aşırı uydurmayı önlemek için daha düşük bir öğrenme oranı yararlı olabilir.	Hayı
n_devir	dize veya OpenAI.integer	Modelin eğitileceği epok sayısı. Dönem, eğitim veri kümesindeki bir tam döngüyü ifade eder.	Hayı
akıl yürütme çabası	enum	Akıl yürütme çabası düzeyi. Olası değerler: default, low, medium, high	Hayı

OpenAI.FineTuneReinforcementMethod

Pekiştirici ince ayar yöntemi için yapılandırma.

İsim	Türü	Description	Gerekli	Varsayılan
Greyder	OpenAI.GraderStringCheck veya OpenAI.GraderTextSimilarity veya OpenAI.GraderPython veya OpenAI.GraderScoreModel veya OpenAI.GraderMulti	İnce ayar işi için kullanılan not veren.	Evet
hiper parametreler	OpenAI.FineTuneReinforcementHyperparameters	Pekiştirici ince ayarlama işi için kullanılan hiper parametreler.	Hayı

OpenAI.FineTuneSupervisedHyperparameters

İnce ayar işi için kullanılan hiper parametreler.

İsim	Türü	Description	Gerekli	Varsayılan
küme_boyutu	dize veya OpenAI.integer	Her toplu işlemdeki örnek sayısı. Daha büyük bir toplu iş boyutu, model parametrelerinin daha az sıklıkta, ancak daha düşük varyansla güncelleştirildiğini gösterir.	Hayı
öğrenme oranı çarpanı	dize veya OpenAI.numeric	Öğrenme oranı için ölçeklendirme faktörü. Aşırı uydurmayı önlemek için daha düşük bir öğrenme oranı yararlı olabilir.	Hayı
n_devir	dize veya OpenAI.integer	Modelin eğitileceği epok sayısı. Dönem, eğitim veri kümesindeki bir tam döngüyü ifade eder.	Hayı

OpenAI.FineTuneSupervisedMethod

Denetimli ince ayar yöntemi için yapılandırma.

İsim	Türü	Description	Gerekli	Varsayılan
hiper parametreler	OpenAI.FineTuneSupervisedHyperparameters	İnce ayar işi için kullanılan hiper parametreler.	Hayı

OpenAI.FineTuningIntegration

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	İnce ayar işi için etkinleştirilen tümleştirmenin türü Olası değerler: wandb	Evet
wandb	OpenAI.FineTuningIntegrationWandb		Evet
└─ varlık	dize (null atanabilir)		Hayı
└─ ad	dize (null atanabilir)		Hayı
└─ project	String		Evet
└─ etiketleri	dize dizisi		Hayı

OpenAI.FineTuningIntegrationWandb

İsim	Türü	Description	Gerekli	Varsayılan
varlık	dize (null atanabilir)		Hayı
name	dize (null atanabilir)		Hayı
project	String		Evet
tags	dize dizisi		Hayı

OpenAI.FineTuningJob

nesnesi, fine_tuning.job API aracılığıyla oluşturulmuş bir ince ayar işini temsil eder.

İsim	Türü	Description	Gerekli	Varsayılan
oluşturulma_tarihi	tamsayı	hassas ayarlama işinin oluşturulduğu zaman için Unix zaman damgası (saniye olarak).	Evet
hata	OpenAI.FineTuningJobError (null atanabilir)		Evet
└─ kod	String		Evet
└─ ileti	String		Evet
└─ parametre	dize (null atanabilir)		Evet
tahmini_bitiş	tamsayı		Hayı
fine_tuned_model	dize (null atanabilir)		Evet
tamamlandı	tamsayı		Evet
hiper parametreler	OpenAI.FineTuningJobHyperparameters		Evet
└─ yığın boyutu	dize veya OpenAI.integer		Hayı	otomatik
└─ öğrenme oranı çarpanı	dize veya OpenAI.numeric		Hayı
└─ n_epochs	dize veya OpenAI.integer		Hayı	otomatik
kimlik	String	API uç noktalarına başvurulabilen nesne tanımlayıcısı.	Evet
Entegrasyonlar	OpenAI.FineTuningIntegration dizisi		Hayı
metadata	OpenAI.Metadata (null atanabilir)	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Hayı
method	OpenAI.FineTuneMethod	İnce ayar için kullanılan yöntem.	Hayı
model	String	İnce ayar yapılan temel model.	Evet
nesne	enum	Her zaman "fine_tuning.job" olan nesne türü. Olası değerler: fine_tuning.job	Evet
organization_id	String	İnce ayar işinin sahibi olan kuruluş.	Evet
sonuç_dosyaları	dize dizisi	İnce ayar işi için derlenmiş sonuç dosyası kimlikleri. Sonuçları Dosyalar API'siyle alabilirsiniz.	Evet
seed	OpenAI.integer		Evet
durum	enum	, veya validating_filesolabilirqueuedrunningsucceededfailed, ince ayarlama işinin cancelledgeçerli durumu. Olası değerler: validating_files, queued, running, succeeded, , failed, cancelled	Evet
eğitilmiş_jetonlar	OpenAI.integer (null atanabilir)		Evet
eğitim_dosyası	String	Eğitim için kullanılan dosya kimliği. Eğitim verilerini Dosyalar API'siyle alabilirsiniz.	Evet
doğrulama_dosyası	dize (null atanabilir)		Evet

OpenAI.FineTuningJobCheckpoint

fine_tuning.job.checkpoint nesnesi, kullanıma hazır bir ince ayar işi için model denetim noktasını temsil eder.

İsim	Türü	Description	Gerekli	Varsayılan
oluşturulma_tarihi	tamsayı	Denetim noktasının oluşturulduğu zaman için Unix zaman damgası (saniye olarak).	Evet
ince_ayarlı_model_kontrol_noktası	String	Oluşturulan hassas denetim noktası modelinin adı.	Evet
ince_ayarlama_iş_id	String	Bu denetim noktasının oluşturulduğu ince ayar işinin adı.	Evet
kimlik	String	API uç noktalarında başvurulabilen denetim noktası tanımlayıcısı.	Evet
metrics	OpenAI.FineTuningJobCheckpointMetrics		Evet
tam doğrulama kaybı (full_valid_loss)	OpenAI.numeric		Hayı
└─ tam_geçerli_ortalama_token_doğruluğu	OpenAI.numeric		Hayı
└─ adım	OpenAI.numeric		Hayı
└─ eğitim kaybı	OpenAI.numeric		Hayı
└─ eğitim_ortalama_token_dogrulugu	OpenAI.numeric		Hayı
└─ doğrulama_kaybı	OpenAI.numeric		Hayı
└─ geçerli_ortalama_öğe_doğruluğu	OpenAI.numeric		Hayı
nesne	enum	Her zaman "fine_tuning.job.checkpoint" olan nesne türü. Olası değerler: fine_tuning.job.checkpoint	Evet
adım_numarası	OpenAI.integer		Evet

OpenAI.FineTuningJobCheckpointMetrics

İsim	Türü	Description	Gerekli	Varsayılan
full_valid_loss	OpenAI.numeric		Hayı
full_valid_mean_token_accuracy	OpenAI.numeric		Hayı
adım	OpenAI.numeric		Hayı
train_loss	OpenAI.numeric		Hayı
train_mean_token_accuracy	OpenAI.numeric		Hayı
valid_loss	OpenAI.numeric		Hayı
valid_mean_token_accuracy	OpenAI.numeric		Hayı

OpenAI.FineTuningJobError

İsim	Türü	Description	Gerekli	Varsayılan
kod	String		Evet
mesaj	String		Evet
param	dize (null atanabilir)		Evet

OpenAI.FineTuningJobEvent

İş olayı nesnesine ince ayar

İsim	Türü	Description	Gerekli	Varsayılan
oluşturulma_tarihi	tamsayı	hassas ayarlama işinin oluşturulduğu zaman için Unix zaman damgası (saniye olarak).	Evet
veriler	OpenAI.FineTuningJobEventData		Hayı
kimlik	String	Nesne tanımlayıcısı.	Evet
seviye	enum	Olayın günlük düzeyi. Olası değerler: info, warn, error	Evet
mesaj	String	Olayın iletisi.	Evet
nesne	enum	Her zaman "fine_tuning.job.event" olan nesne türü. Olası değerler: fine_tuning.job.event	Evet
type	enum	Olayın türü. Olası değerler: message, metrics	Hayı

OpenAI.FineTuningJobEventData

Tür: nesne

OpenAI.FineTuningJobHyperparameters

İsim	Türü	Description	Gerekli	Varsayılan
küme_boyutu	dize veya OpenAI.integer		Hayı
öğrenme oranı çarpanı	dize veya OpenAI.numeric		Hayı
n_devir	dize veya OpenAI.integer		Hayı

OpenAI.FunctionAndCustomToolCallOutput

OpenAI.FunctionAndCustomToolCallOutput için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
input_text	OpenAI.FunctionAndCustomToolCallOutputInputTextContent
input_image	OpenAI.FunctionAndCustomToolCallOutputInputImageContent
input_file	OpenAI.FunctionAndCustomToolCallOutputInputFileContent

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.FunctionAndCustomToolCallOutputType		Evet

OpenAI.FunctionAndCustomToolCallOutputInputFileContent

Modele bir dosya girişi.

İsim	Türü	Description	Gerekli	Varsayılan
file_data	String	Modele gönderilecek dosyanın içeriği.	Hayı
dosya_kimlik	dize (null atanabilir)		Hayı
file_url	String	Modele gönderilecek dosyanın URL'si.	Hayı
filename	String	Modele gönderilecek dosyanın adı.	Hayı
type	enum	Giriş öğesinin türü. Her zaman input_file. Olası değerler: input_file	Evet

OpenAI.FunctionAndCustomToolCallOutputInputImageContent

Modele bir görüntü girişi. image girişleri hakkında bilgi edinin.

İsim	Türü	Description	Gerekli	Varsayılan
detail	OpenAI.ImageDetail		Evet
dosya_kimlik	dize (null atanabilir)		Hayı
image_url	String		Hayı
type	enum	Giriş öğesinin türü. Her zaman input_image. Olası değerler: input_image	Evet

OpenAI.FunctionAndCustomToolCallOutputInputTextContent

Modele metin girişi.

İsim	Türü	Description	Gerekli	Varsayılan
text	String	Modele metin girişi.	Evet
type	enum	Giriş öğesinin türü. Her zaman input_text. Olası değerler: input_text	Evet

OpenAI.FunctionAndCustomToolCallOutputType

Mülkiyet	Değer
Türü	String
Değerler	input_text input_image input_file

OpenAI.FunctionCallItemStatus

Mülkiyet	Değer
Türü	String
Değerler	in_progress completed incomplete

OpenAI.FunctionObject

İsim	Türü	Description	Gerekli	Varsayılan
açıklama	String	İşlevin ne zaman ve nasıl çağrıldığını seçmek için model tarafından kullanılan işlevin ne yaptığının açıklaması.	Hayı
name	String	Çağrılacak işlevin adı. En fazla uzunluğu 64 olan a-z, A-Z, 0-9 veya alt çizgi ve kısa çizgi içermelidir.	Evet
parameters	OpenAI.FunctionParameters	İşlevlerin kabullediği, JSON Şeması nesnesi olarak tanımlanan parametreler. Örnekler için guide ve format hakkında dokümantasyon için JSON Schema reference adresine bakınız. Atlama parameters , boş parametre listesi olan bir işlevi tanımlar.	Hayı
Sıkı	boole değeri (null atanabilir)		Hayı

OpenAI.FunctionParameters

İşlevlerin kabullediği, JSON Şeması nesnesi olarak tanımlanan parametreler. Örnekler için guide ve format hakkında dokümantasyon için JSON Schema reference adresine bakınız. Atlama parameters , boş parametre listesi olan bir işlevi tanımlar.

Tür: nesne

OpenAI.FunctionShellAction

Bir kabuk komutu yürütür.

İsim	Türü	Description	Gerekli	Varsayılan
commands	dize dizisi		Evet
max_output_length	OpenAI.integer (null atanabilir)		Evet
zaman_aşımı_ms	OpenAI.integer (null atanabilir)		Evet

OpenAI.FunctionShellActionParam

Shell araç çağrısının nasıl çalıştırılacağını açıklayan komutlar ve limitler.

İsim	Türü	Description	Gerekli	Varsayılan
commands	dize dizisi	Çalıştırma ortamı için shell komutlarının çalıştırılması için emredildi.	Evet
max_output_length	OpenAI.integer (null atanabilir)		Hayı
zaman_aşımı_ms	OpenAI.integer (null atanabilir)		Hayı

OpenAI.FunctionShellCallItemStatus

Shell araç çağrıları için bildirilen durum değerleri.

Mülkiyet	Değer
Türü	String
Değerler	in_progress completed incomplete

OpenAI.FunctionShellCallOutputContent

Bir kabuk aracının içeriği, yayılan çağrı çıkışını çağırır.

İsim	Türü	Description	Gerekli	Varsayılan
Oluşturan	String	Öğeyi oluşturan aktörün tanımlayıcısı.	Hayı
sonuç	OpenAI.FunctionShellCallOutputOutcome	Bir çıkış sonucunu (çıkış koduyla) veya kabuk çağrısı çıkış öbekleri için zaman aşımı sonucunu temsil eder.	Evet
└─ türü	OpenAI.FunctionShellCallOutputOutcomeType		Evet
Stderr	String	Yakalanan standart hata çıkışı.	Evet
stdout	String	Yakalanan standart çıkış.	Evet

OpenAI.FunctionShellCallOutputContentParam

Shell aracı çağrısı çıkışının bir kısmı için stdout ve stderr yakalandı.

İsim	Türü	Description	Gerekli	Varsayılan
sonuç	OpenAI.FunctionShellCallOutputOutcomeParam	Bu shell çağrısıyla ilişkili çıkış veya zaman aşımı sonucu.	Evet
└─ türü	OpenAI.FunctionShellCallOutputOutcomeParamType		Evet
Stderr	String	Shell çağrısı için stderr çıkışı yakalandı. Kısıtlamalar: maxLength: 10485760	Evet
stdout	String	Shell çağrısı için stdout çıktısı yakalandı. Kısıtlamalar: maxLength: 10485760	Evet

OpenAI.FunctionShellCallOutputExitOutcome

Shell komutlarının tamamlandığını ve çıkış kodunu döndürdüğünü gösterir.

İsim	Türü	Description	Gerekli	Varsayılan
exit_code	OpenAI.integer		Evet
type	enum	Sonuç türü. Her zaman exit. Olası değerler: exit	Evet

OpenAI.FunctionShellCallOutputExitOutcomeParam

Shell komutlarının tamamlandığını ve çıkış kodunu döndürdüğünü gösterir.

İsim	Türü	Description	Gerekli	Varsayılan
exit_code	OpenAI.integer		Evet
type	enum	Sonuç türü. Her zaman exit. Olası değerler: exit	Evet

OpenAI.FunctionShellCallOutputOutcome

Bir çıkış sonucunu (çıkış koduyla) veya kabuk çağrısı çıkış öbekleri için zaman aşımı sonucunu temsil eder.

OpenAI.FunctionShellCallOutputOutcome için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
timeout	OpenAI.FunctionShellCallOutputTimeoutOutcome
exit	OpenAI.FunctionShellCallOutputExitOutcome

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.FunctionShellCallOutputOutcomeType		Evet

OpenAI.FunctionShellCallOutputOutcomeParam

Bu shell çağrısıyla ilişkili çıkış veya zaman aşımı sonucu.

OpenAI.FunctionShellCallOutputOutcomeParam için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
timeout	OpenAI.FunctionShellCallOutputTimeoutOutcomeParam
exit	OpenAI.FunctionShellCallOutputExitOutcomeParam

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.FunctionShellCallOutputOutcomeParamType		Evet

OpenAI.FunctionShellCallOutputOutcomeParamType

Mülkiyet	Değer
Türü	String
Değerler	timeout exit

OpenAI.FunctionShellCallOutputOutcomeType

Mülkiyet	Değer
Türü	String
Değerler	timeout exit

OpenAI.FunctionShellCallOutputTimeoutOutcome

Shell çağrısının ayarlanmış zaman sınırını aştığını gösterir.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Sonuç türü. Her zaman timeout. Olası değerler: timeout	Evet

OpenAI.FunctionShellCallOutputTimeoutOutcomeParam

Shell çağrısının ayarlanmış zaman sınırını aştığını gösterir.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Sonuç türü. Her zaman timeout. Olası değerler: timeout	Evet

OpenAI.FunctionShellToolParam

Modelin shell komutlarını çalıştırmasına olanak tanıyan bir araç.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Kabuk aracının türü. Her zaman shell. Olası değerler: shell	Evet

OpenAI.FunctionTool

Modelin çağırmayı seçebileceği kendi kodunuzda bir işlev tanımlar.

İsim	Türü	Description	Gerekli	Varsayılan
açıklama	dize (null atanabilir)		Hayı
name	String	Çağrılacak işlevin adı.	Evet
parameters	object (null atanabilir)		Evet
Sıkı	boole değeri (null atanabilir)		Evet
type	enum	İşlev aracının türü. Her zaman function. Olası değerler: function	Evet

OpenAI.GraderLabelModel

Değerlendirmedeki her öğeye etiket atamak için model kullanan bir LabelModelGrader nesnesi.

İsim	Türü	Description	Gerekli	Varsayılan
girdi	OpenAI.EvalItem dizisi		Evet
labels	dize dizisi	Değerlendirmedeki her öğeye atanacak etiketler.	Evet
model	String	Değerlendirme için kullanılacak model. Yapılandırılmış çıktıları destekleme zorunluluğu vardır.	Evet
name	String	Değerlendiricinin adı.	Evet
geçen etiketler	dize dizisi	Geçen sonucu belirten etiketler. Etiketlerin bir alt kümesi olmalıdır.	Evet
type	enum	Her zaman label_modelolan nesne türü. Olası değerler: label_model	Evet

OpenAI.GraderMulti

MultiGrader nesnesi, tek bir puan oluşturmak için birden çok not verenin çıkışını birleştirir.

İsim	Türü	Description	Gerekli	Varsayılan
calculate_output	String	Not veren sonuçlarına göre çıkışı hesaplamak için bir formül.	Evet
Greyder	OpenAI.GraderStringCheck veya OpenAI.GraderTextSimilarity veya OpenAI.GraderPython veya OpenAI.GraderScoreModel veya OpenAI.GraderLabelModel		Evet
name	String	Değerlendiricinin adı.	Evet
type	enum	Her zaman multiolan nesne türü. Olası değerler: multi	Evet

OpenAI.GraderPython

Girişte python betiği çalıştıran bir PythonGrader nesnesi.

İsim	Türü	Description	Gerekli	Varsayılan
image_tag	String	Python betiği için kullanılacak görüntü etiketi.	Hayı
name	String	Değerlendiricinin adı.	Evet
kaynak	String	Python betiğinin kaynak kodu.	Evet
type	enum	Her zaman pythonolan nesne türü. Olası değerler: python	Evet

OpenAI.GraderScoreModel

Girişe puan atamak için model kullanan scoreModelGrader nesnesi.

İsim	Türü	Description	Gerekli	Varsayılan
girdi	OpenAI.EvalItem dizisi	Not veren tarafından değerlendirilen giriş iletileri. Metin, çıkış metni, giriş görüntüsü ve giriş ses içerik bloklarını destekler ve şablon dizeleri içerebilir.	Evet
model	String	Değerlendirme için kullanılacak model.	Evet
name	String	Değerlendiricinin adı.	Evet
menzil	OpenAI.numeric dizisi	Puan aralığı. Varsayılan olarak [0, 1] değerini alır.	Hayı
Örnekleme_Parametreleri	OpenAI.EvalGraderScoreModelSamplingParams		Hayı
└─ max_completions_tokens	OpenAI.integer (null atanabilir)		Hayı
└─ akıl yürütme çabası	OpenAI.ReasoningEffort	Akıl yürütme çabasını kısıtlar mantıp modelleri. Şu anda desteklenen değerler none, minimal, low, medium, high, ve xhigh'dir. Azaltma muhakeme çabası daha hızlı yanıtlara ve daha az belirteç kullanılmasına neden olabilir bir yanıtta mantık yürütme. - gpt-5.1 varsayılan olarak noneöğesini kullanır ve mantık yürütmez. Desteklenen gerekçe değerleri gpt-5.1none, low, medium, ve high'dir. Araç çağrıları gpt-5.1'deki tüm akıl yürütme değerleri için desteklenir. - Tüm modeller varsayılan olarak akıl yürütme eforu olmadan gpt-5.1 önce medium ve desteklemeznone. - Model gpt-5-pro varsayılan olarak akıl yürütme eforunu kullanır (ve yalnızca destekler high ). - xhigh , sonrasındaki gpt-5.1-codex-maxtüm modeller için desteklenir.	Hayı
└─ tohum	OpenAI.integer (null atanabilir)		Hayı
└─ sıcaklık	OpenAI.numeric (null atanabilir)		Hayı
└─ top_p	OpenAI.numeric (null atanabilir)		Hayı	1
type	enum	Her zaman score_modelolan nesne türü. Olası değerler: score_model	Evet

OpenAI.GraderStringCheck

Belirtilen işlemi kullanarak giriş ve başvuru arasında dize karşılaştırması gerçekleştiren bir StringCheckGrader nesnesi.

İsim	Türü	Description	Gerekli	Varsayılan
girdi	String	Giriş metni. Bu, şablon dizelerini içerebilir.	Evet
name	String	Değerlendiricinin adı.	Evet
Operasyon	enum	Gerçekleştirilecek dize denetimi işlemi. eq, ne, like veya ilike. Olası değerler: eq, ne, like, ilike	Evet
referans	String	Başvuru metni. Bu, şablon dizelerini içerebilir.	Evet
type	enum	Her zaman string_checkolan nesne türü. Olası değerler: string_check	Evet

OpenAI.GraderTextSimilarity

Metinleri benzerlik ölçümlerine göre notlayan textSimilarityGrader nesnesi.

İsim	Türü	Description	Gerekli	Varsayılan
değerlendirme ölçütü	enum	Kullanılacak değerlendirme ölçümü. cosine, , fuzzy_match, bleu, gleu, meteor, rouge_1, , rouge_2, rouge_3, rouge_4, rouge_5, veya rouge_l. Olası değerler: cosine, fuzzy_match, bleu, , gleu, meteor, , rouge_1, rouge_2rouge_3, rouge_4rouge_5,rouge_l	Evet
girdi	String	Notlanan metin.	Evet
name	String	Değerlendiricinin adı.	Evet
referans	String	Değerlendirmenin yapıldığı metin.	Evet
type	enum	Not verenin türü. Olası değerler: text_similarity	Evet

OpenAI.GrammarSyntax1

Mülkiyet	Değer
Türü	String
Değerler	lark regex

OpenAI.HybridSearchOptions

İsim	Türü	Description	Gerekli	Varsayılan
embedding_weight	OpenAI.numeric		Evet
text_weight	OpenAI.numeric		Evet

OpenAI.ImageDetail

Mülkiyet	Değer
Türü	String
Değerler	low high auto

OpenAI.ImageGenTool

GPT görüntü modelleriyle görüntü üreten bir araç.

Geçerli modeller:

gpt-image-1
gpt-image-1-mini

İsim	Türü	Description	Gerekli	Varsayılan
arka plan	enum	Oluşturulan görüntünün arka plan türü. Bunlardan biri transparent opaqueveya auto. Varsayılan: auto. Olası değerler: transparent, opaque, auto	Hayı
input_fidelity	OpenAI.InputFidelity (null atanabilir)	Modelin giriş görüntülerinin stil ve özellikleriyle, özellikle yüz özellikleriyle eşleşmesi için ne kadar çaba göstereceğini kontrol edin. Bu parametre yalnızca için gpt-image-1desteklenir. için gpt-image-1-minidesteklenmiyor. high ve lowdestekler. Varsayılan olarak low değerini alır.	Hayı
girdi_görüntü_maskesi	OpenAI.ImageGenToolInputImageMask		Hayı
└─ dosya_kimliği	String		Hayı
└─ image_url (görsel URL'si)	String		Hayı
model	dize (aşağıdaki geçerli modellere bakın)		Hayı
moderation	enum	Oluşturulan görüntü için denetim düzeyi. Varsayılan: auto. Olası değerler: auto, low	Hayı
çıktı sıkıştırma	OpenAI.integer		Hayı	100
çıkış formatı	enum	Oluşturulan görüntünün çıkış biçimi. png, webp, veya bunlardan biri jpeg. Varsayılan: png. Olası değerler: png, webp, jpeg	Hayı
kısmi_görüntüler	OpenAI.integer		Hayı
nitelik	enum	Oluşturulan görüntünün kalitesi. low, , medium, high, veya auto. Varsayılan: auto. Olası değerler: low, medium, high, auto	Hayı
boyut	enum	Oluşturulan görüntünün boyutu. , , 1024x1024' lerden 1024x1536biri 1536x1024veya auto. Varsayılan: auto. Olası değerler: 1024x1024, 1024x1536, 1536x1024, auto	Hayı
type	enum	Görüntü oluşturma aracının türü. Her zaman image_generation. Olası değerler: image_generation	Evet

OpenAI.ImageGenToolInputImageMask

İsim	Türü	Description	Gerekli	Varsayılan
dosya_kimlik	String		Hayı
image_url	String		Hayı

OpenAI.IncludeEnum

Model yanıtına eklenecek ek çıktı verilerini belirtin. Şu anda desteklenen değerler şunlardır:

• web_search_call.action.sources: Web arama aracı çağrısının kaynaklarını ekleyin.
• code_interpreter_call.outputs: Kod yorumlayıcı aracı çağrı öğelerinde python kod yürütme çıktılarını içerir.
• computer_call_output.output.image_url: Bilgisayar çağrısı çıkışından görüntü URL'lerini ekleyin.
• file_search_call.results: Dosya arama aracı çağrısının arama sonuçlarını ekleyin.
• message.input_image.image_url: Giriş iletisinden görüntü URL'lerini ekleyin.
• message.output_text.logprobs: Yardımcı iletilerine logprobs ekleyin.
• reasoning.encrypted_content: Akıl yürütme öğesi çıkışlarında akıl yürütme belirteçlerinin şifrelenmiş bir sürümünü içerir. Bu, Yanıtlar API'sini durum bilgisi olmadan kullanırken (örneğin, store parametresi false olarak ayarlandığında veya bir kuruluş sıfır veri saklama programına kaydedildiğinde) akıl yürütme öğelerinin çok aşamalı konuşmalarda kullanılmasını sağlar.

Mülkiyet	Değer
Açıklama	Model yanıtına eklenecek ek çıktı verilerini belirtin. Şu anda desteklenen değerler şunlardır:

• web_search_call.action.sources: Web arama aracı çağrısının kaynaklarını ekleyin.
• code_interpreter_call.outputs: Kod yorumlayıcı aracı çağrı öğelerinde python kod yürütme çıktılarını içerir.
• computer_call_output.output.image_url: Bilgisayar çağrısı çıkışından görüntü URL'lerini ekleyin.
• file_search_call.results: Dosya arama aracı çağrısının arama sonuçlarını ekleyin.
• message.input_image.image_url: Giriş iletisinden görüntü URL'lerini ekleyin.
• message.output_text.logprobs: Yardımcı iletilerine logprobs ekleyin.
• reasoning.encrypted_content: Akıl yürütme öğesi çıkışlarında akıl yürütme belirteçlerinin şifrelenmiş bir sürümünü içerir. Bu, Yanıtlar API'sini durum bilgisi olmadan kullanırken (örneğin, store parametresi false olarak ayarlandığında veya bir kuruluş sıfır veri saklama programına kaydedildiğinde) akıl yürütme öğelerinin çok aşamalı konuşmalarda kullanılmasını sağlar. | | Tür | string | | Değerler | 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

Modele ses girişi.

İsim	Türü	Description	Gerekli	Varsayılan
input_audio	OpenAI.InputAudioInputAudio		Evet
type	enum	Giriş öğesinin türü. Her zaman input_audio. Olası değerler: input_audio	Evet

OpenAI.InputAudioInputAudio

İsim	Türü	Description	Gerekli	Varsayılan
veriler	String		Evet
format	enum	Olası değerler: mp3, wav	Evet

OpenAI.InputContent

OpenAI.InputContent için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
input_text	OpenAI.InputContentInputTextContent
input_image	OpenAI.InputContentInputImageContent
input_file	OpenAI.InputContentInputFileContent

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.InputContentType		Evet

OpenAI.InputContentInputFileContent

Modele bir dosya girişi.

İsim	Türü	Description	Gerekli	Varsayılan
file_data	String	Modele gönderilecek dosyanın içeriği.	Hayı
dosya_kimlik	dize (null atanabilir)		Hayı
file_url	String	Modele gönderilecek dosyanın URL'si.	Hayı
filename	String	Modele gönderilecek dosyanın adı.	Hayı
type	enum	Giriş öğesinin türü. Her zaman input_file. Olası değerler: input_file	Evet

OpenAI.InputContentInputImageContent

Modele bir görüntü girişi. image girişleri hakkında bilgi edinin.

İsim	Türü	Description	Gerekli	Varsayılan
detail	OpenAI.ImageDetail		Evet
dosya_kimlik	dize (null atanabilir)		Hayı
image_url	String		Hayı
type	enum	Giriş öğesinin türü. Her zaman input_image. Olası değerler: input_image	Evet

OpenAI.InputContentInputTextContent

Modele metin girişi.

İsim	Türü	Description	Gerekli	Varsayılan
text	String	Modele metin girişi.	Evet
type	enum	Giriş öğesinin türü. Her zaman input_text. Olası değerler: input_text	Evet

OpenAI.InputContentType

Mülkiyet	Değer
Türü	String
Değerler	input_text input_image input_file

OpenAI.InputFidelity

Modelin giriş görüntülerinin stil ve özellikleriyle, özellikle yüz özellikleriyle eşleşmesi için ne kadar çaba göstereceğini kontrol edin. Bu parametre yalnızca için gpt-image-1desteklenir. için gpt-image-1-minidesteklenmiyor. high ve lowdestekler. Varsayılan olarak low değerini alır.

Mülkiyet	Değer
Türü	String
Değerler	high low

OpenAI.InputFileContent

Modele bir dosya girişi.

İsim	Türü	Description	Gerekli	Varsayılan
file_data	String	Modele gönderilecek dosyanın içeriği.	Hayı
dosya_kimlik	dize (null atanabilir)		Hayı
file_url	String	Modele gönderilecek dosyanın URL'si.	Hayı
filename	String	Modele gönderilecek dosyanın adı.	Hayı
type	enum	Giriş öğesinin türü. Her zaman input_file. Olası değerler: input_file	Evet

OpenAI.InputFileContentParam

Modele bir dosya girişi.

İsim	Türü	Description	Gerekli	Varsayılan
file_data	dize (null atanabilir)		Hayı
dosya_kimlik	dize (null atanabilir)		Hayı
file_url	String		Hayı
filename	dize (null atanabilir)		Hayı
type	enum	Giriş öğesinin türü. Her zaman input_file. Olası değerler: input_file	Evet

OpenAI.InputImageContent

Modele bir görüntü girişi. image girişleri hakkında bilgi edinin.

İsim	Türü	Description	Gerekli	Varsayılan
detail	OpenAI.ImageDetail		Evet
dosya_kimlik	dize (null atanabilir)		Hayı
image_url	String		Hayı
type	enum	Giriş öğesinin türü. Her zaman input_image. Olası değerler: input_image	Evet

OpenAI.InputImageContentParamAutoParam

Modele bir görüntü girişi. image girişleri

İsim	Türü	Description	Gerekli	Varsayılan
detail	OpenAI.DetailEnum (null atanabilir)		Hayı
dosya_kimlik	dize (null atanabilir)		Hayı
image_url	String		Hayı
type	enum	Giriş öğesinin türü. Her zaman input_image. Olası değerler: input_image	Evet

OpenAI.InputItem

Model tarafından oluşturulacak yanıt için bağlamın bir bölümünü temsil eden bir öğe. Metin, görüntü ve ses girişlerinin yanı sıra önceki yardımcı yanıtları ve araç çağrısı çıkışlarını içerebilir.

OpenAI.InputItem için Ayrıştırıcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
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

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.InputItemType		Evet

OpenAI.InputItemApplyPatchToolCallItemParam

Farklı yamalar kullanarak dosya oluşturma, silme veya güncelleme talebini temsil eden bir araç çağrısı.

İsim	Türü	Description	Gerekli	Varsayılan
call_id	String	Model tarafından oluşturulan uygulama yama aracı çağrısının benzersiz kimliği. Kısıtlamalar: minLength: 1, maxLength: 64	Evet
kimlik	dize (null atanabilir)		Hayı
Operasyon	OpenAI.ApplyPatchOperationParam	apply_patch aracına sağlanan create_file, delete_file veya update_file işlemlerden biri.	Evet
└─ türü	OpenAI.ApplyPatchOperationParamType		Evet
durum	OpenAI.ApplyPatchCallStatusParam	apply_patch araç çağrıları için raporlanan durum değerleri.	Evet
type	enum	Öğenin türü. Her zaman apply_patch_call. Olası değerler: apply_patch_call	Evet

OpenAI.InputItemApplyPatchToolCallOutputItemParam

Uygulama yaması aracı çağrısıyla yayımlanan akış çıktısı.

İsim	Türü	Description	Gerekli	Varsayılan
call_id	String	Model tarafından oluşturulan uygulama yama aracı çağrısının benzersiz kimliği. Kısıtlamalar: minLength: 1, maxLength: 64	Evet
kimlik	dize (null atanabilir)		Hayı
çıktı	dize (null atanabilir)		Hayı
durum	OpenAI.ApplyPatchCallOutputStatusParam	apply_patch araç çağrısı çıktıları için raporlanan sonuç değerleri.	Evet
type	enum	Öğenin türü. Her zaman apply_patch_call_output. Olası değerler: apply_patch_call_output	Evet

OpenAI.InputItemCodeInterpreterToolCall

Kodu çalıştırmak için bir araç çağrısı.

İsim	Türü	Description	Gerekli	Varsayılan
kod	dize (null atanabilir)		Evet
container_id	String	Kodu çalıştırmak için kullanılan kapsayıcının kimliği.	Evet
kimlik	String	Kod yorumlayıcısı araç çağrısının benzersiz kimliği.	Evet
Çıktılar	OpenAI.CodeInterpreterOutputLogs veya OpenAI.CodeInterpreterOutputImage dizisi		Evet
durum	enum	Kod yorumlayıcı aracı çağrısının durumu. Geçerli değerler : in_progress, completed, incomplete, interpretingve failed. Olası değerler: in_progress, completed, incomplete, interpreting, failed	Evet
type	enum	Kod yorumlayıcı aracı çağrısının türü. Her zaman code_interpreter_call. Olası değerler: code_interpreter_call	Evet

OpenAI.InputItemCompactionSummaryItemParam

API tarafından v1/responses/compactoluşturulan bir sıkıştırma öğesi.

İsim	Türü	Description	Gerekli	Varsayılan
encrypted_content	String	Sıkıştırma özetinin şifrelenmiş içeriği. Kısıtlamalar: maxLength: 10485760	Evet
kimlik	dize (null atanabilir)		Hayı
type	enum	Öğenin türü. Her zaman compaction. Olası değerler: compaction	Evet

OpenAI.InputItemComputerCallOutputItemParam

Bir bilgisayar aracı çağrısının çıktısı.

İsim	Türü	Description	Gerekli	Varsayılan
acknowledged_safety_checks	OpenAI.ComputerCallSafetyCheckParam dizisi		Hayı
call_id	String	Çıktı üreten bilgisayar aracı çağrısının kimliği. Kısıtlamalar: minLength: 1, maxLength: 64	Evet
kimlik	dize (null atanabilir)		Hayı
çıktı	OpenAI.ComputerScreenshotImage	Bilgisayar kullanım aracıyla kullanılan bir bilgisayar ekran görüntüsü.	Evet
durum	OpenAI.FunctionCallItemStatus (null atanabilir)		Hayı
type	enum	Bilgisayar araçlarının çağrı çıktısının türü. Her zaman computer_call_output. Olası değerler: computer_call_output	Evet

OpenAI.InputItemComputerToolCall

Bilgisayar kullanım araçlarına bir araç komutu verme. Daha fazla bilgi için bilgisayar kullanım rehberi adresine bakınız.

İsim	Türü	Description	Gerekli	Varsayılan
hareket	OpenAI.ComputerAction		Evet
call_id	String	Çıkış verisi ile araç çağrısına yanıt verirken kullanılan tanımlayıcı.	Evet
kimlik	String	Bilgisayar çağrısının benzersiz tanımlayıcısı.	Evet
pending_safety_checks	OpenAI.ComputerCallSafetyCheckParam dizisi	Bilgisayar çağrısı için bekleyen güvenlik denetimleri.	Evet
durum	enum	Öğenin durumu. in_progress, completed, veya bunlardan biri incomplete. Öğeler API aracılığıyla döndürülürken doldurulur. Olası değerler: in_progress, completed, incomplete	Evet
type	enum	Bilgisayar çağrısının türü. Her zaman computer_call. Olası değerler: computer_call	Evet

OpenAI.InputItemCustomToolCall

Model tarafından oluşturulan özel bir araca çağrı.

İsim	Türü	Description	Gerekli	Varsayılan
call_id	String	Bu özel araç çağrısını bir araç çağrısı çıktısına eşlemek için kullanılan bir tanımlayıcı.	Evet
kimlik	String	OpenAI platformundaki özel araç çağrısının benzersiz kimliği.	Hayı
girdi	String	Model tarafından oluşturulan özel araç çağrısı için girdi.	Evet
name	String	Çağrılan özel aracın adı.	Evet
type	enum	Özel araç çağrısının türü. Her zaman custom_tool_call. Olası değerler: custom_tool_call	Evet

OpenAI.InputItemCustomToolCallOutput

Kodunuzdan özel bir araç çağrısının çıktısı, modele geri gönderiliyor.

İsim	Türü	Description	Gerekli	Varsayılan
call_id	String	Çağrı kimliği, bu özel araç çağrısı çıktısını özel bir araç çağrısına eşlemek için kullanılır.	Evet
kimlik	String	OpenAI platformunda çıkan özel araç çağrısının benzersiz kimliği.	Hayı
çıktı	OpenAI.FunctionAndCustomToolCallOutput dizesi veya dizisi	Kodunuz tarafından oluşturulan özel araç çağrısından çıkan çıktı. Bir dizi veya çıkış içeriği listesi olabilir.	Evet
type	enum	Özel araç çağrısı çıkışının türü. Her zaman custom_tool_call_output. Olası değerler: custom_tool_call_output	Evet

OpenAI.InputItemFileSearchToolCall

Dosya arama aracı çağrısının sonuçları. Daha fazla bilgi için dosya arama rehberi adresine bakınız.

İsim	Türü	Description	Gerekli	Varsayılan
kimlik	String	Dosya arama aracı çağrısının benzersiz kimliği.	Evet
queries	dize dizisi	Dosyaları aramak için kullanılan sorgular.	Evet
results	OpenAI.FileSearchToolCallResults dizisi		Hayı
durum	enum	Dosya arama aracı çağrısının durumu. Bunlardan biri in_progress searching, incomplete veya failed, Olası değerler: in_progress, searching, completed, incomplete, failed	Evet
type	enum	Dosya arama aracı çağrısının türü. Her zaman file_search_call. Olası değerler: file_search_call	Evet

OpenAI.InputItemFunctionCallOutputItemParam

İşlev aracı çağrısının çıktısı.

İsim	Türü	Description	Gerekli	Varsayılan
call_id	String	Model tarafından oluşturulan işlev aracı çağrısının benzersiz kimliği. Kısıtlamalar: minLength: 1, maxLength: 64	Evet
kimlik	dize (null atanabilir)		Hayı
çıktı	OpenAI.InputTextContentParam veya OpenAI.InputImageContentParamAutoParam veya OpenAI.InputFileContentParam dizesi veya dizisi	Fonksiyon aracı çağrısının metin, görüntü veya dosya çıktısı.	Evet
durum	OpenAI.FunctionCallItemStatus (null atanabilir)		Hayı
type	enum	İşlev aracının çağrı çıktısının türü. Her zaman function_call_output. Olası değerler: function_call_output	Evet

OpenAI.InputItemFunctionShellCallItemParam

Bir veya daha fazla kabuk komutunu çalıştırma talebinin temsil edilen bir araç.

İsim	Türü	Description	Gerekli	Varsayılan
hareket	OpenAI.FunctionShellActionParam	Shell araç çağrısının nasıl çalıştırılacağını açıklayan komutlar ve limitler.	Evet
└─ komutları	dize dizisi	Çalıştırma ortamı için shell komutlarının çalıştırılması için emredildi.	Evet
└─ max_output_length	OpenAI.integer (null atanabilir)		Hayı
└─ timeout_ms	OpenAI.integer (null atanabilir)		Hayı
call_id	String	Model tarafından oluşturulan shell araç çağrısının benzersiz kimliği. Kısıtlamalar: minLength: 1, maxLength: 64	Evet
kimlik	dize (null atanabilir)		Hayı
durum	OpenAI.FunctionShellCallItemStatus (null atanabilir)	Shell araç çağrıları için bildirilen durum değerleri.	Hayı
type	enum	Öğenin türü. Her zaman shell_call. Olası değerler: shell_call	Evet

OpenAI.InputItemFunctionShellCallOutputItemParam

Bir shell araç çağrısı tarafından yayımlanan akış çıktı öğeleri.

İsim	Türü	Description	Gerekli	Varsayılan
call_id	String	Model tarafından oluşturulan shell araç çağrısının benzersiz kimliği. Kısıtlamalar: minLength: 1, maxLength: 64	Evet
kimlik	dize (null atanabilir)		Hayı
max_output_length	OpenAI.integer (null atanabilir)		Hayı
çıktı	OpenAI.FunctionShellCallOutputContentParam dizisi	Stdout ve stderr çıktısının parçalarını ve bunlarla ilgili sonuçları yakalandı.	Evet
type	enum	Öğenin türü. Her zaman shell_call_output. Olası değerler: shell_call_output	Evet

OpenAI.InputItemFunctionToolCall

Bir fonksiyonu çalıştırmak için bir araç çağrısı. Daha fazla bilgi için function çağrı rehberi adresine bakınız.

İsim	Türü	Description	Gerekli	Varsayılan
arguments	String	İşleve geçirecek bağımsız değişkenlerin JSON dizesi.	Evet
call_id	String	Model tarafından oluşturulan işlev aracı çağrısının benzersiz kimliği.	Evet
kimlik	String	İşlev aracı çağrısının benzersiz kimliği.	Hayı
name	String	Çalıştırılacak işlevin adı.	Evet
durum	enum	Öğenin durumu. in_progress, completed, veya bunlardan biri incomplete. Öğeler API aracılığıyla döndürülürken doldurulur. Olası değerler: in_progress, completed, incomplete	Hayı
type	enum	İşlev aracı çağrısının türü. Her zaman function_call. Olası değerler: function_call	Evet

OpenAI.InputItemImageGenToolCall

Model tarafından yapılan bir görüntü oluşturma isteği.

İsim	Türü	Description	Gerekli	Varsayılan
kimlik	String	Görüntü oluşturma çağrısının benzersiz kimliği.	Evet
sonuç	dize (null atanabilir)		Evet
durum	enum	Görüntü oluşturma çağrısının durumu. Olası değerler: in_progress, completed, generating, failed	Evet
type	enum	Görüntü oluşturma çağrısının türü. Her zaman image_generation_call. Olası değerler: image_generation_call	Evet

OpenAI.InputItemLocalShellToolCall

Yerel kabukta komut çalıştırmak için bir araç çağrısı.

İsim	Türü	Description	Gerekli	Varsayılan
hareket	OpenAI.LocalShellExecAction	Sunucuda bir kabuk komutu yürütür.	Evet
call_id	String	Model tarafından oluşturulan yerel kabuk aracı çağrısının benzersiz kimliği.	Evet
kimlik	String	Yerel shell çağrısının benzersiz kimliği.	Evet
durum	enum	Yerel shell çağrısının durumu. Olası değerler: in_progress, completed, incomplete	Evet
type	enum	Yerel shell call'ın türü. Her zaman local_shell_call. Olası değerler: local_shell_call	Evet

OpenAI.InputItemLocalShellToolCallOutput

Yerel kabuk aracı çağrısının çıktısı.

İsim	Türü	Description	Gerekli	Varsayılan
kimlik	String	Model tarafından oluşturulan yerel kabuk aracı çağrısının benzersiz kimliği.	Evet
çıktı	String	Yerel kabuk aracı çağrısının çıkışının JSON dizesi.	Evet
durum	enum	Olası değerler: in_progress, completed, incomplete	Hayı
type	enum	Yerel kabuk aracı çağrı çıkışının türü. Her zaman local_shell_call_output. Olası değerler: local_shell_call_output	Evet

OpenAI.InputItemMcpApprovalRequest

Bir araç çağrısı işlemi için insan onayı isteği.

İsim	Türü	Description	Gerekli	Varsayılan
arguments	String	Araç için bir JSON bağımsız değişken dizesi.	Evet
kimlik	String	Onay talebinin benzersiz kimliği.	Evet
name	String	Çalıştırılacak aracın adı.	Evet
sunucu etiketi	String	İsteği yapan MCP sunucusunun etiketi.	Evet
type	enum	Öğenin türü. Her zaman mcp_approval_request. Olası değerler: mcp_approval_request	Evet

OpenAI.InputItemMcpApprovalResponse

MCP onay isteğine yanıt.

İsim	Türü	Description	Gerekli	Varsayılan
approval_request_id	String	Yanıtlanan onay isteğinin ID'si.	Evet
approve	Boolean	İsteğin onaylanıp onaylanmadı.	Evet
kimlik	dize (null atanabilir)		Hayı
sebep	dize (null atanabilir)		Hayı
type	enum	Öğenin türü. Her zaman mcp_approval_response. Olası değerler: mcp_approval_response	Evet

OpenAI.InputItemMcpListTools

MCP sunucusunda kullanılabilen araçların listesi.

İsim	Türü	Description	Gerekli	Varsayılan
hata	dize (null atanabilir)		Hayı
kimlik	String	Listenin benzersiz kimliği.	Evet
sunucu etiketi	String	MCP sunucusunun etiketi.	Evet
araçlar	OpenAI.MCPListToolsTool dizisi	Sunucuda bulunan araçlar.	Evet
type	enum	Öğenin türü. Her zaman mcp_list_tools. Olası değerler: mcp_list_tools	Evet

OpenAI.InputItemMcpToolCall

MCP sunucusundaki bir aracın çağrılması.

İsim	Türü	Description	Gerekli	Varsayılan
approval_request_id	dize (null atanabilir)		Hayı
arguments	String	Araca geçirilen bağımsız değişkenlerin JSON dizesi.	Evet
hata	dize (null atanabilir)		Hayı
kimlik	String	Araç çağrısının benzersiz kimliği.	Evet
name	String	Çalıştırılan aracın adı.	Evet
çıktı	dize (null atanabilir)		Hayı
sunucu etiketi	String	Aracı çalıştıran MCP sunucusunun etiketi.	Evet
durum	OpenAI.MCPToolCallStatus		Hayı
type	enum	Öğenin türü. Her zaman mcp_call. Olası değerler: mcp_call	Evet

OpenAI.InputItemOutputMessage

Modelden bir çıkış iletisi.

İsim	Türü	Description	Gerekli	Varsayılan
içerik	OpenAI.OutputMessageContent dizisi	Çıkış iletisinin içeriği.	Evet
kimlik	String	Çıkış iletisinin benzersiz kimliği.	Evet
role	enum	Çıkış iletisinin rolü. Her zaman assistant. Olası değerler: assistant	Evet
durum	enum	İleti girişinin durumu. in_progress, completed, veya bunlardan biri incomplete. API aracılığıyla giriş öğeleri döndürüldüğünde doldurulur. Olası değerler: in_progress, completed, incomplete	Evet
type	enum	Çıkış iletisinin türü. Her zaman message. Olası değerler: output_message	Evet

OpenAI.InputItemReasoningItem

Bir yanıt oluştururken bir akıl yürütme modeli tarafından kullanılan düşünce zincirinin açıklaması. Eğer konuşmanın sonraki turlarında bu öğeleri bağlam yönetiyorsanız ile manuel olarak konuşuyorsanız, Responses API'ye input hesabınıza dahil edin.

İsim	Türü	Description	Gerekli	Varsayılan
içerik	OpenAI.ReasoningTextContent dizisi	Metin içeriğini akıl yürütme.	Hayı
encrypted_content	dize (null atanabilir)		Hayı
kimlik	String	Akıl yürütme içeriğinin benzersiz tanımlayıcısı.	Evet
durum	enum	Öğenin durumu. in_progress, completed, veya bunlardan biri incomplete. Öğeler API aracılığıyla döndürülürken doldurulur. Olası değerler: in_progress, completed, incomplete	Hayı
summary	OpenAI.Summary dizisi	Akıl yürütme özeti içeriği.	Evet
type	enum	Nesnenin türü. Her zaman reasoning. Olası değerler: reasoning	Evet

OpenAI.InputItemType

Mülkiyet	Değer
Türü	String
Değerler	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

Bir web arama aracı çağrısının sonuçları. Daha fazla bilgi için web arama rehberi adresine bakınız.

İsim	Türü	Description	Gerekli	Varsayılan
hareket	OpenAI.WebSearchActionSearch veya OpenAI.WebSearchActionOpenPage veya OpenAI.WebSearchActionFind	Bu web arama çağrısında gerçekleştirilen belirli eylemi açıklayan bir nesne. Modelin web'i nasıl kullandığına ilişkin ayrıntıları içerir (arama, open_page, bulma).	Evet
kimlik	String	Web arama aracının benzersiz kimliği çağrı.	Evet
durum	enum	Web arama aracı çağrısının durumu. Olası değerler: in_progress, searching, completed, failed	Evet
type	enum	Web arama aracının türü. Her zaman web_search_call. Olası değerler: web_search_call	Evet

OpenAI.InputMessage

Modele, hiyerarşiyi izleyen yönergeyi belirten bir rol içeren bir ileti girişi. developer veya system rolüyle verilen yönergeler, user rolüyle verilen yönergelerden önceliklidir.

İsim	Türü	Description	Gerekli	Varsayılan
içerik	OpenAI.InputMessageContentList	Modelde farklı içerik içeren bir veya birden çok giriş öğesinin listesi types.	Evet
role	enum	İleti girişinin rolü. user, systemveya developer. Olası değerler: user, system, developer	Evet
durum	enum	Öğenin durumu. in_progress, completed, veya bunlardan biri incomplete. Öğeler API aracılığıyla döndürülürken doldurulur. Olası değerler: in_progress, completed, incomplete	Hayı
type	enum	İleti girişinin türü. Her zaman messageolarak ayarlayın. Olası değerler: message	Evet

OpenAI.InputMessageContentList

Modelde farklı içerik türleri içeren bir veya birden çok giriş öğesinin listesi.

Dizisi: OpenAI.InputContent

OpenAI.InputMessageResource

İsim	Türü	Description	Gerekli	Varsayılan
içerik	OpenAI.InputMessageContentList	Modelde farklı içerik içeren bir veya birden çok giriş öğesinin listesi types.	Evet
kimlik	String	İleti girişinin benzersiz kimliği.	Evet
role	enum	İleti girişinin rolü. user, systemveya developer. Olası değerler: user, system, developer	Evet
durum	enum	Öğenin durumu. in_progress, completed, veya bunlardan biri incomplete. Öğeler API aracılığıyla döndürülürken doldurulur. Olası değerler: in_progress, completed, incomplete	Hayı
type	enum	İleti girişinin türü. Her zaman messageolarak ayarlayın. Olası değerler: message	Evet

OpenAI.InputParam

Yanıt oluşturmak için kullanılan modele metin, görüntü veya dosya girişleri. Daha fazla bilgi edinin:

• Metin girişleri ve çıktıları
• Görüntü girişleri
• Dosya girişleri
• Konuşma durumu
• fonksiyon çağrısı

Tür: OpenAI.InputItem dizesi veya dizisi

Yanıt oluşturmak için kullanılan modele metin, görüntü veya dosya girişleri. Daha fazla bilgi edinin:

• Metin girişleri ve çıktıları
• Görüntü girişleri
• Dosya girişleri
• Konuşma durumu
• fonksiyon çağrısı

OpenAI.InputTextContent

Modele metin girişi.

İsim	Türü	Description	Gerekli	Varsayılan
text	String	Modele metin girişi.	Evet
type	enum	Giriş öğesinin türü. Her zaman input_text. Olası değerler: input_text	Evet

OpenAI.InputTextContentParam

Modele metin girişi.

İsim	Türü	Description	Gerekli	Varsayılan
text	String	Modele metin girişi. Kısıtlamalar: maxLength: 10485760	Evet
type	enum	Giriş öğesinin türü. Her zaman input_text. Olası değerler: input_text	Evet

OpenAI.Item

Yanıt oluşturmak için kullanılan içerik öğesi.

OpenAI.Item için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
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

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.ItemType		Evet

OpenAI.ItemApplyPatchToolCallItemParam

Farklı yamalar kullanarak dosya oluşturma, silme veya güncelleme talebini temsil eden bir araç çağrısı.

İsim	Türü	Description	Gerekli	Varsayılan
call_id	String	Model tarafından oluşturulan uygulama yama aracı çağrısının benzersiz kimliği. Kısıtlamalar: minLength: 1, maxLength: 64	Evet
kimlik	dize (null atanabilir)		Hayı
Operasyon	OpenAI.ApplyPatchOperationParam	apply_patch aracına sağlanan create_file, delete_file veya update_file işlemlerden biri.	Evet
└─ türü	OpenAI.ApplyPatchOperationParamType		Evet
durum	OpenAI.ApplyPatchCallStatusParam	apply_patch araç çağrıları için raporlanan durum değerleri.	Evet
type	enum	Öğenin türü. Her zaman apply_patch_call. Olası değerler: apply_patch_call	Evet

OpenAI.ItemApplyPatchToolCallOutputItemParam

Uygulama yaması aracı çağrısıyla yayımlanan akış çıktısı.

İsim	Türü	Description	Gerekli	Varsayılan
call_id	String	Model tarafından oluşturulan uygulama yama aracı çağrısının benzersiz kimliği. Kısıtlamalar: minLength: 1, maxLength: 64	Evet
kimlik	dize (null atanabilir)		Hayı
çıktı	dize (null atanabilir)		Hayı
durum	OpenAI.ApplyPatchCallOutputStatusParam	apply_patch araç çağrısı çıktıları için raporlanan sonuç değerleri.	Evet
type	enum	Öğenin türü. Her zaman apply_patch_call_output. Olası değerler: apply_patch_call_output	Evet

OpenAI.ItemCodeInterpreterToolCall

Kodu çalıştırmak için bir araç çağrısı.

İsim	Türü	Description	Gerekli	Varsayılan
kod	dize (null atanabilir)		Evet
container_id	String	Kodu çalıştırmak için kullanılan kapsayıcının kimliği.	Evet
kimlik	String	Kod yorumlayıcısı araç çağrısının benzersiz kimliği.	Evet
Çıktılar	OpenAI.CodeInterpreterOutputLogs veya OpenAI.CodeInterpreterOutputImage dizisi		Evet
durum	enum	Kod yorumlayıcı aracı çağrısının durumu. Geçerli değerler : in_progress, completed, incomplete, interpretingve failed. Olası değerler: in_progress, completed, incomplete, interpreting, failed	Evet
type	enum	Kod yorumlayıcı aracı çağrısının türü. Her zaman code_interpreter_call. Olası değerler: code_interpreter_call	Evet

OpenAI.ItemCompactionSummaryItemParam

API tarafından v1/responses/compactoluşturulan bir sıkıştırma öğesi.

İsim	Türü	Description	Gerekli	Varsayılan
encrypted_content	String	Sıkıştırma özetinin şifrelenmiş içeriği. Kısıtlamalar: maxLength: 10485760	Evet
kimlik	dize (null atanabilir)		Hayı
type	enum	Öğenin türü. Her zaman compaction. Olası değerler: compaction	Evet

OpenAI.ItemComputerCallOutputItemParam

Bir bilgisayar aracı çağrısının çıktısı.

İsim	Türü	Description	Gerekli	Varsayılan
acknowledged_safety_checks	OpenAI.ComputerCallSafetyCheckParam dizisi		Hayı
call_id	String	Çıktı üreten bilgisayar aracı çağrısının kimliği. Kısıtlamalar: minLength: 1, maxLength: 64	Evet
kimlik	dize (null atanabilir)		Hayı
çıktı	OpenAI.ComputerScreenshotImage	Bilgisayar kullanım aracıyla kullanılan bir bilgisayar ekran görüntüsü.	Evet
durum	OpenAI.FunctionCallItemStatus (null atanabilir)		Hayı
type	enum	Bilgisayar araçlarının çağrı çıktısının türü. Her zaman computer_call_output. Olası değerler: computer_call_output	Evet

OpenAI.ItemComputerToolCall

Bilgisayar kullanım araçlarına bir araç komutu verme. Daha fazla bilgi için bilgisayar kullanım rehberi adresine bakınız.

İsim	Türü	Description	Gerekli	Varsayılan
hareket	OpenAI.ComputerAction		Evet
call_id	String	Çıkış verisi ile araç çağrısına yanıt verirken kullanılan tanımlayıcı.	Evet
kimlik	String	Bilgisayar çağrısının benzersiz tanımlayıcısı.	Evet
pending_safety_checks	OpenAI.ComputerCallSafetyCheckParam dizisi	Bilgisayar çağrısı için bekleyen güvenlik denetimleri.	Evet
durum	enum	Öğenin durumu. in_progress, completed, veya bunlardan biri incomplete. Öğeler API aracılığıyla döndürülürken doldurulur. Olası değerler: in_progress, completed, incomplete	Evet
type	enum	Bilgisayar çağrısının türü. Her zaman computer_call. Olası değerler: computer_call	Evet

OpenAI.ItemCustomToolCall

Model tarafından oluşturulan özel bir araca çağrı.

İsim	Türü	Description	Gerekli	Varsayılan
call_id	String	Bu özel araç çağrısını bir araç çağrısı çıktısına eşlemek için kullanılan bir tanımlayıcı.	Evet
kimlik	String	OpenAI platformundaki özel araç çağrısının benzersiz kimliği.	Hayı
girdi	String	Model tarafından oluşturulan özel araç çağrısı için girdi.	Evet
name	String	Çağrılan özel aracın adı.	Evet
type	enum	Özel araç çağrısının türü. Her zaman custom_tool_call. Olası değerler: custom_tool_call	Evet

OpenAI.ItemCustomToolCallOutput

Kodunuzdan özel bir araç çağrısının çıktısı, modele geri gönderiliyor.

İsim	Türü	Description	Gerekli	Varsayılan
call_id	String	Çağrı kimliği, bu özel araç çağrısı çıktısını özel bir araç çağrısına eşlemek için kullanılır.	Evet
kimlik	String	OpenAI platformunda çıkan özel araç çağrısının benzersiz kimliği.	Hayı
çıktı	OpenAI.FunctionAndCustomToolCallOutput dizesi veya dizisi	Kodunuz tarafından oluşturulan özel araç çağrısından çıkan çıktı. Bir dizi veya çıkış içeriği listesi olabilir.	Evet
type	enum	Özel araç çağrısı çıkışının türü. Her zaman custom_tool_call_output. Olası değerler: custom_tool_call_output	Evet

OpenAI.ItemFileSearchToolCall

Dosya arama aracı çağrısının sonuçları. Daha fazla bilgi için dosya arama rehberi adresine bakınız.

İsim	Türü	Description	Gerekli	Varsayılan
kimlik	String	Dosya arama aracı çağrısının benzersiz kimliği.	Evet
queries	dize dizisi	Dosyaları aramak için kullanılan sorgular.	Evet
results	OpenAI.FileSearchToolCallResults dizisi		Hayı
durum	enum	Dosya arama aracı çağrısının durumu. Bunlardan biri in_progress searching, incomplete veya failed, Olası değerler: in_progress, searching, completed, incomplete, failed	Evet
type	enum	Dosya arama aracı çağrısının türü. Her zaman file_search_call. Olası değerler: file_search_call	Evet

OpenAI.ItemFunctionCallOutputItemParam

İşlev aracı çağrısının çıktısı.

İsim	Türü	Description	Gerekli	Varsayılan
call_id	String	Model tarafından oluşturulan işlev aracı çağrısının benzersiz kimliği. Kısıtlamalar: minLength: 1, maxLength: 64	Evet
kimlik	dize (null atanabilir)		Hayı
çıktı	OpenAI.InputTextContentParam veya OpenAI.InputImageContentParamAutoParam veya OpenAI.InputFileContentParam dizesi veya dizisi	Fonksiyon aracı çağrısının metin, görüntü veya dosya çıktısı.	Evet
durum	OpenAI.FunctionCallItemStatus (null atanabilir)		Hayı
type	enum	İşlev aracının çağrı çıktısının türü. Her zaman function_call_output. Olası değerler: function_call_output	Evet

OpenAI.ItemFunctionShellCallItemParam

Bir veya daha fazla kabuk komutunu çalıştırma talebinin temsil edilen bir araç.

İsim	Türü	Description	Gerekli	Varsayılan
hareket	OpenAI.FunctionShellActionParam	Shell araç çağrısının nasıl çalıştırılacağını açıklayan komutlar ve limitler.	Evet
└─ komutları	dize dizisi	Çalıştırma ortamı için shell komutlarının çalıştırılması için emredildi.	Evet
└─ max_output_length	OpenAI.integer (null atanabilir)		Hayı
└─ timeout_ms	OpenAI.integer (null atanabilir)		Hayı
call_id	String	Model tarafından oluşturulan shell araç çağrısının benzersiz kimliği. Kısıtlamalar: minLength: 1, maxLength: 64	Evet
kimlik	dize (null atanabilir)		Hayı
durum	OpenAI.FunctionShellCallItemStatus (null atanabilir)	Shell araç çağrıları için bildirilen durum değerleri.	Hayı
type	enum	Öğenin türü. Her zaman shell_call. Olası değerler: shell_call	Evet

OpenAI.ItemFunctionShellCallOutputItemParam

Bir shell araç çağrısı tarafından yayımlanan akış çıktı öğeleri.

İsim	Türü	Description	Gerekli	Varsayılan
call_id	String	Model tarafından oluşturulan shell araç çağrısının benzersiz kimliği. Kısıtlamalar: minLength: 1, maxLength: 64	Evet
kimlik	dize (null atanabilir)		Hayı
max_output_length	OpenAI.integer (null atanabilir)		Hayı
çıktı	OpenAI.FunctionShellCallOutputContentParam dizisi	Stdout ve stderr çıktısının parçalarını ve bunlarla ilgili sonuçları yakalandı.	Evet
type	enum	Öğenin türü. Her zaman shell_call_output. Olası değerler: shell_call_output	Evet

OpenAI.ItemFunctionToolCall

Bir fonksiyonu çalıştırmak için bir araç çağrısı. Daha fazla bilgi için function çağrı rehberi adresine bakınız.

İsim	Türü	Description	Gerekli	Varsayılan
arguments	String	İşleve geçirecek bağımsız değişkenlerin JSON dizesi.	Evet
call_id	String	Model tarafından oluşturulan işlev aracı çağrısının benzersiz kimliği.	Evet
kimlik	String	İşlev aracı çağrısının benzersiz kimliği.	Hayı
name	String	Çalıştırılacak işlevin adı.	Evet
durum	enum	Öğenin durumu. in_progress, completed, veya bunlardan biri incomplete. Öğeler API aracılığıyla döndürülürken doldurulur. Olası değerler: in_progress, completed, incomplete	Hayı
type	enum	İşlev aracı çağrısının türü. Her zaman function_call. Olası değerler: function_call	Evet

OpenAI.ItemImageGenToolCall

Model tarafından yapılan bir görüntü oluşturma isteği.

İsim	Türü	Description	Gerekli	Varsayılan
kimlik	String	Görüntü oluşturma çağrısının benzersiz kimliği.	Evet
sonuç	dize (null atanabilir)		Evet
durum	enum	Görüntü oluşturma çağrısının durumu. Olası değerler: in_progress, completed, generating, failed	Evet
type	enum	Görüntü oluşturma çağrısının türü. Her zaman image_generation_call. Olası değerler: image_generation_call	Evet

OpenAI.ItemLocalShellToolCall

Yerel kabukta komut çalıştırmak için bir araç çağrısı.

İsim	Türü	Description	Gerekli	Varsayılan
hareket	OpenAI.LocalShellExecAction	Sunucuda bir kabuk komutu yürütür.	Evet
call_id	String	Model tarafından oluşturulan yerel kabuk aracı çağrısının benzersiz kimliği.	Evet
kimlik	String	Yerel shell çağrısının benzersiz kimliği.	Evet
durum	enum	Yerel shell çağrısının durumu. Olası değerler: in_progress, completed, incomplete	Evet
type	enum	Yerel shell call'ın türü. Her zaman local_shell_call. Olası değerler: local_shell_call	Evet

OpenAI.ItemLocalShellToolCallOutput

Yerel kabuk aracı çağrısının çıktısı.

İsim	Türü	Description	Gerekli	Varsayılan
kimlik	String	Model tarafından oluşturulan yerel kabuk aracı çağrısının benzersiz kimliği.	Evet
çıktı	String	Yerel kabuk aracı çağrısının çıkışının JSON dizesi.	Evet
durum	enum	Olası değerler: in_progress, completed, incomplete	Hayı
type	enum	Yerel kabuk aracı çağrı çıkışının türü. Her zaman local_shell_call_output. Olası değerler: local_shell_call_output	Evet

OpenAI.ItemMcpApprovalRequest

Bir araç çağrısı işlemi için insan onayı isteği.

İsim	Türü	Description	Gerekli	Varsayılan
arguments	String	Araç için bir JSON bağımsız değişken dizesi.	Evet
kimlik	String	Onay talebinin benzersiz kimliği.	Evet
name	String	Çalıştırılacak aracın adı.	Evet
sunucu etiketi	String	İsteği yapan MCP sunucusunun etiketi.	Evet
type	enum	Öğenin türü. Her zaman mcp_approval_request. Olası değerler: mcp_approval_request	Evet

OpenAI.ItemMcpApprovalResponse

MCP onay isteğine yanıt.

İsim	Türü	Description	Gerekli	Varsayılan
approval_request_id	String	Yanıtlanan onay isteğinin ID'si.	Evet
approve	Boolean	İsteğin onaylanıp onaylanmadı.	Evet
kimlik	dize (null atanabilir)		Hayı
sebep	dize (null atanabilir)		Hayı
type	enum	Öğenin türü. Her zaman mcp_approval_response. Olası değerler: mcp_approval_response	Evet

OpenAI.ItemMcpListTools

MCP sunucusunda kullanılabilen araçların listesi.

İsim	Türü	Description	Gerekli	Varsayılan
hata	dize (null atanabilir)		Hayı
kimlik	String	Listenin benzersiz kimliği.	Evet
sunucu etiketi	String	MCP sunucusunun etiketi.	Evet
araçlar	OpenAI.MCPListToolsTool dizisi	Sunucuda bulunan araçlar.	Evet
type	enum	Öğenin türü. Her zaman mcp_list_tools. Olası değerler: mcp_list_tools	Evet

OpenAI.ItemMcpToolCall

MCP sunucusundaki bir aracın çağrılması.

İsim	Türü	Description	Gerekli	Varsayılan
approval_request_id	dize (null atanabilir)		Hayı
arguments	String	Araca geçirilen bağımsız değişkenlerin JSON dizesi.	Evet
hata	dize (null atanabilir)		Hayı
kimlik	String	Araç çağrısının benzersiz kimliği.	Evet
name	String	Çalıştırılan aracın adı.	Evet
çıktı	dize (null atanabilir)		Hayı
sunucu etiketi	String	Aracı çalıştıran MCP sunucusunun etiketi.	Evet
durum	OpenAI.MCPToolCallStatus		Hayı
type	enum	Öğenin türü. Her zaman mcp_call. Olası değerler: mcp_call	Evet

OpenAI.ItemOutputMessage

Modelden bir çıkış iletisi.

İsim	Türü	Description	Gerekli	Varsayılan
içerik	OpenAI.OutputMessageContent dizisi	Çıkış iletisinin içeriği.	Evet
kimlik	String	Çıkış iletisinin benzersiz kimliği.	Evet
role	enum	Çıkış iletisinin rolü. Her zaman assistant. Olası değerler: assistant	Evet
durum	enum	İleti girişinin durumu. in_progress, completed, veya bunlardan biri incomplete. API aracılığıyla giriş öğeleri döndürüldüğünde doldurulur. Olası değerler: in_progress, completed, incomplete	Evet
type	enum	Çıkış iletisinin türü. Her zaman message. Olası değerler: output_message	Evet

OpenAI.ItemReasoningItem

Bir yanıt oluştururken bir akıl yürütme modeli tarafından kullanılan düşünce zincirinin açıklaması. Eğer konuşmanın sonraki turlarında bu öğeleri bağlam yönetiyorsanız ile manuel olarak konuşuyorsanız, Responses API'ye input hesabınıza dahil edin.

İsim	Türü	Description	Gerekli	Varsayılan
içerik	OpenAI.ReasoningTextContent dizisi	Metin içeriğini akıl yürütme.	Hayı
encrypted_content	dize (null atanabilir)		Hayı
kimlik	String	Akıl yürütme içeriğinin benzersiz tanımlayıcısı.	Evet
durum	enum	Öğenin durumu. in_progress, completed, veya bunlardan biri incomplete. Öğeler API aracılığıyla döndürülürken doldurulur. Olası değerler: in_progress, completed, incomplete	Hayı
summary	OpenAI.Summary dizisi	Akıl yürütme özeti içeriği.	Evet
type	enum	Nesnenin türü. Her zaman reasoning. Olası değerler: reasoning	Evet

OpenAI.ItemReferenceParam

Başvurulacak bir öğenin iç tanımlayıcısı.

İsim	Türü	Description	Gerekli	Varsayılan
kimlik	String	Başvurulacak öğenin kimliği.	Evet
type	enum	Başvurulacak öğenin türü. Her zaman item_reference. Olası değerler: item_reference	Evet

OpenAI.ItemResource

Yanıt oluşturmak için kullanılan içerik öğesi.

OpenAI.ItemResource için Ayrıştırıcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
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

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.ItemResourceType		Evet

OpenAI.ItemResourceApplyPatchToolCall

Dosya oluşturarak, silerek veya güncelleştirerek dosya farklarını uygulayan bir araç çağrısı.

İsim	Türü	Description	Gerekli	Varsayılan
call_id	String	Model tarafından oluşturulan uygulama yama aracı çağrısının benzersiz kimliği.	Evet
Oluşturan	String	Bu araç çağrısını oluşturan varlığın kimliği.	Hayı
kimlik	String	Düzeltme eki uygulama aracı çağrısının benzersiz kimliği. Bu öğe, API aracılığıyla iade edildiğinde doldurulur.	Evet
Operasyon	OpenAI.ApplyPatchFileOperation	apply_patch aracılığıyla uygulanan create_file, delete_file veya update_file işlemlerinden biri.	Evet
└─ türü	OpenAI.ApplyPatchFileOperationType		Evet
durum	OpenAI.ApplyPatchCallStatus		Evet
type	enum	Öğenin türü. Her zaman apply_patch_call. Olası değerler: apply_patch_call	Evet

OpenAI.ItemResourceApplyPatchToolCallOutput

Bir düzeltme eki uygulama aracı çağrısı tarafından yayılan çıkış.

İsim	Türü	Description	Gerekli	Varsayılan
call_id	String	Model tarafından oluşturulan uygulama yama aracı çağrısının benzersiz kimliği.	Evet
Oluşturan	String	Bu aracı oluşturan varlığın kimliği çağrı çıktısı.	Hayı
kimlik	String	Düzeltme eki uygulama aracı çağrı çıkışının benzersiz kimliği. Bu öğe, API aracılığıyla iade edildiğinde doldurulur.	Evet
çıktı	dize (null atanabilir)		Hayı
durum	OpenAI.ApplyPatchCallOutputStatus		Evet
type	enum	Öğenin türü. Her zaman apply_patch_call_output. Olası değerler: apply_patch_call_output	Evet

OpenAI.ItemResourceCodeInterpreterToolCall

Kodu çalıştırmak için bir araç çağrısı.

İsim	Türü	Description	Gerekli	Varsayılan
kod	dize (null atanabilir)		Evet
container_id	String	Kodu çalıştırmak için kullanılan kapsayıcının kimliği.	Evet
kimlik	String	Kod yorumlayıcısı araç çağrısının benzersiz kimliği.	Evet
Çıktılar	OpenAI.CodeInterpreterOutputLogs veya OpenAI.CodeInterpreterOutputImage dizisi		Evet
durum	enum	Kod yorumlayıcı aracı çağrısının durumu. Geçerli değerler : in_progress, completed, incomplete, interpretingve failed. Olası değerler: in_progress, completed, incomplete, interpreting, failed	Evet
type	enum	Kod yorumlayıcı aracı çağrısının türü. Her zaman code_interpreter_call. Olası değerler: code_interpreter_call	Evet

OpenAI.ItemResourceComputerToolCall

Bilgisayar kullanım araçlarına bir araç komutu verme. Daha fazla bilgi için bilgisayar kullanım rehberi adresine bakınız.

İsim	Türü	Description	Gerekli	Varsayılan
hareket	OpenAI.ComputerAction		Evet
call_id	String	Çıkış verisi ile araç çağrısına yanıt verirken kullanılan tanımlayıcı.	Evet
kimlik	String	Bilgisayar çağrısının benzersiz tanımlayıcısı.	Evet
pending_safety_checks	OpenAI.ComputerCallSafetyCheckParam dizisi	Bilgisayar çağrısı için bekleyen güvenlik denetimleri.	Evet
durum	enum	Öğenin durumu. in_progress, completed, veya bunlardan biri incomplete. Öğeler API aracılığıyla döndürülürken doldurulur. Olası değerler: in_progress, completed, incomplete	Evet
type	enum	Bilgisayar çağrısının türü. Her zaman computer_call. Olası değerler: computer_call	Evet

OpenAI.ItemResourceComputerToolCallOutputResource

İsim	Türü	Description	Gerekli	Varsayılan
acknowledged_safety_checks	OpenAI.ComputerCallSafetyCheckParam dizisi	API tarafından bildirilen ve kabul edilen güvenlik kontrolleri geliştirici.	Hayı
call_id	String	Çıktı üreten bilgisayar aracı çağrısının kimliği.	Evet
kimlik	String	Bilgisayar aracı çağrısı çıkış kimliği.	Hayı
çıktı	OpenAI.ComputerScreenshotImage	Bilgisayar kullanım aracıyla kullanılan bir bilgisayar ekran görüntüsü.	Evet
durum	enum	İleti girişinin durumu. in_progress, completed, veya bunlardan biri incomplete. API aracılığıyla giriş öğeleri döndürüldüğünde doldurulur. Olası değerler: in_progress, completed, incomplete	Hayı
type	enum	Bilgisayar araçlarının çağrı çıktısının türü. Her zaman computer_call_output. Olası değerler: computer_call_output	Evet

OpenAI.ItemResourceFileSearchToolCall

Dosya arama aracı çağrısının sonuçları. Daha fazla bilgi için dosya arama rehberi adresine bakınız.

İsim	Türü	Description	Gerekli	Varsayılan
kimlik	String	Dosya arama aracı çağrısının benzersiz kimliği.	Evet
queries	dize dizisi	Dosyaları aramak için kullanılan sorgular.	Evet
results	OpenAI.FileSearchToolCallResults dizisi		Hayı
durum	enum	Dosya arama aracı çağrısının durumu. Bunlardan biri in_progress searching, incomplete veya failed, Olası değerler: in_progress, searching, completed, incomplete, failed	Evet
type	enum	Dosya arama aracı çağrısının türü. Her zaman file_search_call. Olası değerler: file_search_call	Evet

OpenAI.ItemResourceFunctionShellCall

Yönetilen bir ortamda bir veya daha fazla kabuk komutu yürüten bir araç çağrısı.

İsim	Türü	Description	Gerekli	Varsayılan
hareket	OpenAI.FunctionShellAction	Bir kabuk komutu yürütür.	Evet
└─ komutları	dize dizisi		Evet
└─ max_output_length	OpenAI.integer (null atanabilir)		Evet
└─ timeout_ms	OpenAI.integer (null atanabilir)		Evet
call_id	String	Model tarafından oluşturulan shell araç çağrısının benzersiz kimliği.	Evet
Oluşturan	String	Bu araç çağrısını oluşturan varlığın kimliği.	Hayı
kimlik	String	Kabuk aracı çağrısının benzersiz kimliği. Bu öğe, API aracılığıyla iade edildiğinde doldurulur.	Evet
durum	OpenAI.LocalShellCallStatus		Evet
type	enum	Öğenin türü. Her zaman shell_call. Olası değerler: shell_call	Evet

OpenAI.ItemResourceFunctionShellCallOutput

Yayılan bir kabuk aracı çağrısının çıktısı.

İsim	Türü	Description	Gerekli	Varsayılan
call_id	String	Model tarafından oluşturulan shell araç çağrısının benzersiz kimliği.	Evet
Oluşturan	String	Öğeyi oluşturan aktörün tanımlayıcısı.	Hayı
kimlik	String	Kabuk çağrısı çıkışının benzersiz kimliği. Bu öğe, API aracılığıyla iade edildiğinde doldurulur.	Evet
max_output_length	OpenAI.integer (null atanabilir)		Evet
çıktı	OpenAI.FunctionShellCallOutputContent dizisi	Kabuk çağrısı çıkış içeriği dizisi	Evet
type	enum	Kabuk çağrısı çıkışının türü. Her zaman shell_call_output. Olası değerler: shell_call_output	Evet

OpenAI.ItemResourceFunctionToolCallOutputResource

İsim	Türü	Description	Gerekli	Varsayılan
call_id	String	Model tarafından oluşturulan işlev aracı çağrısının benzersiz kimliği.	Evet
kimlik	String	İşlev aracının çağrı çıkışının benzersiz kimliği. Bu öğe doldurulduğunda API aracılığıyla döndürülür.	Hayı
çıktı	OpenAI.FunctionAndCustomToolCallOutput dizesi veya dizisi	Kodunuz tarafından oluşturulan işlev çağrısının çıktısı. Bir dizi veya çıkış içeriği listesi olabilir.	Evet
durum	enum	Öğenin durumu. in_progress, completed, veya bunlardan biri incomplete. Öğeler API aracılığıyla döndürülürken doldurulur. Olası değerler: in_progress, completed, incomplete	Hayı
type	enum	İşlev aracının çağrı çıktısının türü. Her zaman function_call_output. Olası değerler: function_call_output	Evet

OpenAI.ItemResourceFunctionToolCallResource

İsim	Türü	Description	Gerekli	Varsayılan
arguments	String	İşleve geçirecek bağımsız değişkenlerin JSON dizesi.	Evet
call_id	String	Model tarafından oluşturulan işlev aracı çağrısının benzersiz kimliği.	Evet
kimlik	String	İşlev aracı çağrısının benzersiz kimliği.	Hayı
name	String	Çalıştırılacak işlevin adı.	Evet
durum	enum	Öğenin durumu. in_progress, completed, veya bunlardan biri incomplete. Öğeler API aracılığıyla döndürülürken doldurulur. Olası değerler: in_progress, completed, incomplete	Hayı
type	enum	İşlev aracı çağrısının türü. Her zaman function_call. Olası değerler: function_call	Evet

OpenAI.ItemResourceImageGenToolCall

Model tarafından yapılan bir görüntü oluşturma isteği.

İsim	Türü	Description	Gerekli	Varsayılan
kimlik	String	Görüntü oluşturma çağrısının benzersiz kimliği.	Evet
sonuç	dize (null atanabilir)		Evet
durum	enum	Görüntü oluşturma çağrısının durumu. Olası değerler: in_progress, completed, generating, failed	Evet
type	enum	Görüntü oluşturma çağrısının türü. Her zaman image_generation_call. Olası değerler: image_generation_call	Evet

OpenAI.ItemResourceLocalShellToolCall

Yerel kabukta komut çalıştırmak için bir araç çağrısı.

İsim	Türü	Description	Gerekli	Varsayılan
hareket	OpenAI.LocalShellExecAction	Sunucuda bir kabuk komutu yürütür.	Evet
call_id	String	Model tarafından oluşturulan yerel kabuk aracı çağrısının benzersiz kimliği.	Evet
kimlik	String	Yerel shell çağrısının benzersiz kimliği.	Evet
durum	enum	Yerel shell çağrısının durumu. Olası değerler: in_progress, completed, incomplete	Evet
type	enum	Yerel shell call'ın türü. Her zaman local_shell_call. Olası değerler: local_shell_call	Evet

OpenAI.ItemResourceLocalShellToolCallOutput

Yerel kabuk aracı çağrısının çıktısı.

İsim	Türü	Description	Gerekli	Varsayılan
kimlik	String	Model tarafından oluşturulan yerel kabuk aracı çağrısının benzersiz kimliği.	Evet
çıktı	String	Yerel kabuk aracı çağrısının çıkışının JSON dizesi.	Evet
durum	enum	Olası değerler: in_progress, completed, incomplete	Hayı
type	enum	Yerel kabuk aracı çağrı çıkışının türü. Her zaman local_shell_call_output. Olası değerler: local_shell_call_output	Evet

OpenAI.ItemResourceMcpApprovalRequest

Bir araç çağrısı işlemi için insan onayı isteği.

İsim	Türü	Description	Gerekli	Varsayılan
arguments	String	Araç için bir JSON bağımsız değişken dizesi.	Evet
kimlik	String	Onay talebinin benzersiz kimliği.	Evet
name	String	Çalıştırılacak aracın adı.	Evet
sunucu etiketi	String	İsteği yapan MCP sunucusunun etiketi.	Evet
type	enum	Öğenin türü. Her zaman mcp_approval_request. Olası değerler: mcp_approval_request	Evet

OpenAI.ItemResourceMcpApprovalResponseResource

MCP onay isteğine yanıt.

İsim	Türü	Description	Gerekli	Varsayılan
approval_request_id	String	Yanıtlanan onay isteğinin ID'si.	Evet
approve	Boolean	İsteğin onaylanıp onaylanmadı.	Evet
kimlik	String	Onay yanıtının benzersiz kimliği	Evet
sebep	dize (null atanabilir)		Hayı
type	enum	Öğenin türü. Her zaman mcp_approval_response. Olası değerler: mcp_approval_response	Evet

OpenAI.ItemResourceMcpListTools

MCP sunucusunda kullanılabilen araçların listesi.

İsim	Türü	Description	Gerekli	Varsayılan
hata	dize (null atanabilir)		Hayı
kimlik	String	Listenin benzersiz kimliği.	Evet
sunucu etiketi	String	MCP sunucusunun etiketi.	Evet
araçlar	OpenAI.MCPListToolsTool dizisi	Sunucuda bulunan araçlar.	Evet
type	enum	Öğenin türü. Her zaman mcp_list_tools. Olası değerler: mcp_list_tools	Evet

OpenAI.ItemResourceMcpToolCall

MCP sunucusundaki bir aracın çağrılması.

İsim	Türü	Description	Gerekli	Varsayılan
approval_request_id	dize (null atanabilir)		Hayı
arguments	String	Araca geçirilen bağımsız değişkenlerin JSON dizesi.	Evet
hata	dize (null atanabilir)		Hayı
kimlik	String	Araç çağrısının benzersiz kimliği.	Evet
name	String	Çalıştırılan aracın adı.	Evet
çıktı	dize (null atanabilir)		Hayı
sunucu etiketi	String	Aracı çalıştıran MCP sunucusunun etiketi.	Evet
durum	OpenAI.MCPToolCallStatus		Hayı
type	enum	Öğenin türü. Her zaman mcp_call. Olası değerler: mcp_call	Evet

OpenAI.ItemResourceOutputMessage

Modelden bir çıkış iletisi.

İsim	Türü	Description	Gerekli	Varsayılan
içerik	OpenAI.OutputMessageContent dizisi	Çıkış iletisinin içeriği.	Evet
kimlik	String	Çıkış iletisinin benzersiz kimliği.	Evet
role	enum	Çıkış iletisinin rolü. Her zaman assistant. Olası değerler: assistant	Evet
durum	enum	İleti girişinin durumu. in_progress, completed, veya bunlardan biri incomplete. API aracılığıyla giriş öğeleri döndürüldüğünde doldurulur. Olası değerler: in_progress, completed, incomplete	Evet
type	enum	Çıkış iletisinin türü. Her zaman message. Olası değerler: output_message	Evet

OpenAI.ItemResourceType

Mülkiyet	Değer
Türü	String
Değerler	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

Bir web arama aracı çağrısının sonuçları. Daha fazla bilgi için web arama rehberi adresine bakınız.

İsim	Türü	Description	Gerekli	Varsayılan
hareket	OpenAI.WebSearchActionSearch veya OpenAI.WebSearchActionOpenPage veya OpenAI.WebSearchActionFind	Bu web arama çağrısında gerçekleştirilen belirli eylemi açıklayan bir nesne. Modelin web'i nasıl kullandığına ilişkin ayrıntıları içerir (arama, open_page, bulma).	Evet
kimlik	String	Web arama aracının benzersiz kimliği çağrı.	Evet
durum	enum	Web arama aracı çağrısının durumu. Olası değerler: in_progress, searching, completed, failed	Evet
type	enum	Web arama aracının türü. Her zaman web_search_call. Olası değerler: web_search_call	Evet

OpenAI.ItemType

Mülkiyet	Değer
Türü	String
Değerler	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 structured_outputs oauth_consent_request memory_search_call workflow_action

OpenAI.ItemWebSearchToolCall

Bir web arama aracı çağrısının sonuçları. Daha fazla bilgi için web arama rehberi adresine bakınız.

İsim	Türü	Description	Gerekli	Varsayılan
hareket	OpenAI.WebSearchActionSearch veya OpenAI.WebSearchActionOpenPage veya OpenAI.WebSearchActionFind	Bu web arama çağrısında gerçekleştirilen belirli eylemi açıklayan bir nesne. Modelin web'i nasıl kullandığına ilişkin ayrıntıları içerir (arama, open_page, bulma).	Evet
kimlik	String	Web arama aracının benzersiz kimliği çağrı.	Evet
durum	enum	Web arama aracı çağrısının durumu. Olası değerler: in_progress, searching, completed, failed	Evet
type	enum	Web arama aracının türü. Her zaman web_search_call. Olası değerler: web_search_call	Evet

OpenAI.KeyPressAction

Modelin gerçekleştirmek istediği tuş baskıları koleksiyonu.

İsim	Türü	Description	Gerekli	Varsayılan
keys	dize dizisi	Modelin basılmasını istediği tuş kombinasyonu. Bu, her biri bir anahtarı temsil eden bir dize dizisidir.	Evet
type	enum	Olay türünü belirtir. Bir tuşa basma eylemi için bu özellik her zaman olarak keypressayarlanır. Olası değerler: keypress	Evet

OpenAI.ListFineTuningJobCheckpointsResponse

İsim	Türü	Description	Gerekli	Varsayılan
veriler	OpenAI.FineTuningJobCheckpoint dizisi		Evet
ilk_kimlik	dize (null atanabilir)		Hayı
daha_fazla	Boolean		Evet
son_kimlik	dize (null atanabilir)		Hayı
nesne	enum	Olası değerler: list	Evet

OpenAI.ListFineTuningJobEventsResponse

İsim	Türü	Description	Gerekli	Varsayılan
veriler	OpenAI.FineTuningJobEvent dizisi		Evet
daha_fazla	Boolean		Evet
nesne	enum	Olası değerler: list	Evet

OpenAI.ListPaginatedFineTuningJobsResponse

İsim	Türü	Description	Gerekli	Varsayılan
veriler	OpenAI.FineTuningJob dizisi		Evet
daha_fazla	Boolean		Evet
nesne	enum	Olası değerler: list	Evet

OpenAI.LocalShellCallStatus

Mülkiyet	Değer
Türü	String
Değerler	in_progress completed incomplete

OpenAI.LocalShellExecAction

Sunucuda bir kabuk komutu yürütür.

İsim	Türü	Description	Gerekli	Varsayılan
komut	dize dizisi	Çalıştırılacak komut.	Evet
env	nesne	Komutu için ayarlanacağı ortam değişkenleri.	Evet
zaman_aşımı_ms	OpenAI.integer (null atanabilir)		Hayı
type	enum	Yerel kabuk eyleminin türü. Her zaman exec. Olası değerler: exec	Evet
user	dize (null atanabilir)		Hayı
working_directory	dize (null atanabilir)		Hayı

OpenAI.LocalShellToolParam

Modelin yerel bir ortamda kabuk komutlarını yürütmesine izin veren bir araç.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Yerel kabuk aracının türü. Her zaman local_shell. Olası değerler: local_shell	Evet

OpenAI.LogProb

Belirtecin günlük olasılığı.

İsim	Türü	Description	Gerekli	Varsayılan
bytes	OpenAI.integer dizisi		Evet
logprob	OpenAI.numeric		Evet
token	String		Evet
top_logprobs	OpenAI.TopLogProb dizisi		Evet

OpenAI.MCPListToolsTool

MCP sunucusunda kullanılabilen bir araç.

İsim	Türü	Description	Gerekli	Varsayılan
Açıklamalar	OpenAI.MCPListToolsToolAnnotations (null atanabilir)		Hayı
açıklama	dize (null atanabilir)		Hayı
input_schema	OpenAI.MCPListToolsToolInputSchema		Evet
name	String	Araç adı.	Evet

OpenAI.MCPListToolsToolAnnotations

Tür: nesne

OpenAI.MCPListToolsToolInputSchema

Tür: nesne

OpenAI.MCPTool

Modele uzak Model Bağlam Protokolü (MCP) sunucuları aracılığıyla ek araçlara access ver. MCP.

İsim	Türü	Description	Gerekli	Varsayılan
izin verilen araçlar	dize dizisi veya OpenAI.MCPToolFilter		Hayı
yetkilendirme	String	Uzak bir MCP sunucusuyla kullanılabilen bir OAuth access token, şu iki özel bir MCP sunucu URL'si veya hizmet bağlayıcısı ile. Uygulamanız OAuth yetkilendirme akışını işlemesi ve belirteci burada sağlaması gerekir.	Hayı
connector_id	enum	ChatGPT'de bulunanlara benzer hizmet bağlayıcıları için tanımlayıcı. Bunlardan biri server_url veya connector_id sağlanmalıdır. Hizmet hakkında daha fazla bilgi edinin Bağlayıcılar burada. Şu anda desteklenen connector_id değerler şunlardır: -Dropbox: connector_dropbox -Gmail: connector_gmail - Google Takvim: connector_googlecalendar - Google Drive: connector_googledrive - Microsoft Teams: connector_microsoftteams - Outlook Takvimi: connector_outlookcalendar - Outlook E-postası: connector_outlookemail -Sharepoint: connector_sharepoint Olası değerler: connector_dropbox, connector_gmail, connector_googlecalendar, connector_googledrive, connector_microsoftteams, connector_outlookcalendar, connector_outlookemail, connector_sharepoint	Hayı
headers	object (null atanabilir)		Hayı
project_connection_id	String	MCP sunucusu için proje içindeki bağlantı kimliği. Bağlantı, MCP sunucusuna bağlanmak için gereken kimlik doğrulamasını ve diğer bağlantı ayrıntılarını saklar.	Hayı
onay_gerektir	object (aşağıdaki geçerli modellere bakın)		Hayı
server_description	String	MCP sunucusunun isteğe bağlı açıklaması, daha fazla bağlam sağlamak için kullanılır.	Hayı
sunucu etiketi	String	Bu MCP sunucusu için araç çağrılarında tanımlamak için kullanılan bir etiket.	Evet
sunucu_url	String	MCP sunucusunun URL'si. server_url Bunlardan biri veya connector_id olması gerekir Sağlanan.	Hayı
type	enum	MCP aracının türü. Her zaman mcp. Olası değerler: mcp	Evet

OpenAI.MCPToolCallStatus

Mülkiyet	Değer
Türü	String
Değerler	in_progress completed incomplete calling failed

OpenAI.MCPToolFilter

Hangi araçların izin verildiğini belirtmek için bir filtre nesnesi.

İsim	Türü	Description	Gerekli	Varsayılan
read_only	Boolean	Bir aracın veriyi değiştirip değiştirmediğini veya sadece okunabilir olup olmadığını gösterir. Bir MCP sunucusuna ile readOnlyHintek açıklama eklenir. bu filtreyle eşleşecektir.	Hayı
tool_names	dize dizisi	İzin verilen araç adlarının listesi.	Hayı

OpenAI.MCPToolRequireApproval

İsim	Türü	Description	Gerekli	Varsayılan
always	OpenAI.MCPToolFilter	Hangi araçların izin verildiğini belirtmek için bir filtre nesnesi.	Hayı
hiç	OpenAI.MCPToolFilter	Hangi araçların izin verildiğini belirtmek için bir filtre nesnesi.	Hayı

OpenAI.MessageContent

Giriş veya çıkış öğesini oluşturan içerik bölümü.

OpenAI.MessageContent için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
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

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.MessageContentType		Evet

OpenAI.MessageContentInputFileContent

Modele bir dosya girişi.

İsim	Türü	Description	Gerekli	Varsayılan
file_data	String	Modele gönderilecek dosyanın içeriği.	Hayı
dosya_kimlik	dize (null atanabilir)		Hayı
file_url	String	Modele gönderilecek dosyanın URL'si.	Hayı
filename	String	Modele gönderilecek dosyanın adı.	Hayı
type	enum	Giriş öğesinin türü. Her zaman input_file. Olası değerler: input_file	Evet

OpenAI.MessageContentInputImageContent

Modele bir görüntü girişi. image girişleri hakkında bilgi edinin.

İsim	Türü	Description	Gerekli	Varsayılan
detail	OpenAI.ImageDetail		Evet
dosya_kimlik	dize (null atanabilir)		Hayı
image_url	String		Hayı
type	enum	Giriş öğesinin türü. Her zaman input_image. Olası değerler: input_image	Evet

OpenAI.MessageContentInputTextContent

Modele metin girişi.

İsim	Türü	Description	Gerekli	Varsayılan
text	String	Modele metin girişi.	Evet
type	enum	Giriş öğesinin türü. Her zaman input_text. Olası değerler: input_text	Evet

OpenAI.MessageContentOutputTextContent

Modelden bir metin çıktısı.

İsim	Türü	Description	Gerekli	Varsayılan
Açıklamalar	OpenAI.Annotation dizisi	Metin çıkışının ek açıklamaları.	Evet
logprobs	OpenAI.LogProb dizisi		Hayı
text	String	Modelden metin çıkışı.	Evet
type	enum	Çıkış metninin türü. Her zaman output_text. Olası değerler: output_text	Evet

OpenAI.MessageContentReasoningTextContent

Modelden mantık metni.

İsim	Türü	Description	Gerekli	Varsayılan
text	String	Modelden gelen mantık metni.	Evet
type	enum	Akıl yürütme metninin türü. Her zaman reasoning_text. Olası değerler: reasoning_text	Evet

OpenAI.MessageContentRefusalContent

Model tarafından reddedilme.

İsim	Türü	Description	Gerekli	Varsayılan
Ret	String	Modelin sunduğu reddetme gerekçesi.	Evet
type	enum	Reddetmenin türü. Her zaman refusal. Olası değerler: refusal	Evet

OpenAI.MessageContentType

Mülkiyet	Değer
Türü	String
Değerler	input_text output_text text summary_text reasoning_text refusal input_image computer_screenshot input_file

OpenAI.MessageRole

Mülkiyet	Değer
Türü	String
Değerler	unknown user assistant system critic discriminator developer tool

OpenAI.MessageStatus

Mülkiyet	Değer
Türü	String
Değerler	in_progress completed incomplete

OpenAI.Metadata

Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, nesne hakkında ek bilgileri yapılandırılmış biçimde depolamak ve API veya pano aracılığıyla nesneleri sorgulamak için yararlı olabilir. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler, uzunluğu en fazla 512 karakter olan dizelerdir.

Tür: nesne

OpenAI.ModelIdsCompaction

veya gpt-5gibi o3 yanıtı oluşturmak için kullanılan model kimliği. OpenAI farklı özelliklere, performans özelliklerine ve fiyat noktalarına sahip çok çeşitli modeller sunar. Kullanılabilir modellere göz atmak ve modelleri karşılaştırmak için model kılavuzuna bakın.

Tür: OpenAI.ModelIdsResponses veya dize

veya gpt-5gibi o3 yanıtı oluşturmak için kullanılan model kimliği. OpenAI farklı özelliklere, performans özelliklerine ve fiyat noktalarına sahip çok çeşitli modeller sunar. Kullanılabilir modellere göz atmak ve modelleri karşılaştırmak için model kılavuzuna bakın.

OpenAI.ModelIdsResponses

Mülkiyet	Değer
Türü	String
Değerler	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

Tür: dize veya OpenAI.ChatModel

OpenAI.Move

Fare hareket ettirme eylemi.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olay türünü belirtir. Taşıma eylemi için bu özellik her zaman move olarak ayarlanır. Olası değerler: move	Evet
x	OpenAI.integer		Evet
y	OpenAI.integer		Evet

OpenAI.OutputContent

OpenAI.OutputContent için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
output_text	OpenAI.OutputContentOutputTextContent
refusal	OpenAI.OutputContentRefusalContent
reasoning_text	OpenAI.OutputContentReasoningTextContent

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.OutputContentType		Evet

OpenAI.OutputContentOutputTextContent

Modelden bir metin çıktısı.

İsim	Türü	Description	Gerekli	Varsayılan
Açıklamalar	OpenAI.Annotation dizisi	Metin çıkışının ek açıklamaları.	Evet
logprobs	OpenAI.LogProb dizisi		Hayı
text	String	Modelden metin çıkışı.	Evet
type	enum	Çıkış metninin türü. Her zaman output_text. Olası değerler: output_text	Evet

OpenAI.OutputContentReasoningTextContent

Modelden mantık metni.

İsim	Türü	Description	Gerekli	Varsayılan
text	String	Modelden gelen mantık metni.	Evet
type	enum	Akıl yürütme metninin türü. Her zaman reasoning_text. Olası değerler: reasoning_text	Evet

OpenAI.OutputContentRefusalContent

Model tarafından reddedilme.

İsim	Türü	Description	Gerekli	Varsayılan
Ret	String	Modelin sunduğu reddetme gerekçesi.	Evet
type	enum	Reddetmenin türü. Her zaman refusal. Olası değerler: refusal	Evet

OpenAI.OutputContentType

Mülkiyet	Değer
Türü	String
Değerler	output_text refusal reasoning_text

OpenAI.OutputItem

OpenAI.OutputItem için Ayrıştırıcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
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

İsim	Türü	Description	Gerekli	Varsayılan
agent_reference	AgentReference		Hayı
└─ ad	String	Aracının adı. Kısıtlamalar: maxLength: 256	Evet
└─ türü	enum	Olası değerler: agent_reference	Evet
└─ sürümü	String	Aracının sürüm tanımlayıcısı.	Hayı
response_id	String	Öğenin oluşturulduğu yanıt.	Hayı
type	OpenAI.OutputItemType		Evet

OpenAI.OutputItemApplyPatchToolCall

Dosya oluşturarak, silerek veya güncelleştirerek dosya farklarını uygulayan bir araç çağrısı.

İsim	Türü	Description	Gerekli	Varsayılan
agent_reference	AgentReference		Hayı
└─ ad	String	Aracının adı. Kısıtlamalar: maxLength: 256	Evet
└─ türü	enum	Olası değerler: agent_reference	Evet
└─ sürümü	String	Aracının sürüm tanımlayıcısı.	Hayı
call_id	String	Model tarafından oluşturulan uygulama yama aracı çağrısının benzersiz kimliği.	Evet
Oluşturan	String	Bu araç çağrısını oluşturan varlığın kimliği.	Hayı
kimlik	String	Düzeltme eki uygulama aracı çağrısının benzersiz kimliği. Bu öğe, API aracılığıyla iade edildiğinde doldurulur.	Evet
Operasyon	OpenAI.ApplyPatchFileOperation	apply_patch aracılığıyla uygulanan create_file, delete_file veya update_file işlemlerinden biri.	Evet
└─ türü	OpenAI.ApplyPatchFileOperationType		Evet
response_id	String	Öğenin oluşturulduğu yanıt.	Hayı
durum	OpenAI.ApplyPatchCallStatus		Evet
type	enum	Öğenin türü. Her zaman apply_patch_call. Olası değerler: apply_patch_call	Evet

OpenAI.OutputItemApplyPatchToolCallOutput

Bir düzeltme eki uygulama aracı çağrısı tarafından yayılan çıkış.

İsim	Türü	Description	Gerekli	Varsayılan
agent_reference	AgentReference		Hayı
└─ ad	String	Aracının adı. Kısıtlamalar: maxLength: 256	Evet
└─ türü	enum	Olası değerler: agent_reference	Evet
└─ sürümü	String	Aracının sürüm tanımlayıcısı.	Hayı
call_id	String	Model tarafından oluşturulan uygulama yama aracı çağrısının benzersiz kimliği.	Evet
Oluşturan	String	Bu aracı oluşturan varlığın kimliği çağrı çıktısı.	Hayı
kimlik	String	Düzeltme eki uygulama aracı çağrı çıkışının benzersiz kimliği. Bu öğe, API aracılığıyla iade edildiğinde doldurulur.	Evet
çıktı	dize (null atanabilir)		Hayı
response_id	String	Öğenin oluşturulduğu yanıt.	Hayı
durum	OpenAI.ApplyPatchCallOutputStatus		Evet
type	enum	Öğenin türü. Her zaman apply_patch_call_output. Olası değerler: apply_patch_call_output	Evet

OpenAI.OutputItemCodeInterpreterToolCall

Kodu çalıştırmak için bir araç çağrısı.

İsim	Türü	Description	Gerekli	Varsayılan
agent_reference	AgentReference		Hayı
└─ ad	String	Aracının adı. Kısıtlamalar: maxLength: 256	Evet
└─ türü	enum	Olası değerler: agent_reference	Evet
└─ sürümü	String	Aracının sürüm tanımlayıcısı.	Hayı
kod	dize (null atanabilir)		Evet
container_id	String	Kodu çalıştırmak için kullanılan kapsayıcının kimliği.	Evet
kimlik	String	Kod yorumlayıcısı araç çağrısının benzersiz kimliği.	Evet
Çıktılar	OpenAI.CodeInterpreterOutputLogs veya OpenAI.CodeInterpreterOutputImage dizisi		Evet
response_id	String	Öğenin oluşturulduğu yanıt.	Hayı
durum	enum	Kod yorumlayıcı aracı çağrısının durumu. Geçerli değerler : in_progress, completed, incomplete, interpretingve failed. Olası değerler: in_progress, completed, incomplete, interpreting, failed	Evet
type	enum	Kod yorumlayıcı aracı çağrısının türü. Her zaman code_interpreter_call. Olası değerler: code_interpreter_call	Evet

OpenAI.OutputItemCompactionBody

API tarafından v1/responses/compactoluşturulan bir sıkıştırma öğesi.

İsim	Türü	Description	Gerekli	Varsayılan
agent_reference	AgentReference		Hayı
└─ ad	String	Aracının adı. Kısıtlamalar: maxLength: 256	Evet
└─ türü	enum	Olası değerler: agent_reference	Evet
└─ sürümü	String	Aracının sürüm tanımlayıcısı.	Hayı
Oluşturan	String	Öğeyi oluşturan aktörün tanımlayıcısı.	Hayı
encrypted_content	String	Sıkıştırma tarafından oluşturulan şifrelenmiş içerik.	Evet
kimlik	String	Sıkıştırma öğesinin benzersiz kimliği.	Evet
response_id	String	Öğenin oluşturulduğu yanıt.	Hayı
type	enum	Öğenin türü. Her zaman compaction. Olası değerler: compaction	Evet

OpenAI.OutputItemComputerToolCall

Bilgisayar kullanım araçlarına bir araç komutu verme. Daha fazla bilgi için bilgisayar kullanım rehberi adresine bakınız.

İsim	Türü	Description	Gerekli	Varsayılan
hareket	OpenAI.ComputerAction		Evet
agent_reference	AgentReference		Hayı
└─ ad	String	Aracının adı. Kısıtlamalar: maxLength: 256	Evet
└─ türü	enum	Olası değerler: agent_reference	Evet
└─ sürümü	String	Aracının sürüm tanımlayıcısı.	Hayı
call_id	String	Çıkış verisi ile araç çağrısına yanıt verirken kullanılan tanımlayıcı.	Evet
kimlik	String	Bilgisayar çağrısının benzersiz tanımlayıcısı.	Evet
pending_safety_checks	OpenAI.ComputerCallSafetyCheckParam dizisi	Bilgisayar çağrısı için bekleyen güvenlik denetimleri.	Evet
response_id	String	Öğenin oluşturulduğu yanıt.	Hayı
durum	enum	Öğenin durumu. in_progress, completed, veya bunlardan biri incomplete. Öğeler API aracılığıyla döndürülürken doldurulur. Olası değerler: in_progress, completed, incomplete	Evet
type	enum	Bilgisayar çağrısının türü. Her zaman computer_call. Olası değerler: computer_call	Evet

OpenAI.OutputItemCustomToolCall

Model tarafından oluşturulan özel bir araca çağrı.

İsim	Türü	Description	Gerekli	Varsayılan
agent_reference	AgentReference		Hayı
└─ ad	String	Aracının adı. Kısıtlamalar: maxLength: 256	Evet
└─ türü	enum	Olası değerler: agent_reference	Evet
└─ sürümü	String	Aracının sürüm tanımlayıcısı.	Hayı
call_id	String	Bu özel araç çağrısını bir araç çağrısı çıktısına eşlemek için kullanılan bir tanımlayıcı.	Evet
kimlik	String	OpenAI platformundaki özel araç çağrısının benzersiz kimliği.	Hayı
girdi	String	Model tarafından oluşturulan özel araç çağrısı için girdi.	Evet
name	String	Çağrılan özel aracın adı.	Evet
response_id	String	Öğenin oluşturulduğu yanıt.	Hayı
type	enum	Özel araç çağrısının türü. Her zaman custom_tool_call. Olası değerler: custom_tool_call	Evet

OpenAI.OutputItemFileSearchToolCall

Dosya arama aracı çağrısının sonuçları. Daha fazla bilgi için dosya arama rehberi adresine bakınız.

İsim	Türü	Description	Gerekli	Varsayılan
agent_reference	AgentReference		Hayı
└─ ad	String	Aracının adı. Kısıtlamalar: maxLength: 256	Evet
└─ türü	enum	Olası değerler: agent_reference	Evet
└─ sürümü	String	Aracının sürüm tanımlayıcısı.	Hayı
kimlik	String	Dosya arama aracı çağrısının benzersiz kimliği.	Evet
queries	dize dizisi	Dosyaları aramak için kullanılan sorgular.	Evet
response_id	String	Öğenin oluşturulduğu yanıt.	Hayı
results	OpenAI.FileSearchToolCallResults dizisi		Hayı
durum	enum	Dosya arama aracı çağrısının durumu. Bunlardan biri in_progress searching, incomplete veya failed, Olası değerler: in_progress, searching, completed, incomplete, failed	Evet
type	enum	Dosya arama aracı çağrısının türü. Her zaman file_search_call. Olası değerler: file_search_call	Evet

OpenAI.OutputItemFunctionShellCall

Yönetilen bir ortamda bir veya daha fazla kabuk komutu yürüten bir araç çağrısı.

İsim	Türü	Description	Gerekli	Varsayılan
hareket	OpenAI.FunctionShellAction	Bir kabuk komutu yürütür.	Evet
└─ komutları	dize dizisi		Evet
└─ max_output_length	OpenAI.integer (null atanabilir)		Evet
└─ timeout_ms	OpenAI.integer (null atanabilir)		Evet
agent_reference	AgentReference		Hayı
└─ ad	String	Aracının adı. Kısıtlamalar: maxLength: 256	Evet
└─ türü	enum	Olası değerler: agent_reference	Evet
└─ sürümü	String	Aracının sürüm tanımlayıcısı.	Hayı
call_id	String	Model tarafından oluşturulan shell araç çağrısının benzersiz kimliği.	Evet
Oluşturan	String	Bu araç çağrısını oluşturan varlığın kimliği.	Hayı
kimlik	String	Kabuk aracı çağrısının benzersiz kimliği. Bu öğe, API aracılığıyla iade edildiğinde doldurulur.	Evet
response_id	String	Öğenin oluşturulduğu yanıt.	Hayı
durum	OpenAI.LocalShellCallStatus		Evet
type	enum	Öğenin türü. Her zaman shell_call. Olası değerler: shell_call	Evet

OpenAI.OutputItemFunctionShellCallOutput

Yayılan bir kabuk aracı çağrısının çıktısı.

İsim	Türü	Description	Gerekli	Varsayılan
agent_reference	AgentReference		Hayı
└─ ad	String	Aracının adı. Kısıtlamalar: maxLength: 256	Evet
└─ türü	enum	Olası değerler: agent_reference	Evet
└─ sürümü	String	Aracının sürüm tanımlayıcısı.	Hayı
call_id	String	Model tarafından oluşturulan shell araç çağrısının benzersiz kimliği.	Evet
Oluşturan	String	Öğeyi oluşturan aktörün tanımlayıcısı.	Hayı
kimlik	String	Kabuk çağrısı çıkışının benzersiz kimliği. Bu öğe, API aracılığıyla iade edildiğinde doldurulur.	Evet
max_output_length	OpenAI.integer (null atanabilir)		Evet
çıktı	OpenAI.FunctionShellCallOutputContent dizisi	Kabuk çağrısı çıkış içeriği dizisi	Evet
response_id	String	Öğenin oluşturulduğu yanıt.	Hayı
type	enum	Kabuk çağrısı çıkışının türü. Her zaman shell_call_output. Olası değerler: shell_call_output	Evet

OpenAI.OutputItemFunctionToolCall

Bir fonksiyonu çalıştırmak için bir araç çağrısı. Daha fazla bilgi için function çağrı rehberi adresine bakınız.

İsim	Türü	Description	Gerekli	Varsayılan
agent_reference	AgentReference		Hayı
└─ ad	String	Aracının adı. Kısıtlamalar: maxLength: 256	Evet
└─ türü	enum	Olası değerler: agent_reference	Evet
└─ sürümü	String	Aracının sürüm tanımlayıcısı.	Hayı
arguments	String	İşleve geçirecek bağımsız değişkenlerin JSON dizesi.	Evet
call_id	String	Model tarafından oluşturulan işlev aracı çağrısının benzersiz kimliği.	Evet
kimlik	String	İşlev aracı çağrısının benzersiz kimliği.	Hayı
name	String	Çalıştırılacak işlevin adı.	Evet
response_id	String	Öğenin oluşturulduğu yanıt.	Hayı
durum	enum	Öğenin durumu. in_progress, completed, veya bunlardan biri incomplete. Öğeler API aracılığıyla döndürülürken doldurulur. Olası değerler: in_progress, completed, incomplete	Hayı
type	enum	İşlev aracı çağrısının türü. Her zaman function_call. Olası değerler: function_call	Evet

OpenAI.OutputItemImageGenToolCall

Model tarafından yapılan bir görüntü oluşturma isteği.

İsim	Türü	Description	Gerekli	Varsayılan
agent_reference	AgentReference		Hayı
└─ ad	String	Aracının adı. Kısıtlamalar: maxLength: 256	Evet
└─ türü	enum	Olası değerler: agent_reference	Evet
└─ sürümü	String	Aracının sürüm tanımlayıcısı.	Hayı
kimlik	String	Görüntü oluşturma çağrısının benzersiz kimliği.	Evet
response_id	String	Öğenin oluşturulduğu yanıt.	Hayı
sonuç	dize (null atanabilir)		Evet
durum	enum	Görüntü oluşturma çağrısının durumu. Olası değerler: in_progress, completed, generating, failed	Evet
type	enum	Görüntü oluşturma çağrısının türü. Her zaman image_generation_call. Olası değerler: image_generation_call	Evet

OpenAI.OutputItemLocalShellToolCall

Yerel kabukta komut çalıştırmak için bir araç çağrısı.

İsim	Türü	Description	Gerekli	Varsayılan
hareket	OpenAI.LocalShellExecAction	Sunucuda bir kabuk komutu yürütür.	Evet
agent_reference	AgentReference		Hayı
└─ ad	String	Aracının adı. Kısıtlamalar: maxLength: 256	Evet
└─ türü	enum	Olası değerler: agent_reference	Evet
└─ sürümü	String	Aracının sürüm tanımlayıcısı.	Hayı
call_id	String	Model tarafından oluşturulan yerel kabuk aracı çağrısının benzersiz kimliği.	Evet
kimlik	String	Yerel shell çağrısının benzersiz kimliği.	Evet
response_id	String	Öğenin oluşturulduğu yanıt.	Hayı
durum	enum	Yerel shell çağrısının durumu. Olası değerler: in_progress, completed, incomplete	Evet
type	enum	Yerel shell call'ın türü. Her zaman local_shell_call. Olası değerler: local_shell_call	Evet

OpenAI.OutputItemMcpApprovalRequest

Bir araç çağrısı işlemi için insan onayı isteği.

İsim	Türü	Description	Gerekli	Varsayılan
agent_reference	AgentReference		Hayı
└─ ad	String	Aracının adı. Kısıtlamalar: maxLength: 256	Evet
└─ türü	enum	Olası değerler: agent_reference	Evet
└─ sürümü	String	Aracının sürüm tanımlayıcısı.	Hayı
arguments	String	Araç için bir JSON bağımsız değişken dizesi.	Evet
kimlik	String	Onay talebinin benzersiz kimliği.	Evet
name	String	Çalıştırılacak aracın adı.	Evet
response_id	String	Öğenin oluşturulduğu yanıt.	Hayı
sunucu etiketi	String	İsteği yapan MCP sunucusunun etiketi.	Evet
type	enum	Öğenin türü. Her zaman mcp_approval_request. Olası değerler: mcp_approval_request	Evet

OpenAI.OutputItemMcpListTools

MCP sunucusunda kullanılabilen araçların listesi.

İsim	Türü	Description	Gerekli	Varsayılan
agent_reference	AgentReference		Hayı
└─ ad	String	Aracının adı. Kısıtlamalar: maxLength: 256	Evet
└─ türü	enum	Olası değerler: agent_reference	Evet
└─ sürümü	String	Aracının sürüm tanımlayıcısı.	Hayı
hata	dize (null atanabilir)		Hayı
kimlik	String	Listenin benzersiz kimliği.	Evet
response_id	String	Öğenin oluşturulduğu yanıt.	Hayı
sunucu etiketi	String	MCP sunucusunun etiketi.	Evet
araçlar	OpenAI.MCPListToolsTool dizisi	Sunucuda bulunan araçlar.	Evet
type	enum	Öğenin türü. Her zaman mcp_list_tools. Olası değerler: mcp_list_tools	Evet

OpenAI.OutputItemMcpToolCall

MCP sunucusundaki bir aracın çağrılması.

İsim	Türü	Description	Gerekli	Varsayılan
agent_reference	AgentReference		Hayı
└─ ad	String	Aracının adı. Kısıtlamalar: maxLength: 256	Evet
└─ türü	enum	Olası değerler: agent_reference	Evet
└─ sürümü	String	Aracının sürüm tanımlayıcısı.	Hayı
approval_request_id	dize (null atanabilir)		Hayı
arguments	String	Araca geçirilen bağımsız değişkenlerin JSON dizesi.	Evet
hata	dize (null atanabilir)		Hayı
kimlik	String	Araç çağrısının benzersiz kimliği.	Evet
name	String	Çalıştırılan aracın adı.	Evet
çıktı	dize (null atanabilir)		Hayı
response_id	String	Öğenin oluşturulduğu yanıt.	Hayı
sunucu etiketi	String	Aracı çalıştıran MCP sunucusunun etiketi.	Evet
durum	OpenAI.MCPToolCallStatus		Hayı
type	enum	Öğenin türü. Her zaman mcp_call. Olası değerler: mcp_call	Evet

OpenAI.OutputItemOutputMessage

Modelden bir çıkış iletisi.

İsim	Türü	Description	Gerekli	Varsayılan
agent_reference	AgentReference		Hayı
└─ ad	String	Aracının adı. Kısıtlamalar: maxLength: 256	Evet
└─ türü	enum	Olası değerler: agent_reference	Evet
└─ sürümü	String	Aracının sürüm tanımlayıcısı.	Hayı
içerik	OpenAI.OutputMessageContent dizisi	Çıkış iletisinin içeriği.	Evet
kimlik	String	Çıkış iletisinin benzersiz kimliği.	Evet
response_id	String	Öğenin oluşturulduğu yanıt.	Hayı
role	enum	Çıkış iletisinin rolü. Her zaman assistant. Olası değerler: assistant	Evet
durum	enum	İleti girişinin durumu. in_progress, completed, veya bunlardan biri incomplete. API aracılığıyla giriş öğeleri döndürüldüğünde doldurulur. Olası değerler: in_progress, completed, incomplete	Evet
type	enum	Çıkış iletisinin türü. Her zaman message. Olası değerler: output_message	Evet

OpenAI.OutputItemReasoningItem

Bir yanıt oluştururken bir akıl yürütme modeli tarafından kullanılan düşünce zincirinin açıklaması. Eğer konuşmanın sonraki turlarında bu öğeleri bağlam yönetiyorsanız ile manuel olarak konuşuyorsanız, Responses API'ye input hesabınıza dahil edin.

İsim	Türü	Description	Gerekli	Varsayılan
agent_reference	AgentReference		Hayı
└─ ad	String	Aracının adı. Kısıtlamalar: maxLength: 256	Evet
└─ türü	enum	Olası değerler: agent_reference	Evet
└─ sürümü	String	Aracının sürüm tanımlayıcısı.	Hayı
içerik	OpenAI.ReasoningTextContent dizisi	Metin içeriğini akıl yürütme.	Hayı
encrypted_content	dize (null atanabilir)		Hayı
kimlik	String	Akıl yürütme içeriğinin benzersiz tanımlayıcısı.	Evet
response_id	String	Öğenin oluşturulduğu yanıt.	Hayı
durum	enum	Öğenin durumu. in_progress, completed, veya bunlardan biri incomplete. Öğeler API aracılığıyla döndürülürken doldurulur. Olası değerler: in_progress, completed, incomplete	Hayı
summary	OpenAI.Summary dizisi	Akıl yürütme özeti içeriği.	Evet
type	enum	Nesnenin türü. Her zaman reasoning. Olası değerler: reasoning	Evet

OpenAI.OutputItemType

Mülkiyet	Değer
Türü	String
Değerler	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

Bir web arama aracı çağrısının sonuçları. Daha fazla bilgi için web arama rehberi adresine bakınız.

İsim	Türü	Description	Gerekli	Varsayılan
hareket	OpenAI.WebSearchActionSearch veya OpenAI.WebSearchActionOpenPage veya OpenAI.WebSearchActionFind	Bu web arama çağrısında gerçekleştirilen belirli eylemi açıklayan bir nesne. Modelin web'i nasıl kullandığına ilişkin ayrıntıları içerir (arama, open_page, bulma).	Evet
agent_reference	AgentReference		Hayı
└─ ad	String	Aracının adı. Kısıtlamalar: maxLength: 256	Evet
└─ türü	enum	Olası değerler: agent_reference	Evet
└─ sürümü	String	Aracının sürüm tanımlayıcısı.	Hayı
kimlik	String	Web arama aracının benzersiz kimliği çağrı.	Evet
response_id	String	Öğenin oluşturulduğu yanıt.	Hayı
durum	enum	Web arama aracı çağrısının durumu. Olası değerler: in_progress, searching, completed, failed	Evet
type	enum	Web arama aracının türü. Her zaman web_search_call. Olası değerler: web_search_call	Evet

OpenAI.OutputMessageContent

OpenAI.OutputMessageContent için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
output_text	OpenAI.OutputMessageContentOutputTextContent
refusal	OpenAI.OutputMessageContentRefusalContent

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.OutputMessageContentType		Evet

OpenAI.OutputMessageContentOutputTextContent

Modelden bir metin çıktısı.

İsim	Türü	Description	Gerekli	Varsayılan
Açıklamalar	OpenAI.Annotation dizisi	Metin çıkışının ek açıklamaları.	Evet
logprobs	OpenAI.LogProb dizisi		Hayı
text	String	Modelden metin çıkışı.	Evet
type	enum	Çıkış metninin türü. Her zaman output_text. Olası değerler: output_text	Evet

OpenAI.OutputMessageContentRefusalContent

Model tarafından reddedilme.

İsim	Türü	Description	Gerekli	Varsayılan
Ret	String	Modelin sunduğu reddetme gerekçesi.	Evet
type	enum	Reddetmenin türü. Her zaman refusal. Olası değerler: refusal	Evet

OpenAI.OutputMessageContentType

Mülkiyet	Değer
Türü	String
Değerler	output_text refusal

OpenAI.Prompt

bir istem şablonuna ve değişkenlerine başvuru. Daha fazla bilgi edinin.

İsim	Türü	Description	Gerekli	Varsayılan
kimlik	String	Kullanılacak istem şablonunun benzersiz tanımlayıcısı.	Evet
değişkenler	OpenAI.ResponsePromptVariables (null atanabilir)	içindeki değişkenlerin yerine kullanılacak isteğe bağlı değer eşlemesi Istemi. Değiştirme değerleri dizeler veya başka bir değer olabilir Görüntüler veya dosyalar gibi yanıt giriş türleri.	Hayı
version	dize (null atanabilir)		Hayı

OpenAI.RankerVersionType

Mülkiyet	Değer
Türü	String
Değerler	auto default-2024-11-15

OpenAI.RankingOptions

İsim	Türü	Description	Gerekli	Varsayılan
hybrid_search	OpenAI.HybridSearchOptions		Hayı
└─ embedding_weight	OpenAI.numeric	Karşılıklı sıralama füzyonundaki gömülen ağırlığı.	Evet
└─ text_weight	OpenAI.numeric	Karşılıklı sıralama birleşimindeki metnin ağırlığı.	Evet
sıralayıcı	OpenAI.RankerVersionType		Hayı
puan_eşik_değeri	OpenAI.numeric		Hayı

OpenAI.Reasoning

Sadece GPT-5 ve O-serisi modelleri Akıl yürütme modelleri için yapılandırma seçenekleri.

İsim	Türü	Description	Gerekli	Varsayılan
effort	OpenAI.ReasoningEffort	Akıl yürütme çabasını kısıtlar mantıp modelleri. Şu anda desteklenen değerler none, minimal, low, medium, high, ve xhigh'dir. Azaltma muhakeme çabası daha hızlı yanıtlara ve daha az belirteç kullanılmasına neden olabilir bir yanıtta mantık yürütme. - gpt-5.1 varsayılan olarak noneöğesini kullanır ve mantık yürütmez. Desteklenen gerekçe değerleri gpt-5.1none, low, medium, ve high'dir. Araç çağrıları gpt-5.1'deki tüm akıl yürütme değerleri için desteklenir. - Tüm modeller varsayılan olarak akıl yürütme eforu olmadan gpt-5.1 önce medium ve desteklemeznone. - Model gpt-5-pro varsayılan olarak akıl yürütme eforunu kullanır (ve yalnızca destekler high ). - xhigh , sonrasındaki gpt-5.1-codex-maxtüm modeller için desteklenir.	Hayı
generate_summary	enum	Olası değerler: auto, concise, detailed	Hayı
summary	enum	Olası değerler: auto, concise, detailed	Hayı

OpenAI.ReasoningEffort

Mantıp modelleri için mantık yürütme çabasını kısıtlar. Şu anda desteklenen değerler none, minimal, low, medium, high, ve xhigh'dir. Muhakeme çabasının azaltılması, yanıtta daha hızlı yanıtlar ve daha az belirteç kullanılmasına neden olabilir.

• gpt-5.1 varsayılan olarak none, bu da akıl yürütme yapmaz. Desteklenen gerekçe değerleri gpt-5.1none, low, medium, ve high'dir. Araç çağrıları gpt-5.1'deki tüm akıl yürütme değerleri için desteklenir.
• Önceki gpt-5.1 tüm modeller varsayılan olarak medium akıl yürütme çabasına geçer ve nonedesteklemez.
• Model gpt-5-pro varsayılan olarak (ve sadece destekliyor) high akıl yürütme çabasını kullanır.
• xhigh sonrası tüm modeller gpt-5.1-codex-maxiçin desteklenir.

Mülkiyet	Değer
Türü	String
Nullable	Evet
Değerler	none minimal low medium high xhigh

OpenAI.ReasoningTextContent

Modelden mantık metni.

İsim	Türü	Description	Gerekli	Varsayılan
text	String	Modelden gelen mantık metni.	Evet
type	enum	Akıl yürütme metninin türü. Her zaman reasoning_text. Olası değerler: reasoning_text	Evet

OpenAI.Response

İsim	Türü	Description	Gerekli	Varsayılan
agent_reference	AgentReference (null atanabilir)		Evet
└─ ad	String	Aracının adı. Kısıtlamalar: maxLength: 256	Evet
└─ türü	enum	Olası değerler: agent_reference	Evet
└─ sürümü	String	Aracının sürüm tanımlayıcısı.	Hayı
arka plan	boole değeri (null atanabilir)		Hayı
tamamlanma_tarihi	tamsayı		Hayı
konuşma	OpenAI.ConversationReference (null atanabilir)	Bu yanıtın ait olduğu konuşma. Bu yanıttaki giriş öğeleri ve çıkış öğeleri bu konuşmaya otomatik olarak eklendi.	Hayı
└─ kimlik	String	Bu yanıtın ilişkilendirildiği konuşmanın benzersiz kimliği.	Evet
oluşturulma_tarihi	tamsayı	Bu Yanıtın oluşturulduğu unix zaman damgası (saniye).	Evet
hata	OpenAI.ResponseError (null atanabilir)	Model yanıt oluşturamadığında döndürülen bir hata nesnesi.	Evet
└─ kod	OpenAI.ResponseErrorCode	Yanıtın hata kodu.	Evet
└─ ileti	String	Hatanın insan tarafından okunabilen açıklaması.	Evet
kimlik	String	Bu Yanıt için benzersiz tanımlayıcı.	Evet
incomplete_details	OpenAI.ResponseIncompleteDetails (null atanabilir)		Evet
└─ neden	enum	Olası değerler: max_output_tokens, content_filter	Hayı
instructions	OpenAI.InputItem dizesi veya dizisi		Evet
max_output_tokens	OpenAI.integer (null atanabilir)		Hayı
max_tool_calls	OpenAI.integer (null atanabilir)		Hayı
metadata	OpenAI.Metadata (null atanabilir)	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Hayı
model	String	Bu yanıtın oluşturulması için kullanılacak model dağıtımı.	Hayı
nesne	enum	Bu kaynağın nesne türü - her zaman response olarak ayarlanır. Olası değerler: response	Evet
çıktı	OpenAI.OutputItem dizisi	Model tarafından oluşturulan içerik öğeleri dizisi. - Dizideki output öğelerin uzunluğu ve sırası bağlıdır modelin yanıtı üzerinde. - Dizideki output ilk öğeye erişmek yerine ve tarafından oluşturulan içeriğe sahip bir assistant ileti olduğunu varsayarsak modeli dikkate alarak output_text özelliğini kullanmayı düşünebilirsiniz. SDK'larda desteklenir.	Evet
output_text	dize (null atanabilir)		Hayı
paralel araç çağrıları	Boolean	Modelin araç çağrılarını paralel olarak çalıştırmasına izin verilip verilmeyeceği.	Evet	Doğru
previous_response_id	dize (null atanabilir)		Hayı
prompt	OpenAI.Prompt	bir istem şablonuna ve değişkenlerine başvuru. Daha fazla bilgi edinin.	Hayı
prompt_cache_key	String	OpenAI tarafından önbellek isabet hızlarınızı iyileştirmek amacıyla benzer isteklere yönelik yanıtları önbelleğe almak için kullanılır. user alanını değiştirir. Daha fazla bilgi edinin.	Hayı
prompt_cache_retention	enum	Olası değerler: in-memory, 24h	Hayı
reasoning	OpenAI.Reasoning (null atanabilir)	yalnızca gpt-5 ve o serisi modeller Için yapılandırma seçenekleri mantıp modelleri.	Hayı
└─ çaba	OpenAI.ReasoningEffort	Akıl yürütme çabasını kısıtlar mantıp modelleri. Şu anda desteklenen değerler none, minimal, low, medium, high, ve xhigh'dir. Azaltma muhakeme çabası daha hızlı yanıtlara ve daha az belirteç kullanılmasına neden olabilir bir yanıtta mantık yürütme. - gpt-5.1 varsayılan olarak noneöğesini kullanır ve mantık yürütmez. Desteklenen gerekçe değerleri gpt-5.1none, low, medium, ve high'dir. Araç çağrıları gpt-5.1'deki tüm akıl yürütme değerleri için desteklenir. - Tüm modeller varsayılan olarak akıl yürütme eforu olmadan gpt-5.1 önce medium ve desteklemeznone. - Model gpt-5-pro varsayılan olarak akıl yürütme eforunu kullanır (ve yalnızca destekler high ). - xhigh , sonrasındaki gpt-5.1-codex-maxtüm modeller için desteklenir.	Hayı
└─ özet oluştur	enum	Olası değerler: auto, concise, detailed	Hayı
└─ özeti	enum	Olası değerler: auto, concise, detailed	Hayı
safety_identifier	String	OpenAI'nin kullanım ilkelerini ihlal eden uygulamanızın kullanıcılarını algılamaya yardımcı olmak için kullanılan kararlı tanımlayıcı. Kimlikler, her kullanıcıyı benzersiz olarak tanımlayan bir dize olmalıdır. Bize herhangi bir tanımlayıcı bilgi göndermemek için kullanıcı adını veya e-posta adresini karma olarak kullanmanızı öneririz. Daha fazla bilgi edinin.	Hayı
hizmet seviyesi	OpenAI.ServiceTier	İsteğin sunulması için kullanılan işleme türünü belirtir. - 'Otomatik' olarak ayarlanırsa, talep Project ayarlarında hizmet katmanı yapılandırılmış şekilde işlenecektir. Başka bir şekilde yapılandırmadıkça, Project 'default' seçeneğini kullanır. - 'varsayılan' olarak ayarlanırsa, istek seçilen model için standart fiyatlandırma ve performansla işlenir. - 'flex' veya 'öncelikli' olarak ayarlanırsa, talep ilgili hizmet katmanıyla işlenecektir. - Ayarlanmadığında, varsayılan davranış 'auto' şeklindedir. service_tier Parametre ayarlandığında, yanıt gövdesi isteğe hizmet etmek için kullanılan işleme moduna göre değeri içerirservice_tier. Bu yanıt değeri, parametresindeki değerden farklı olabilir.	Hayı
durum	enum	Yanıt oluşturma durumu. , , completed' lerden failedbiri in_progress, cancelled, queued veya incomplete. Olası değerler: completed, failed, in_progress, cancelled, , queued, incomplete	Hayı
sıcaklık	OpenAI.numeric (null atanabilir)		Hayı	1
text	OpenAI.ResponseTextParam	Modelden metin yanıtı için yapılandırma seçenekleri. Düz olabilir metin veya yapılandırılmış JSON verileri. Daha fazla bilgi edinin: - Metin girişleri ve çıktıları - Yapılandırılmış Çıktılar	Hayı
tool_choice	OpenAI.ToolChoiceOptions veya OpenAI.ToolChoiceParam		Hayı
araçlar	OpenAI.ToolsArray	Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Siz parametresini ayarlayarak tool_choice hangi aracın kullanılacağını belirtebilir. Aşağıdaki araç kategorilerini destekliyoruz: - Yerleşik araçlar: OpenAI tarafından sağlanan ve işlevselliği genişleten araçlar modelin yetenekleri, örneğin web arama veya file search. Hakkında daha fazla bilgi edinin yerleşik araçlar. - MCP Araçları: Özel MCP sunucuları aracılığıyla üçüncü taraf sistemlerle tümleştirmeler veya Google Drive ve SharePoint gibi önceden tanımlanmış bağlayıcılar. Hakkında daha fazla bilgi edinin MCP Araçları. - İşlev çağrıları (özel araçlar): Sizin tanımladığınız işlevler, modelin kesin olarak yazılan bağımsız değişkenlerle kendi kodunuzu çağırmasını sağlama ve çıkışlarını seçin. Hakkında daha fazla bilgi edinin fonksiyon çağrısı. Ayrıca şunları da kullanabilirsiniz: kendi kodunuzu çağırmak için özel araçlar.	Hayı
top_logprobs	OpenAI.integer (null atanabilir)		Hayı
top_p	OpenAI.numeric (null atanabilir)		Hayı	1
truncation	enum	Olası değerler: auto, disabled	Hayı
usage	OpenAI.ResponseUsage	Giriş belirteçleri, çıkış belirteçleri dahil olmak üzere belirteç kullanım ayrıntılarını temsil eder. çıkış belirteçlerinin ve kullanılan toplam belirteçlerin dökümü.	Hayı
user	dize (kullanım dışı)	Bu alan ve safety_identifierile prompt_cache_key değiştiriliyor. Bunun yerine önbelleğe alma iyileştirmelerini korumak için kullanın prompt_cache_key . Son kullanıcılarınız için kararlı bir tanımlayıcı. Benzer istekleri daha iyi demetleyerek önbellek isabet oranlarını artırmak ve OpenAI'nin kötüye kullanımı algılayıp önlemesine yardımcı olmak için kullanılır. Daha fazla bilgi edinin.	Hayı

OpenAI.ResponseAudioDeltaEvent

Kısmi bir ses yanıtı olduğunda yayılır.

İsim	Türü	Description	Gerekli	Varsayılan
delta	String	Base64 kodlanmış yanıt ses baytlarının bir öbeği.	Evet
sequence_number	OpenAI.integer		Evet
type	enum	Olayın türü. Her zaman response.audio.delta. Olası değerler: response.audio.delta	Evet

OpenAI.ResponseAudioDoneEvent

Ses yanıtı tamamlandığında gönderilir.

İsim	Türü	Description	Gerekli	Varsayılan
sequence_number	OpenAI.integer		Evet
type	enum	Olayın türü. Her zaman response.audio.done. Olası değerler: response.audio.done	Evet

OpenAI.ResponseAudioTranscriptDeltaEvent

Sesin kısmi bir transkripti olduğunda yayılır.

İsim	Türü	Description	Gerekli	Varsayılan
delta	String	Ses yanıtının kısmi transkripti.	Evet
sequence_number	OpenAI.integer		Evet
type	enum	Olayın türü. Her zaman response.audio.transcript.delta. Olası değerler: response.audio.transcript.delta	Evet

OpenAI.ResponseAudioTranscriptDoneEvent

Tam ses transkripti tamamlandığında gönderilir.

İsim	Türü	Description	Gerekli	Varsayılan
sequence_number	OpenAI.integer		Evet
type	enum	Olayın türü. Her zaman response.audio.transcript.done. Olası değerler: response.audio.transcript.done	Evet

OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent

Kısmi kod parçacığı kod yorumlayıcı tarafından akışa alındığında yayılır.

İsim	Türü	Description	Gerekli	Varsayılan
delta	String	Kod yorumlayıcı tarafından akışı yapılan kısmi kod parçacığı.	Evet
item_id	String	Kod yorumlayıcı aracı çağrı öğesinin benzersiz tanımlayıcısı.	Evet
output_index	OpenAI.integer		Evet
sequence_number	OpenAI.integer		Evet
type	enum	Olayın türü. Her zaman response.code_interpreter_call_code.delta. Olası değerler: response.code_interpreter_call_code.delta	Evet

OpenAI.ResponseCodeInterpreterCallCodeDoneEvent

Kod parçacığı kod yorumlayıcı tarafından sonlandırıldığında yayılır.

İsim	Türü	Description	Gerekli	Varsayılan
kod	String	Kod yorumlayıcısı tarafından son kod parçacığı çıkışı.	Evet
item_id	String	Kod yorumlayıcı aracı çağrı öğesinin benzersiz tanımlayıcısı.	Evet
output_index	OpenAI.integer		Evet
sequence_number	OpenAI.integer		Evet
type	enum	Olayın türü. Her zaman response.code_interpreter_call_code.done. Olası değerler: response.code_interpreter_call_code.done	Evet

OpenAI.ResponseCodeInterpreterCallCompletedEvent

Kod yorumlayıcı çağrısı tamamlandığında gönderilir.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	Kod yorumlayıcı aracı çağrı öğesinin benzersiz tanımlayıcısı.	Evet
output_index	OpenAI.integer		Evet
sequence_number	OpenAI.integer		Evet
type	enum	Olayın türü. Her zaman response.code_interpreter_call.completed. Olası değerler: response.code_interpreter_call.completed	Evet

OpenAI.ResponseCodeInterpreterCallInProgressEvent

Bir kod yorumlayıcı çağrısı sırasında tetiklenir.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	Kod yorumlayıcı aracı çağrı öğesinin benzersiz tanımlayıcısı.	Evet
output_index	OpenAI.integer		Evet
sequence_number	OpenAI.integer		Evet
type	enum	Olayın türü. Her zaman response.code_interpreter_call.in_progress. Olası değerler: response.code_interpreter_call.in_progress	Evet

OpenAI.ResponseCodeInterpreterCallInterpretingEvent

Kod yorumlayıcısı kod parçacığını etkin bir şekilde yorumladığında yayılır.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	Kod yorumlayıcı aracı çağrı öğesinin benzersiz tanımlayıcısı.	Evet
output_index	OpenAI.integer		Evet
sequence_number	OpenAI.integer		Evet
type	enum	Olayın türü. Her zaman response.code_interpreter_call.interpreting. Olası değerler: response.code_interpreter_call.interpreting	Evet

OpenAI.ResponseCompletedEvent

Model yanıtı tamamlandığında gönderilir.

İsim	Türü	Description	Gerekli	Varsayılan
yanıt	OpenAI.Response		Evet
└─ agent_reference	AgentReference (null atanabilir)	Bu yanıt için kullanılan aracı	Evet
└─ arka plan	boole değeri (null atanabilir)		Hayı
└─ completed_at	integer (null atanabilir)		Hayı
└─ konuşma	OpenAI.ConversationReference (null atanabilir)	Bu yanıtın ait olduğu konuşma. Bu yanıttaki giriş öğeleri ve çıkış öğeleri bu konuşmaya otomatik olarak eklendi.	Hayı
└─ oluşturulma_tarihi	tamsayı	Bu Yanıtın oluşturulduğu unix zaman damgası (saniye).	Evet
└─ hata	OpenAI.ResponseError (null atanabilir)	Model yanıt oluşturamadığında döndürülen bir hata nesnesi.	Evet
└─ kimlik	String	Bu Yanıt için benzersiz tanımlayıcı.	Evet
└─ eksik_bilgiler	OpenAI.ResponseIncompleteDetails (null atanabilir)		Evet
└─ yönerge	OpenAI.InputItem dizesi veya dizisi (null atanabilir)		Evet
└─ maksimum_çıkış_jetonları	OpenAI.integer (null atanabilir)		Hayı
└─ maksimum araç çağrıları	OpenAI.integer (null atanabilir)		Hayı
└─ meta veriler	OpenAI.Metadata (null atanabilir)	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Hayı
└─ modeli	String	Bu yanıtın oluşturulması için kullanılacak model dağıtımı.	Hayı
└─ nesne	enum	Bu kaynağın nesne türü - her zaman response olarak ayarlanır. Olası değerler: response	Evet
└─ çıkış	OpenAI.OutputItem dizisi	Model tarafından oluşturulan içerik öğeleri dizisi. - Dizideki output öğelerin uzunluğu ve sırası bağlıdır modelin yanıtı üzerinde. - Dizideki output ilk öğeye erişmek yerine ve tarafından oluşturulan içeriğe sahip bir assistant ileti olduğunu varsayarsak modeli dikkate alarak output_text özelliğini kullanmayı düşünebilirsiniz. SDK'larda desteklenir.	Evet
└─ çıktı_metin	dize (null atanabilir)		Hayı
└─ paralel_arac_cagrilari	Boolean	Modelin araç çağrılarını paralel olarak çalıştırmasına izin verilip verilmeyeceği.	Evet	Doğru
└─ önceki_cevap_id	dize (null atanabilir)		Hayı
└─ istemi	OpenAI.Prompt	bir istem şablonuna ve değişkenlerine başvuru. Daha fazla bilgi edinin.	Hayı
└─ prompt_cache_key	String	OpenAI tarafından önbellek isabet hızlarınızı iyileştirmek amacıyla benzer isteklere yönelik yanıtları önbelleğe almak için kullanılır. user alanını değiştirir. Daha fazla bilgi edinin.	Hayı
└─ prompt_cache_retention	enum	Olası değerler: in-memory, 24h	Hayı
└─ akıl yürütme	OpenAI.Reasoning (null atanabilir)	yalnızca gpt-5 ve o serisi modeller Için yapılandırma seçenekleri mantıp modelleri.	Hayı
└─ safety_identifier	String	OpenAI'nin kullanım ilkelerini ihlal eden uygulamanızın kullanıcılarını algılamaya yardımcı olmak için kullanılan kararlı tanımlayıcı. Kimlikler, her kullanıcıyı benzersiz olarak tanımlayan bir dize olmalıdır. Bize herhangi bir tanımlayıcı bilgi göndermemek için kullanıcı adını veya e-posta adresini karma olarak kullanmanızı öneririz. Daha fazla bilgi edinin.	Hayı
└─ service_tier	OpenAI.ServiceTier	İsteğin sunulması için kullanılan işleme türünü belirtir. - 'Otomatik' olarak ayarlanırsa, talep Project ayarlarında hizmet katmanı yapılandırılmış şekilde işlenecektir. Başka bir şekilde yapılandırmadıkça, Project 'default' seçeneğini kullanır. - 'varsayılan' olarak ayarlanırsa, istek seçilen model için standart fiyatlandırma ve performansla işlenir. - 'flex' veya 'öncelikli' olarak ayarlanırsa, talep ilgili hizmet katmanıyla işlenecektir. - Ayarlanmadığında, varsayılan davranış 'auto' şeklindedir. service_tier Parametre ayarlandığında, yanıt gövdesi isteğe hizmet etmek için kullanılan işleme moduna göre değeri içerirservice_tier. Bu yanıt değeri, parametresindeki değerden farklı olabilir.	Hayı
└─ durumu	enum	Yanıt oluşturma durumu. , , completed' lerden failedbiri in_progress, cancelled, queued veya incomplete. Olası değerler: completed, failed, in_progress, cancelled, , queued, incomplete	Hayı
└─ sıcaklık	OpenAI.numeric (null atanabilir)		Hayı	1
└─ metin	OpenAI.ResponseTextParam	Modelden metin yanıtı için yapılandırma seçenekleri. Düz olabilir metin veya yapılandırılmış JSON verileri. Daha fazla bilgi edinin: - Metin girişleri ve çıktıları - Yapılandırılmış Çıktılar	Hayı
└─ araç seçimi	OpenAI.ToolChoiceOptions veya OpenAI.ToolChoiceParam		Hayı
└─ araçları	OpenAI.ToolsArray	Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Siz parametresini ayarlayarak tool_choice hangi aracın kullanılacağını belirtebilir. Aşağıdaki araç kategorilerini destekliyoruz: - Yerleşik araçlar: OpenAI tarafından sağlanan ve işlevselliği genişleten araçlar modelin yetenekleri, örneğin web arama veya file search. Hakkında daha fazla bilgi edinin yerleşik araçlar. - MCP Araçları: Özel MCP sunucuları aracılığıyla üçüncü taraf sistemlerle tümleştirmeler veya Google Drive ve SharePoint gibi önceden tanımlanmış bağlayıcılar. Hakkında daha fazla bilgi edinin MCP Araçları. - İşlev çağrıları (özel araçlar): Sizin tanımladığınız işlevler, modelin kesin olarak yazılan bağımsız değişkenlerle kendi kodunuzu çağırmasını sağlama ve çıkışlarını seçin. Hakkında daha fazla bilgi edinin fonksiyon çağrısı. Ayrıca şunları da kullanabilirsiniz: kendi kodunuzu çağırmak için özel araçlar.	Hayı
└─ top_logprobs	OpenAI.integer (null atanabilir)		Hayı
└─ top_p	OpenAI.numeric (null atanabilir)		Hayı	1
└─ kısaltma	enum	Olası değerler: auto, disabled	Hayı
└─ kullanımı	OpenAI.ResponseUsage	Giriş belirteçleri, çıkış belirteçleri dahil olmak üzere belirteç kullanım ayrıntılarını temsil eder. çıkış belirteçlerinin ve kullanılan toplam belirteçlerin dökümü.	Hayı
└─ kullanıcı	dize (kullanım dışı)	Bu alan ve safety_identifierile prompt_cache_key değiştiriliyor. Bunun yerine önbelleğe alma iyileştirmelerini korumak için kullanın prompt_cache_key . Son kullanıcılarınız için kararlı bir tanımlayıcı. Benzer istekleri daha iyi demetleyerek önbellek isabet oranlarını artırmak ve OpenAI'nin kötüye kullanımı algılayıp önlemesine yardımcı olmak için kullanılır. Daha fazla bilgi edinin.	Hayı
sequence_number	OpenAI.integer		Evet
type	enum	Olayın türü. Her zaman response.completed. Olası değerler: response.completed	Evet

OpenAI.ResponseContentPartAddedEvent

Yeni bir içerik bölümü eklendiğinde gönderilir.

İsim	Türü	Description	Gerekli	Varsayılan
content_index	OpenAI.integer		Evet
item_id	String	İçerik bölümünün eklendiği çıkış öğesinin kimliği.	Evet
output_index	OpenAI.integer		Evet
parça	OpenAI.OutputContent		Evet
└─ türü	OpenAI.OutputContentType		Evet
sequence_number	OpenAI.integer		Evet
type	enum	Olayın türü. Her zaman response.content_part.added. Olası değerler: response.content_part.added	Evet

OpenAI.ResponseContentPartDoneEvent

İçerik bölümü tamamlandığında gönderilir.

İsim	Türü	Description	Gerekli	Varsayılan
content_index	OpenAI.integer		Evet
item_id	String	İçerik bölümünün eklendiği çıkış öğesinin kimliği.	Evet
output_index	OpenAI.integer		Evet
parça	OpenAI.OutputContent		Evet
└─ türü	OpenAI.OutputContentType		Evet
sequence_number	OpenAI.integer		Evet
type	enum	Olayın türü. Her zaman response.content_part.done. Olası değerler: response.content_part.done	Evet

OpenAI.ResponseCreatedEvent

Bir yanıt oluşturulduğunda yayılan bir olay.

İsim	Türü	Description	Gerekli	Varsayılan
yanıt	OpenAI.Response		Evet
└─ agent_reference	AgentReference (null atanabilir)	Bu yanıt için kullanılan aracı	Evet
└─ arka plan	boole değeri (null atanabilir)		Hayı
└─ completed_at	integer (null atanabilir)		Hayı
└─ konuşma	OpenAI.ConversationReference (null atanabilir)	Bu yanıtın ait olduğu konuşma. Bu yanıttaki giriş öğeleri ve çıkış öğeleri bu konuşmaya otomatik olarak eklendi.	Hayı
└─ oluşturulma_tarihi	tamsayı	Bu Yanıtın oluşturulduğu unix zaman damgası (saniye).	Evet
└─ hata	OpenAI.ResponseError (null atanabilir)	Model yanıt oluşturamadığında döndürülen bir hata nesnesi.	Evet
└─ kimlik	String	Bu Yanıt için benzersiz tanımlayıcı.	Evet
└─ eksik_bilgiler	OpenAI.ResponseIncompleteDetails (null atanabilir)		Evet
└─ yönerge	OpenAI.InputItem dizesi veya dizisi (null atanabilir)		Evet
└─ maksimum_çıkış_jetonları	OpenAI.integer (null atanabilir)		Hayı
└─ maksimum araç çağrıları	OpenAI.integer (null atanabilir)		Hayı
└─ meta veriler	OpenAI.Metadata (null atanabilir)	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Hayı
└─ modeli	String	Bu yanıtın oluşturulması için kullanılacak model dağıtımı.	Hayı
└─ nesne	enum	Bu kaynağın nesne türü - her zaman response olarak ayarlanır. Olası değerler: response	Evet
└─ çıkış	OpenAI.OutputItem dizisi	Model tarafından oluşturulan içerik öğeleri dizisi. - Dizideki output öğelerin uzunluğu ve sırası bağlıdır modelin yanıtı üzerinde. - Dizideki output ilk öğeye erişmek yerine ve tarafından oluşturulan içeriğe sahip bir assistant ileti olduğunu varsayarsak modeli dikkate alarak output_text özelliğini kullanmayı düşünebilirsiniz. SDK'larda desteklenir.	Evet
└─ çıktı_metin	dize (null atanabilir)		Hayı
└─ paralel_arac_cagrilari	Boolean	Modelin araç çağrılarını paralel olarak çalıştırmasına izin verilip verilmeyeceği.	Evet	Doğru
└─ önceki_cevap_id	dize (null atanabilir)		Hayı
└─ istemi	OpenAI.Prompt	bir istem şablonuna ve değişkenlerine başvuru. Daha fazla bilgi edinin.	Hayı
└─ prompt_cache_key	String	OpenAI tarafından önbellek isabet hızlarınızı iyileştirmek amacıyla benzer isteklere yönelik yanıtları önbelleğe almak için kullanılır. user alanını değiştirir. Daha fazla bilgi edinin.	Hayı
└─ prompt_cache_retention	enum	Olası değerler: in-memory, 24h	Hayı
└─ akıl yürütme	OpenAI.Reasoning (null atanabilir)	yalnızca gpt-5 ve o serisi modeller Için yapılandırma seçenekleri mantıp modelleri.	Hayı
└─ safety_identifier	String	OpenAI'nin kullanım ilkelerini ihlal eden uygulamanızın kullanıcılarını algılamaya yardımcı olmak için kullanılan kararlı tanımlayıcı. Kimlikler, her kullanıcıyı benzersiz olarak tanımlayan bir dize olmalıdır. Bize herhangi bir tanımlayıcı bilgi göndermemek için kullanıcı adını veya e-posta adresini karma olarak kullanmanızı öneririz. Daha fazla bilgi edinin.	Hayı
└─ service_tier	OpenAI.ServiceTier	İsteğin sunulması için kullanılan işleme türünü belirtir. - 'Otomatik' olarak ayarlanırsa, talep Project ayarlarında hizmet katmanı yapılandırılmış şekilde işlenecektir. Başka bir şekilde yapılandırmadıkça, Project 'default' seçeneğini kullanır. - 'varsayılan' olarak ayarlanırsa, istek seçilen model için standart fiyatlandırma ve performansla işlenir. - 'flex' veya 'öncelikli' olarak ayarlanırsa, talep ilgili hizmet katmanıyla işlenecektir. - Ayarlanmadığında, varsayılan davranış 'auto' şeklindedir. service_tier Parametre ayarlandığında, yanıt gövdesi isteğe hizmet etmek için kullanılan işleme moduna göre değeri içerirservice_tier. Bu yanıt değeri, parametresindeki değerden farklı olabilir.	Hayı
└─ durumu	enum	Yanıt oluşturma durumu. , , completed' lerden failedbiri in_progress, cancelled, queued veya incomplete. Olası değerler: completed, failed, in_progress, cancelled, , queued, incomplete	Hayı
└─ sıcaklık	OpenAI.numeric (null atanabilir)		Hayı	1
└─ metin	OpenAI.ResponseTextParam	Modelden metin yanıtı için yapılandırma seçenekleri. Düz olabilir metin veya yapılandırılmış JSON verileri. Daha fazla bilgi edinin: - Metin girişleri ve çıktıları - Yapılandırılmış Çıktılar	Hayı
└─ araç seçimi	OpenAI.ToolChoiceOptions veya OpenAI.ToolChoiceParam		Hayı
└─ araçları	OpenAI.ToolsArray	Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Siz parametresini ayarlayarak tool_choice hangi aracın kullanılacağını belirtebilir. Aşağıdaki araç kategorilerini destekliyoruz: - Yerleşik araçlar: OpenAI tarafından sağlanan ve işlevselliği genişleten araçlar modelin yetenekleri, örneğin web arama veya file search. Hakkında daha fazla bilgi edinin yerleşik araçlar. - MCP Araçları: Özel MCP sunucuları aracılığıyla üçüncü taraf sistemlerle tümleştirmeler veya Google Drive ve SharePoint gibi önceden tanımlanmış bağlayıcılar. Hakkında daha fazla bilgi edinin MCP Araçları. - İşlev çağrıları (özel araçlar): Sizin tanımladığınız işlevler, modelin kesin olarak yazılan bağımsız değişkenlerle kendi kodunuzu çağırmasını sağlama ve çıkışlarını seçin. Hakkında daha fazla bilgi edinin fonksiyon çağrısı. Ayrıca şunları da kullanabilirsiniz: kendi kodunuzu çağırmak için özel araçlar.	Hayı
└─ top_logprobs	OpenAI.integer (null atanabilir)		Hayı
└─ top_p	OpenAI.numeric (null atanabilir)		Hayı	1
└─ kısaltma	enum	Olası değerler: auto, disabled	Hayı
└─ kullanımı	OpenAI.ResponseUsage	Giriş belirteçleri, çıkış belirteçleri dahil olmak üzere belirteç kullanım ayrıntılarını temsil eder. çıkış belirteçlerinin ve kullanılan toplam belirteçlerin dökümü.	Hayı
└─ kullanıcı	dize (kullanım dışı)	Bu alan ve safety_identifierile prompt_cache_key değiştiriliyor. Bunun yerine önbelleğe alma iyileştirmelerini korumak için kullanın prompt_cache_key . Son kullanıcılarınız için kararlı bir tanımlayıcı. Benzer istekleri daha iyi demetleyerek önbellek isabet oranlarını artırmak ve OpenAI'nin kötüye kullanımı algılayıp önlemesine yardımcı olmak için kullanılır. Daha fazla bilgi edinin.	Hayı
sequence_number	OpenAI.integer		Evet
type	enum	Olayın türü. Her zaman response.created. Olası değerler: response.created	Evet

OpenAI.ResponseCustomToolCallInputDeltaEvent

Özel bir araç çağrısının girişine delta (kısmi güncelleştirme) temsil eden olay.

İsim	Türü	Description	Gerekli	Varsayılan
delta	String	Özel araç çağrısı için artımlı giriş verileri (delta).	Evet
item_id	String	Bu olayla ilişkili API öğesinin benzersiz tanımlayıcısı.	Evet
output_index	OpenAI.integer		Evet
sequence_number	OpenAI.integer		Evet
type	enum	Olay türü tanımlayıcısı. Olası değerler: response.custom_tool_call_input.delta	Evet

OpenAI.ResponseCustomToolCallInputDoneEvent

Özel bir araç çağrısı için girişin tamamlandığını belirten olay.

İsim	Türü	Description	Gerekli	Varsayılan
girdi	String	Özel araç çağrısı için tam giriş verileri.	Evet
item_id	String	Bu olayla ilişkili API öğesinin benzersiz tanımlayıcısı.	Evet
output_index	OpenAI.integer		Evet
sequence_number	OpenAI.integer		Evet
type	enum	Olay türü tanımlayıcısı. Olası değerler: response.custom_tool_call_input.done	Evet

OpenAI.ResponseError

Model yanıt oluşturamadığında döndürülen bir hata nesnesi.

İsim	Türü	Description	Gerekli	Varsayılan
kod	OpenAI.ResponseErrorCode	Yanıtın hata kodu.	Evet
mesaj	String	Hatanın insan tarafından okunabilen açıklaması.	Evet

OpenAI.ResponseErrorCode

Yanıtın hata kodu.

Mülkiyet	Değer
Türü	String
Değerler	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

Bir hata oluştuğunda yayılır.

İsim	Türü	Description	Gerekli	Varsayılan
kod	dize (null atanabilir)		Evet
mesaj	String	Hata iletisi.	Evet
param	dize (null atanabilir)		Evet
sequence_number	OpenAI.integer		Evet
type	enum	Olayın türü. Her zaman error. Olası değerler: error	Evet

OpenAI.ResponseFailedEvent

Yanıt başarısız olduğunda yayılan bir olay.

İsim	Türü	Description	Gerekli	Varsayılan
yanıt	OpenAI.Response		Evet
└─ agent_reference	AgentReference (null atanabilir)	Bu yanıt için kullanılan aracı	Evet
└─ arka plan	boole değeri (null atanabilir)		Hayı
└─ completed_at	integer (null atanabilir)		Hayı
└─ konuşma	OpenAI.ConversationReference (null atanabilir)	Bu yanıtın ait olduğu konuşma. Bu yanıttaki giriş öğeleri ve çıkış öğeleri bu konuşmaya otomatik olarak eklendi.	Hayı
└─ oluşturulma_tarihi	tamsayı	Bu Yanıtın oluşturulduğu unix zaman damgası (saniye).	Evet
└─ hata	OpenAI.ResponseError (null atanabilir)	Model yanıt oluşturamadığında döndürülen bir hata nesnesi.	Evet
└─ kimlik	String	Bu Yanıt için benzersiz tanımlayıcı.	Evet
└─ eksik_bilgiler	OpenAI.ResponseIncompleteDetails (null atanabilir)		Evet
└─ yönerge	OpenAI.InputItem dizesi veya dizisi (null atanabilir)		Evet
└─ maksimum_çıkış_jetonları	OpenAI.integer (null atanabilir)		Hayı
└─ maksimum araç çağrıları	OpenAI.integer (null atanabilir)		Hayı
└─ meta veriler	OpenAI.Metadata (null atanabilir)	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Hayı
└─ modeli	String	Bu yanıtın oluşturulması için kullanılacak model dağıtımı.	Hayı
└─ nesne	enum	Bu kaynağın nesne türü - her zaman response olarak ayarlanır. Olası değerler: response	Evet
└─ çıkış	OpenAI.OutputItem dizisi	Model tarafından oluşturulan içerik öğeleri dizisi. - Dizideki output öğelerin uzunluğu ve sırası bağlıdır modelin yanıtı üzerinde. - Dizideki output ilk öğeye erişmek yerine ve tarafından oluşturulan içeriğe sahip bir assistant ileti olduğunu varsayarsak modeli dikkate alarak output_text özelliğini kullanmayı düşünebilirsiniz. SDK'larda desteklenir.	Evet
└─ çıktı_metin	dize (null atanabilir)		Hayı
└─ paralel_arac_cagrilari	Boolean	Modelin araç çağrılarını paralel olarak çalıştırmasına izin verilip verilmeyeceği.	Evet	Doğru
└─ önceki_cevap_id	dize (null atanabilir)		Hayı
└─ istemi	OpenAI.Prompt	bir istem şablonuna ve değişkenlerine başvuru. Daha fazla bilgi edinin.	Hayı
└─ prompt_cache_key	String	OpenAI tarafından önbellek isabet hızlarınızı iyileştirmek amacıyla benzer isteklere yönelik yanıtları önbelleğe almak için kullanılır. user alanını değiştirir. Daha fazla bilgi edinin.	Hayı
└─ prompt_cache_retention	enum	Olası değerler: in-memory, 24h	Hayı
└─ akıl yürütme	OpenAI.Reasoning (null atanabilir)	yalnızca gpt-5 ve o serisi modeller Için yapılandırma seçenekleri mantıp modelleri.	Hayı
└─ safety_identifier	String	OpenAI'nin kullanım ilkelerini ihlal eden uygulamanızın kullanıcılarını algılamaya yardımcı olmak için kullanılan kararlı tanımlayıcı. Kimlikler, her kullanıcıyı benzersiz olarak tanımlayan bir dize olmalıdır. Bize herhangi bir tanımlayıcı bilgi göndermemek için kullanıcı adını veya e-posta adresini karma olarak kullanmanızı öneririz. Daha fazla bilgi edinin.	Hayı
└─ service_tier	OpenAI.ServiceTier	İsteğin sunulması için kullanılan işleme türünü belirtir. - 'Otomatik' olarak ayarlanırsa, talep Project ayarlarında hizmet katmanı yapılandırılmış şekilde işlenecektir. Başka bir şekilde yapılandırmadıkça, Project 'default' seçeneğini kullanır. - 'varsayılan' olarak ayarlanırsa, istek seçilen model için standart fiyatlandırma ve performansla işlenir. - 'flex' veya 'öncelikli' olarak ayarlanırsa, talep ilgili hizmet katmanıyla işlenecektir. - Ayarlanmadığında, varsayılan davranış 'auto' şeklindedir. service_tier Parametre ayarlandığında, yanıt gövdesi isteğe hizmet etmek için kullanılan işleme moduna göre değeri içerirservice_tier. Bu yanıt değeri, parametresindeki değerden farklı olabilir.	Hayı
└─ durumu	enum	Yanıt oluşturma durumu. , , completed' lerden failedbiri in_progress, cancelled, queued veya incomplete. Olası değerler: completed, failed, in_progress, cancelled, , queued, incomplete	Hayı
└─ sıcaklık	OpenAI.numeric (null atanabilir)		Hayı	1
└─ metin	OpenAI.ResponseTextParam	Modelden metin yanıtı için yapılandırma seçenekleri. Düz olabilir metin veya yapılandırılmış JSON verileri. Daha fazla bilgi edinin: - Metin girişleri ve çıktıları - Yapılandırılmış Çıktılar	Hayı
└─ araç seçimi	OpenAI.ToolChoiceOptions veya OpenAI.ToolChoiceParam		Hayı
└─ araçları	OpenAI.ToolsArray	Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Siz parametresini ayarlayarak tool_choice hangi aracın kullanılacağını belirtebilir. Aşağıdaki araç kategorilerini destekliyoruz: - Yerleşik araçlar: OpenAI tarafından sağlanan ve işlevselliği genişleten araçlar modelin yetenekleri, örneğin web arama veya file search. Hakkında daha fazla bilgi edinin yerleşik araçlar. - MCP Araçları: Özel MCP sunucuları aracılığıyla üçüncü taraf sistemlerle tümleştirmeler veya Google Drive ve SharePoint gibi önceden tanımlanmış bağlayıcılar. Hakkında daha fazla bilgi edinin MCP Araçları. - İşlev çağrıları (özel araçlar): Sizin tanımladığınız işlevler, modelin kesin olarak yazılan bağımsız değişkenlerle kendi kodunuzu çağırmasını sağlama ve çıkışlarını seçin. Hakkında daha fazla bilgi edinin fonksiyon çağrısı. Ayrıca şunları da kullanabilirsiniz: kendi kodunuzu çağırmak için özel araçlar.	Hayı
└─ top_logprobs	OpenAI.integer (null atanabilir)		Hayı
└─ top_p	OpenAI.numeric (null atanabilir)		Hayı	1
└─ kısaltma	enum	Olası değerler: auto, disabled	Hayı
└─ kullanımı	OpenAI.ResponseUsage	Giriş belirteçleri, çıkış belirteçleri dahil olmak üzere belirteç kullanım ayrıntılarını temsil eder. çıkış belirteçlerinin ve kullanılan toplam belirteçlerin dökümü.	Hayı
└─ kullanıcı	dize (kullanım dışı)	Bu alan ve safety_identifierile prompt_cache_key değiştiriliyor. Bunun yerine önbelleğe alma iyileştirmelerini korumak için kullanın prompt_cache_key . Son kullanıcılarınız için kararlı bir tanımlayıcı. Benzer istekleri daha iyi demetleyerek önbellek isabet oranlarını artırmak ve OpenAI'nin kötüye kullanımı algılayıp önlemesine yardımcı olmak için kullanılır. Daha fazla bilgi edinin.	Hayı
sequence_number	OpenAI.integer		Evet
type	enum	Olayın türü. Her zaman response.failed. Olası değerler: response.failed	Evet

OpenAI.ResponseFileSearchCallCompletedEvent

Bir dosya arama çağrısı tamamlandığında (sonuçlar bulundu) yayılır.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	Dosya arama çağrısının başlatıldığı çıkış öğesinin kimliği.	Evet
output_index	OpenAI.integer		Evet
sequence_number	OpenAI.integer		Evet
type	enum	Olayın türü. Her zaman response.file_search_call.completed. Olası değerler: response.file_search_call.completed	Evet

OpenAI.ResponseFileSearchCallInProgressEvent

Bir dosya arama çağrısı başlatıldığında gönderilir.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	Dosya arama çağrısının başlatıldığı çıkış öğesinin kimliği.	Evet
output_index	OpenAI.integer		Evet
sequence_number	OpenAI.integer		Evet
type	enum	Olayın türü. Her zaman response.file_search_call.in_progress. Olası değerler: response.file_search_call.in_progress	Evet

OpenAI.ResponseFileSearchCallSearchingEvent

Bir dosya araması sırasında arama yapıldığında tetiklenir.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	Dosya arama çağrısının başlatıldığı çıkış öğesinin kimliği.	Evet
output_index	OpenAI.integer		Evet
sequence_number	OpenAI.integer		Evet
type	enum	Olayın türü. Her zaman response.file_search_call.searching. Olası değerler: response.file_search_call.searching	Evet

OpenAI.ResponseFormatJsonObject

JSON nesne yanıt biçimi. JSON yanıtları oluşturmanın eski bir yöntemi. Bunu destekleyen modeller için kullanılması json_schema önerilir. Modelin, bir sistem veya kullanıcı mesajı olmadan JSON oluşturmayacağını unutmayın, bunu to do etmelidir.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Tanımlanan yanıt biçiminin türü. Her zaman json_object. Olası değerler: json_object	Evet

OpenAI.ResponseFormatJsonSchema

JSON Şeması yanıt biçimi. Yapılandırılmış JSON yanıtları oluşturmak için kullanılır. Yapılandırılmış Çıktılar hakkında daha fazla bilgi edinin.

İsim	Türü	Description	Gerekli	Varsayılan
json şeması	OpenAI.ResponseFormatJsonSchemaJsonSchema		Evet
└─ açıklama	String		Hayı
└─ ad	String		Evet
└─ şeması	OpenAI.YanıtFormatıJsonŞemaŞeması	JSON Şeması nesnesi olarak tanımlanan yanıt biçimi şeması. JSON şemaları oluşturmayı buradan öğrenin.	Hayı
└─ katı	boole değeri (null atanabilir)		Hayı
type	enum	Tanımlanan yanıt biçiminin türü. Her zaman json_schema. Olası değerler: json_schema	Evet

OpenAI.ResponseFormatJsonSchemaJsonSchema

İsim	Türü	Description	Gerekli	Varsayılan
açıklama	String		Hayı
name	String		Evet
şema	OpenAI.YanıtFormatıJsonŞemaŞeması	JSON Şeması nesnesi olarak tanımlanan yanıt biçimi şeması. JSON şemaları oluşturmayı buradan öğrenin.	Hayı
Sıkı	boole değeri (null atanabilir)		Hayı

OpenAI.CevapFormatJsonŞemaŞeması

JSON Şeması nesnesi olarak tanımlanan yanıt biçimi şeması. JSON şemaları oluşturmayı buradan öğrenin.

Tür: nesne

OpenAI.ResponseFormatText

Varsayılan yanıt biçimi. Metin yanıtları oluşturmak için kullanılır.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Tanımlanan yanıt biçiminin türü. Her zaman text. Olası değerler: text	Evet

OpenAI.ResponseFunctionCallArgumentsDeltaEvent

Kısmi işlev çağrısı bağımsız değişkenleri delta olduğunda yayılır.

İsim	Türü	Description	Gerekli	Varsayılan
delta	String	Fonksiyon çağrısı argümanlarına eklenen delta.	Evet
item_id	String	delta işlev çağrısı bağımsız değişkenlerinin eklendiği çıkış öğesinin kimliği.	Evet
output_index	OpenAI.integer		Evet
sequence_number	OpenAI.integer		Evet
type	enum	Olayın türü. Her zaman response.function_call_arguments.delta. Olası değerler: response.function_call_arguments.delta	Evet

OpenAI.ResponseFunctionCallArgumentsDoneEvent

İşlev çağrısı bağımsız değişkenleri sonlandırıldığında verilir.

İsim	Türü	Description	Gerekli	Varsayılan
arguments	String	İşlev çağrısı için argümanlar.	Evet
item_id	String	Öğenin kimliği.	Evet
name	String	Çağrılan işlevin adı.	Evet
output_index	OpenAI.integer		Evet
sequence_number	OpenAI.integer		Evet
type	enum	Olası değerler: response.function_call_arguments.done	Evet

OpenAI.ResponseImageGenCallCompletedEvent

Görüntü oluşturma aracı çağrısı tamamlandığında ve son görüntü kullanılabilir olduğunda yayılır.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	İşlenmekte olan görüntü oluşturma öğesinin benzersiz tanımlayıcısı.	Evet
output_index	OpenAI.integer		Evet
sequence_number	OpenAI.integer		Evet
type	enum	Olayın türü. Her zaman 'response.image_generation_call.completed' şeklinde. Olası değerler: response.image_generation_call.completed	Evet

OpenAI.ResponseImageGenCallGeneratingEvent

Görüntü oluşturma aracı çağrısı (ara durum) etkin bir şekilde görüntü oluştururken tetiklenir.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	İşlenmekte olan görüntü oluşturma öğesinin benzersiz tanımlayıcısı.	Evet
output_index	OpenAI.integer		Evet
sequence_number	OpenAI.integer		Evet
type	enum	Olayın türü. Her zaman 'response.image_generation_call.generating'. Olası değerler: response.image_generation_call.generating	Evet

OpenAI.ResponseImageGenCallInProgressEvent

Görüntü oluşturma aracı çağrısı devam ederken bir bildirim gönderilir.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	İşlenmekte olan görüntü oluşturma öğesinin benzersiz tanımlayıcısı.	Evet
output_index	OpenAI.integer		Evet
sequence_number	OpenAI.integer		Evet
type	enum	Olayın türü. Her zaman 'response.image_generation_call.in_progress'. Olası değerler: response.image_generation_call.in_progress	Evet

OpenAI.ResponseImageGenCallPartialImageEvent

Görüntü oluşturma akışı sırasında kısmi bir görüntü kullanılabilir olduğunda emit edilir.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	İşlenmekte olan görüntü oluşturma öğesinin benzersiz tanımlayıcısı.	Evet
output_index	OpenAI.integer		Evet
partial_image_b64	String	Base64 ile kodlanmış kısmi görüntü verileri, görüntü olarak işleme için uygundur.	Evet
partial_image_index	OpenAI.integer		Evet
sequence_number	OpenAI.integer		Evet
type	enum	Olayın türü. Her zaman 'response.image_generation_call.partial_image'. Olası değerler: response.image_generation_call.partial_image	Evet

OpenAI.ResponseInProgressEvent

Yanıt devam ederken gönderilir.

İsim	Türü	Description	Gerekli	Varsayılan
yanıt	OpenAI.Response		Evet
└─ agent_reference	AgentReference (null atanabilir)	Bu yanıt için kullanılan aracı	Evet
└─ arka plan	boole değeri (null atanabilir)		Hayı
└─ completed_at	integer (null atanabilir)		Hayı
└─ konuşma	OpenAI.ConversationReference (null atanabilir)	Bu yanıtın ait olduğu konuşma. Bu yanıttaki giriş öğeleri ve çıkış öğeleri bu konuşmaya otomatik olarak eklendi.	Hayı
└─ oluşturulma_tarihi	tamsayı	Bu Yanıtın oluşturulduğu unix zaman damgası (saniye).	Evet
└─ hata	OpenAI.ResponseError (null atanabilir)	Model yanıt oluşturamadığında döndürülen bir hata nesnesi.	Evet
└─ kimlik	String	Bu Yanıt için benzersiz tanımlayıcı.	Evet
└─ eksik_bilgiler	OpenAI.ResponseIncompleteDetails (null atanabilir)		Evet
└─ yönerge	OpenAI.InputItem dizesi veya dizisi (null atanabilir)		Evet
└─ maksimum_çıkış_jetonları	OpenAI.integer (null atanabilir)		Hayı
└─ maksimum araç çağrıları	OpenAI.integer (null atanabilir)		Hayı
└─ meta veriler	OpenAI.Metadata (null atanabilir)	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Hayı
└─ modeli	String	Bu yanıtın oluşturulması için kullanılacak model dağıtımı.	Hayı
└─ nesne	enum	Bu kaynağın nesne türü - her zaman response olarak ayarlanır. Olası değerler: response	Evet
└─ çıkış	OpenAI.OutputItem dizisi	Model tarafından oluşturulan içerik öğeleri dizisi. - Dizideki output öğelerin uzunluğu ve sırası bağlıdır modelin yanıtı üzerinde. - Dizideki output ilk öğeye erişmek yerine ve tarafından oluşturulan içeriğe sahip bir assistant ileti olduğunu varsayarsak modeli dikkate alarak output_text özelliğini kullanmayı düşünebilirsiniz. SDK'larda desteklenir.	Evet
└─ çıktı_metin	dize (null atanabilir)		Hayı
└─ paralel_arac_cagrilari	Boolean	Modelin araç çağrılarını paralel olarak çalıştırmasına izin verilip verilmeyeceği.	Evet	Doğru
└─ önceki_cevap_id	dize (null atanabilir)		Hayı
└─ istemi	OpenAI.Prompt	bir istem şablonuna ve değişkenlerine başvuru. Daha fazla bilgi edinin.	Hayı
└─ prompt_cache_key	String	OpenAI tarafından önbellek isabet hızlarınızı iyileştirmek amacıyla benzer isteklere yönelik yanıtları önbelleğe almak için kullanılır. user alanını değiştirir. Daha fazla bilgi edinin.	Hayı
└─ prompt_cache_retention	enum	Olası değerler: in-memory, 24h	Hayı
└─ akıl yürütme	OpenAI.Reasoning (null atanabilir)	yalnızca gpt-5 ve o serisi modeller Için yapılandırma seçenekleri mantıp modelleri.	Hayı
└─ safety_identifier	String	OpenAI'nin kullanım ilkelerini ihlal eden uygulamanızın kullanıcılarını algılamaya yardımcı olmak için kullanılan kararlı tanımlayıcı. Kimlikler, her kullanıcıyı benzersiz olarak tanımlayan bir dize olmalıdır. Bize herhangi bir tanımlayıcı bilgi göndermemek için kullanıcı adını veya e-posta adresini karma olarak kullanmanızı öneririz. Daha fazla bilgi edinin.	Hayı
└─ service_tier	OpenAI.ServiceTier	İsteğin sunulması için kullanılan işleme türünü belirtir. - 'Otomatik' olarak ayarlanırsa, talep Project ayarlarında hizmet katmanı yapılandırılmış şekilde işlenecektir. Başka bir şekilde yapılandırmadıkça, Project 'default' seçeneğini kullanır. - 'varsayılan' olarak ayarlanırsa, istek seçilen model için standart fiyatlandırma ve performansla işlenir. - 'flex' veya 'öncelikli' olarak ayarlanırsa, talep ilgili hizmet katmanıyla işlenecektir. - Ayarlanmadığında, varsayılan davranış 'auto' şeklindedir. service_tier Parametre ayarlandığında, yanıt gövdesi isteğe hizmet etmek için kullanılan işleme moduna göre değeri içerirservice_tier. Bu yanıt değeri, parametresindeki değerden farklı olabilir.	Hayı
└─ durumu	enum	Yanıt oluşturma durumu. , , completed' lerden failedbiri in_progress, cancelled, queued veya incomplete. Olası değerler: completed, failed, in_progress, cancelled, , queued, incomplete	Hayı
└─ sıcaklık	OpenAI.numeric (null atanabilir)		Hayı	1
└─ metin	OpenAI.ResponseTextParam	Modelden metin yanıtı için yapılandırma seçenekleri. Düz olabilir metin veya yapılandırılmış JSON verileri. Daha fazla bilgi edinin: - Metin girişleri ve çıktıları - Yapılandırılmış Çıktılar	Hayı
└─ araç seçimi	OpenAI.ToolChoiceOptions veya OpenAI.ToolChoiceParam		Hayı
└─ araçları	OpenAI.ToolsArray	Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Siz parametresini ayarlayarak tool_choice hangi aracın kullanılacağını belirtebilir. Aşağıdaki araç kategorilerini destekliyoruz: - Yerleşik araçlar: OpenAI tarafından sağlanan ve işlevselliği genişleten araçlar modelin yetenekleri, örneğin web arama veya file search. Hakkında daha fazla bilgi edinin yerleşik araçlar. - MCP Araçları: Özel MCP sunucuları aracılığıyla üçüncü taraf sistemlerle tümleştirmeler veya Google Drive ve SharePoint gibi önceden tanımlanmış bağlayıcılar. Hakkında daha fazla bilgi edinin MCP Araçları. - İşlev çağrıları (özel araçlar): Sizin tanımladığınız işlevler, modelin kesin olarak yazılan bağımsız değişkenlerle kendi kodunuzu çağırmasını sağlama ve çıkışlarını seçin. Hakkında daha fazla bilgi edinin fonksiyon çağrısı. Ayrıca şunları da kullanabilirsiniz: kendi kodunuzu çağırmak için özel araçlar.	Hayı
└─ top_logprobs	OpenAI.integer (null atanabilir)		Hayı
└─ top_p	OpenAI.numeric (null atanabilir)		Hayı	1
└─ kısaltma	enum	Olası değerler: auto, disabled	Hayı
└─ kullanımı	OpenAI.ResponseUsage	Giriş belirteçleri, çıkış belirteçleri dahil olmak üzere belirteç kullanım ayrıntılarını temsil eder. çıkış belirteçlerinin ve kullanılan toplam belirteçlerin dökümü.	Hayı
└─ kullanıcı	dize (kullanım dışı)	Bu alan ve safety_identifierile prompt_cache_key değiştiriliyor. Bunun yerine önbelleğe alma iyileştirmelerini korumak için kullanın prompt_cache_key . Son kullanıcılarınız için kararlı bir tanımlayıcı. Benzer istekleri daha iyi demetleyerek önbellek isabet oranlarını artırmak ve OpenAI'nin kötüye kullanımı algılayıp önlemesine yardımcı olmak için kullanılır. Daha fazla bilgi edinin.	Hayı
sequence_number	OpenAI.integer		Evet
type	enum	Olayın türü. Her zaman response.in_progress. Olası değerler: response.in_progress	Evet

OpenAI.ResponseIncompleteDetails

İsim	Türü	Description	Gerekli	Varsayılan
sebep	enum	Olası değerler: max_output_tokens, content_filter	Hayı

OpenAI.ResponseIncompleteEvent

Yanıt eksik olduğunda yayılan bir olay.

İsim	Türü	Description	Gerekli	Varsayılan
yanıt	OpenAI.Response		Evet
└─ agent_reference	AgentReference (null atanabilir)	Bu yanıt için kullanılan aracı	Evet
└─ arka plan	boole değeri (null atanabilir)		Hayı
└─ completed_at	integer (null atanabilir)		Hayı
└─ konuşma	OpenAI.ConversationReference (null atanabilir)	Bu yanıtın ait olduğu konuşma. Bu yanıttaki giriş öğeleri ve çıkış öğeleri bu konuşmaya otomatik olarak eklendi.	Hayı
└─ oluşturulma_tarihi	tamsayı	Bu Yanıtın oluşturulduğu unix zaman damgası (saniye).	Evet
└─ hata	OpenAI.ResponseError (null atanabilir)	Model yanıt oluşturamadığında döndürülen bir hata nesnesi.	Evet
└─ kimlik	String	Bu Yanıt için benzersiz tanımlayıcı.	Evet
└─ eksik_bilgiler	OpenAI.ResponseIncompleteDetails (null atanabilir)		Evet
└─ yönerge	OpenAI.InputItem dizesi veya dizisi (null atanabilir)		Evet
└─ maksimum_çıkış_jetonları	OpenAI.integer (null atanabilir)		Hayı
└─ maksimum araç çağrıları	OpenAI.integer (null atanabilir)		Hayı
└─ meta veriler	OpenAI.Metadata (null atanabilir)	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Hayı
└─ modeli	String	Bu yanıtın oluşturulması için kullanılacak model dağıtımı.	Hayı
└─ nesne	enum	Bu kaynağın nesne türü - her zaman response olarak ayarlanır. Olası değerler: response	Evet
└─ çıkış	OpenAI.OutputItem dizisi	Model tarafından oluşturulan içerik öğeleri dizisi. - Dizideki output öğelerin uzunluğu ve sırası bağlıdır modelin yanıtı üzerinde. - Dizideki output ilk öğeye erişmek yerine ve tarafından oluşturulan içeriğe sahip bir assistant ileti olduğunu varsayarsak modeli dikkate alarak output_text özelliğini kullanmayı düşünebilirsiniz. SDK'larda desteklenir.	Evet
└─ çıktı_metin	dize (null atanabilir)		Hayı
└─ paralel_arac_cagrilari	Boolean	Modelin araç çağrılarını paralel olarak çalıştırmasına izin verilip verilmeyeceği.	Evet	Doğru
└─ önceki_cevap_id	dize (null atanabilir)		Hayı
└─ istemi	OpenAI.Prompt	bir istem şablonuna ve değişkenlerine başvuru. Daha fazla bilgi edinin.	Hayı
└─ prompt_cache_key	String	OpenAI tarafından önbellek isabet hızlarınızı iyileştirmek amacıyla benzer isteklere yönelik yanıtları önbelleğe almak için kullanılır. user alanını değiştirir. Daha fazla bilgi edinin.	Hayı
└─ prompt_cache_retention	enum	Olası değerler: in-memory, 24h	Hayı
└─ akıl yürütme	OpenAI.Reasoning (null atanabilir)	yalnızca gpt-5 ve o serisi modeller Için yapılandırma seçenekleri mantıp modelleri.	Hayı
└─ safety_identifier	String	OpenAI'nin kullanım ilkelerini ihlal eden uygulamanızın kullanıcılarını algılamaya yardımcı olmak için kullanılan kararlı tanımlayıcı. Kimlikler, her kullanıcıyı benzersiz olarak tanımlayan bir dize olmalıdır. Bize herhangi bir tanımlayıcı bilgi göndermemek için kullanıcı adını veya e-posta adresini karma olarak kullanmanızı öneririz. Daha fazla bilgi edinin.	Hayı
└─ service_tier	OpenAI.ServiceTier	İsteğin sunulması için kullanılan işleme türünü belirtir. - 'Otomatik' olarak ayarlanırsa, talep Project ayarlarında hizmet katmanı yapılandırılmış şekilde işlenecektir. Başka bir şekilde yapılandırmadıkça, Project 'default' seçeneğini kullanır. - 'varsayılan' olarak ayarlanırsa, istek seçilen model için standart fiyatlandırma ve performansla işlenir. - 'flex' veya 'öncelikli' olarak ayarlanırsa, talep ilgili hizmet katmanıyla işlenecektir. - Ayarlanmadığında, varsayılan davranış 'auto' şeklindedir. service_tier Parametre ayarlandığında, yanıt gövdesi isteğe hizmet etmek için kullanılan işleme moduna göre değeri içerirservice_tier. Bu yanıt değeri, parametresindeki değerden farklı olabilir.	Hayı
└─ durumu	enum	Yanıt oluşturma durumu. , , completed' lerden failedbiri in_progress, cancelled, queued veya incomplete. Olası değerler: completed, failed, in_progress, cancelled, , queued, incomplete	Hayı
└─ sıcaklık	OpenAI.numeric (null atanabilir)		Hayı	1
└─ metin	OpenAI.ResponseTextParam	Modelden metin yanıtı için yapılandırma seçenekleri. Düz olabilir metin veya yapılandırılmış JSON verileri. Daha fazla bilgi edinin: - Metin girişleri ve çıktıları - Yapılandırılmış Çıktılar	Hayı
└─ araç seçimi	OpenAI.ToolChoiceOptions veya OpenAI.ToolChoiceParam		Hayı
└─ araçları	OpenAI.ToolsArray	Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Siz parametresini ayarlayarak tool_choice hangi aracın kullanılacağını belirtebilir. Aşağıdaki araç kategorilerini destekliyoruz: - Yerleşik araçlar: OpenAI tarafından sağlanan ve işlevselliği genişleten araçlar modelin yetenekleri, örneğin web arama veya file search. Hakkında daha fazla bilgi edinin yerleşik araçlar. - MCP Araçları: Özel MCP sunucuları aracılığıyla üçüncü taraf sistemlerle tümleştirmeler veya Google Drive ve SharePoint gibi önceden tanımlanmış bağlayıcılar. Hakkında daha fazla bilgi edinin MCP Araçları. - İşlev çağrıları (özel araçlar): Sizin tanımladığınız işlevler, modelin kesin olarak yazılan bağımsız değişkenlerle kendi kodunuzu çağırmasını sağlama ve çıkışlarını seçin. Hakkında daha fazla bilgi edinin fonksiyon çağrısı. Ayrıca şunları da kullanabilirsiniz: kendi kodunuzu çağırmak için özel araçlar.	Hayı
└─ top_logprobs	OpenAI.integer (null atanabilir)		Hayı
└─ top_p	OpenAI.numeric (null atanabilir)		Hayı	1
└─ kısaltma	enum	Olası değerler: auto, disabled	Hayı
└─ kullanımı	OpenAI.ResponseUsage	Giriş belirteçleri, çıkış belirteçleri dahil olmak üzere belirteç kullanım ayrıntılarını temsil eder. çıkış belirteçlerinin ve kullanılan toplam belirteçlerin dökümü.	Hayı
└─ kullanıcı	dize (kullanım dışı)	Bu alan ve safety_identifierile prompt_cache_key değiştiriliyor. Bunun yerine önbelleğe alma iyileştirmelerini korumak için kullanın prompt_cache_key . Son kullanıcılarınız için kararlı bir tanımlayıcı. Benzer istekleri daha iyi demetleyerek önbellek isabet oranlarını artırmak ve OpenAI'nin kötüye kullanımı algılayıp önlemesine yardımcı olmak için kullanılır. Daha fazla bilgi edinin.	Hayı
sequence_number	OpenAI.integer		Evet
type	enum	Olayın türü. Her zaman response.incomplete. Olası değerler: response.incomplete	Evet

OpenAI.ResponseLogProb

Logprob, modelin dizideki belirli bir konumda belirli bir belirteci üretmeye atayan logaritmik olasılıktır. Daha az negatif (daha yüksek) logprob değerleri, bu belirteç seçiminde model güvenilirliğinin daha yüksek olduğunu gösterir.

İsim	Türü	Description	Gerekli	Varsayılan
logprob	OpenAI.numeric		Evet
token	String	Olası bir metin belirteci.	Evet
top_logprobs	OpenAI.ResponseLogProbTopLogprobs dizisi	En olası 20 belirtecin günlük olasılığı.	Hayı

OpenAI.ResponseLogProbTopLogprobs

İsim	Türü	Description	Gerekli	Varsayılan
logprob	OpenAI.numeric		Hayı
token	String		Hayı

OpenAI.ResponseMCPCallArgumentsDeltaEvent

MCP araç çağrısının bağımsız değişkenlerinde delta (kısmi güncelleştirme) olduğunda gerçekleşir.

İsim	Türü	Description	Gerekli	Varsayılan
delta	String	MCP araç çağrısı için bağımsız değişkenlere yönelik kısmi güncelleştirmeyi içeren bir JSON dizesi.	Evet
item_id	String	İşlenen MCP aracı çağrı öğesinin benzersiz tanımlayıcısı.	Evet
output_index	OpenAI.integer		Evet
sequence_number	OpenAI.integer		Evet
type	enum	Olayın türü. Her zaman 'response.mcp_call_arguments.delta'. Olası değerler: response.mcp_call_arguments.delta	Evet

OpenAI.ResponseMCPCallArgumentsDoneEvent

Bir MCP araç çağrısı için bağımsız değişkenler sonlandırıldığında oluşur.

İsim	Türü	Description	Gerekli	Varsayılan
arguments	String	MCP araç çağrısı için son haline getirilmiş bağımsız değişkenleri içeren bir JSON dizesi.	Evet
item_id	String	İşlenen MCP aracı çağrı öğesinin benzersiz tanımlayıcısı.	Evet
output_index	OpenAI.integer		Evet
sequence_number	OpenAI.integer		Evet
type	enum	Olayın türü. Her zaman 'response.mcp_call_arguments.bitti'. Olası değerler: response.mcp_call_arguments.done	Evet

OpenAI.ResponseMCPCallCompletedEvent

BIR MCP araç çağrısı başarıyla tamamlandığında yayılır.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	Tamamlanan MCP aracı çağrı öğesinin kimliği.	Evet
output_index	OpenAI.integer		Evet
sequence_number	OpenAI.integer		Evet
type	enum	Olayın türü. Her zaman 'response.mcp_call.completed'. Olası değerler: response.mcp_call.completed	Evet

OpenAI.ResponseMCPCallFailedEvent

Bir MCP aracı çağrısının başarısız olması durumunda yayımlanır.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	Başarısız olan MCP aracı çağrı öğesinin kimliği.	Evet
output_index	OpenAI.integer		Evet
sequence_number	OpenAI.integer		Evet
type	enum	Olayın türü. 'sonuç her zaman 'response.mcp_call.failed' olur. Olası değerler: response.mcp_call.failed	Evet

OpenAI.ResponseMCPCallInProgressEvent

Bir MCP araç çağrısı devam ederken tetiklenir.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	İşlenen MCP aracı çağrı öğesinin benzersiz tanımlayıcısı.	Evet
output_index	OpenAI.integer		Evet
sequence_number	OpenAI.integer		Evet
type	enum	Olayın türü. Her zaman 'response.mcp_call.in_progress'. Olası değerler: response.mcp_call.in_progress	Evet

OpenAI.ResponseMCPListToolsCompletedEvent

Kullanılabilir MCP araçlarının listesi başarıyla alındığında tetiklenir.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	Bu çıkışı oluşturan MCP aracı çağrı öğesinin kimliği.	Evet
output_index	OpenAI.integer		Evet
sequence_number	OpenAI.integer		Evet
type	enum	Olayın türü. Her zaman 'response.mcp_list_tools.completed'. Olası değerler: response.mcp_list_tools.completed	Evet

OpenAI.ResponseMCPListToolsFailedEvent

Kullanılabilir MCP araçlarını listeleme girişimi başarısız olduğunda ortaya çıkar.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	Başarısız olan MCP aracı çağrı öğesinin kimliği.	Evet
output_index	OpenAI.integer		Evet
sequence_number	OpenAI.integer		Evet
type	enum	Olayın türü. Her zaman 'response.mcp_list_tools.başarısız'. Olası değerler: response.mcp_list_tools.failed	Evet

OpenAI.ResponseMCPListToolsInProgressEvent

Sistem, kullanılabilir MCP araçlarının listesini alırken tetiklenir.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	İşlenmekte olan MCP aracı çağrı öğesinin kimliği.	Evet
output_index	OpenAI.integer		Evet
sequence_number	OpenAI.integer		Evet
type	enum	Olayın türü. Her zaman 'response.mcp_list_tools.in_progress'. Olası değerler: response.mcp_list_tools.in_progress	Evet

OpenAI.ResponseOutputItemAddedEvent

Yeni bir çıkış öğesi eklendiğinde gönderilir.

İsim	Türü	Description	Gerekli	Varsayılan
öğe	OpenAI.OutputItem		Evet
└─ agent_reference	AgentReference	Öğeyi oluşturan aracı.	Hayı
└─ response_id	String	Öğenin oluşturulduğu yanıt.	Hayı
└─ türü	OpenAI.OutputItemType		Evet
output_index	OpenAI.integer		Evet
sequence_number	OpenAI.integer		Evet
type	enum	Olayın türü. Her zaman response.output_item.added. Olası değerler: response.output_item.added	Evet

OpenAI.ResponseOutputItemDoneEvent

Çıktı öğesi tamamlandı olarak işaretlendiğinde yayılır.

İsim	Türü	Description	Gerekli	Varsayılan
öğe	OpenAI.OutputItem		Evet
└─ agent_reference	AgentReference	Öğeyi oluşturan aracı.	Hayı
└─ response_id	String	Öğenin oluşturulduğu yanıt.	Hayı
└─ türü	OpenAI.OutputItemType		Evet
output_index	OpenAI.integer		Evet
sequence_number	OpenAI.integer		Evet
type	enum	Olayın türü. Her zaman response.output_item.done. Olası değerler: response.output_item.done	Evet

OpenAI.ResponseOutputTextAnnotationAddedEvent

Çıkış metni içeriğine ek açıklama eklendiğinde yayılır.

İsim	Türü	Description	Gerekli	Varsayılan
annotation	OpenAI.Annotation	Çıkış metninin yayılma alanına uygulanan bir ek açıklama.	Evet
└─ türü	OpenAI.AnnotationType		Evet
annotation_index	OpenAI.integer		Evet
content_index	OpenAI.integer		Evet
item_id	String	Ek açıklamanın eklendiği öğenin benzersiz tanımlayıcısı.	Evet
output_index	OpenAI.integer		Evet
sequence_number	OpenAI.integer		Evet
type	enum	Olayın türü. Her zaman 'response.output_text.annotation.added'. Olası değerler: response.output_text.annotation.added	Evet

OpenAI.ResponsePromptVariables

İsteminizde değişkenlerin yerine kullanılacak isteğe bağlı değer eşlemesi. Değiştirme değerleri dizeler veya görüntüler veya dosyalar gibi diğer Yanıt giriş türleri olabilir.

Tür: nesne

OpenAI.ResponseQueuedEvent

Bir yanıt kuyruğa alınıp işlenmeyi beklediğinde gönderilir.

İsim	Türü	Description	Gerekli	Varsayılan
yanıt	OpenAI.Response		Evet
└─ agent_reference	AgentReference (null atanabilir)	Bu yanıt için kullanılan aracı	Evet
└─ arka plan	boole değeri (null atanabilir)		Hayı
└─ completed_at	integer (null atanabilir)		Hayı
└─ konuşma	OpenAI.ConversationReference (null atanabilir)	Bu yanıtın ait olduğu konuşma. Bu yanıttaki giriş öğeleri ve çıkış öğeleri bu konuşmaya otomatik olarak eklendi.	Hayı
└─ oluşturulma_tarihi	tamsayı	Bu Yanıtın oluşturulduğu unix zaman damgası (saniye).	Evet
└─ hata	OpenAI.ResponseError (null atanabilir)	Model yanıt oluşturamadığında döndürülen bir hata nesnesi.	Evet
└─ kimlik	String	Bu Yanıt için benzersiz tanımlayıcı.	Evet
└─ eksik_bilgiler	OpenAI.ResponseIncompleteDetails (null atanabilir)		Evet
└─ yönerge	OpenAI.InputItem dizesi veya dizisi (null atanabilir)		Evet
└─ maksimum_çıkış_jetonları	OpenAI.integer (null atanabilir)		Hayı
└─ maksimum araç çağrıları	OpenAI.integer (null atanabilir)		Hayı
└─ meta veriler	OpenAI.Metadata (null atanabilir)	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Hayı
└─ modeli	String	Bu yanıtın oluşturulması için kullanılacak model dağıtımı.	Hayı
└─ nesne	enum	Bu kaynağın nesne türü - her zaman response olarak ayarlanır. Olası değerler: response	Evet
└─ çıkış	OpenAI.OutputItem dizisi	Model tarafından oluşturulan içerik öğeleri dizisi. - Dizideki output öğelerin uzunluğu ve sırası bağlıdır modelin yanıtı üzerinde. - Dizideki output ilk öğeye erişmek yerine ve tarafından oluşturulan içeriğe sahip bir assistant ileti olduğunu varsayarsak modeli dikkate alarak output_text özelliğini kullanmayı düşünebilirsiniz. SDK'larda desteklenir.	Evet
└─ çıktı_metin	dize (null atanabilir)		Hayı
└─ paralel_arac_cagrilari	Boolean	Modelin araç çağrılarını paralel olarak çalıştırmasına izin verilip verilmeyeceği.	Evet	Doğru
└─ önceki_cevap_id	dize (null atanabilir)		Hayı
└─ istemi	OpenAI.Prompt	bir istem şablonuna ve değişkenlerine başvuru. Daha fazla bilgi edinin.	Hayı
└─ prompt_cache_key	String	OpenAI tarafından önbellek isabet hızlarınızı iyileştirmek amacıyla benzer isteklere yönelik yanıtları önbelleğe almak için kullanılır. user alanını değiştirir. Daha fazla bilgi edinin.	Hayı
└─ prompt_cache_retention	enum	Olası değerler: in-memory, 24h	Hayı
└─ akıl yürütme	OpenAI.Reasoning (null atanabilir)	yalnızca gpt-5 ve o serisi modeller Için yapılandırma seçenekleri mantıp modelleri.	Hayı
└─ safety_identifier	String	OpenAI'nin kullanım ilkelerini ihlal eden uygulamanızın kullanıcılarını algılamaya yardımcı olmak için kullanılan kararlı tanımlayıcı. Kimlikler, her kullanıcıyı benzersiz olarak tanımlayan bir dize olmalıdır. Bize herhangi bir tanımlayıcı bilgi göndermemek için kullanıcı adını veya e-posta adresini karma olarak kullanmanızı öneririz. Daha fazla bilgi edinin.	Hayı
└─ service_tier	OpenAI.ServiceTier	İsteğin sunulması için kullanılan işleme türünü belirtir. - 'Otomatik' olarak ayarlanırsa, talep Project ayarlarında hizmet katmanı yapılandırılmış şekilde işlenecektir. Başka bir şekilde yapılandırmadıkça, Project 'default' seçeneğini kullanır. - 'varsayılan' olarak ayarlanırsa, istek seçilen model için standart fiyatlandırma ve performansla işlenir. - 'flex' veya 'öncelikli' olarak ayarlanırsa, talep ilgili hizmet katmanıyla işlenecektir. - Ayarlanmadığında, varsayılan davranış 'auto' şeklindedir. service_tier Parametre ayarlandığında, yanıt gövdesi isteğe hizmet etmek için kullanılan işleme moduna göre değeri içerirservice_tier. Bu yanıt değeri, parametresindeki değerden farklı olabilir.	Hayı
└─ durumu	enum	Yanıt oluşturma durumu. , , completed' lerden failedbiri in_progress, cancelled, queued veya incomplete. Olası değerler: completed, failed, in_progress, cancelled, , queued, incomplete	Hayı
└─ sıcaklık	OpenAI.numeric (null atanabilir)		Hayı	1
└─ metin	OpenAI.ResponseTextParam	Modelden metin yanıtı için yapılandırma seçenekleri. Düz olabilir metin veya yapılandırılmış JSON verileri. Daha fazla bilgi edinin: - Metin girişleri ve çıktıları - Yapılandırılmış Çıktılar	Hayı
└─ araç seçimi	OpenAI.ToolChoiceOptions veya OpenAI.ToolChoiceParam		Hayı
└─ araçları	OpenAI.ToolsArray	Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Siz parametresini ayarlayarak tool_choice hangi aracın kullanılacağını belirtebilir. Aşağıdaki araç kategorilerini destekliyoruz: - Yerleşik araçlar: OpenAI tarafından sağlanan ve işlevselliği genişleten araçlar modelin yetenekleri, örneğin web arama veya file search. Hakkında daha fazla bilgi edinin yerleşik araçlar. - MCP Araçları: Özel MCP sunucuları aracılığıyla üçüncü taraf sistemlerle tümleştirmeler veya Google Drive ve SharePoint gibi önceden tanımlanmış bağlayıcılar. Hakkında daha fazla bilgi edinin MCP Araçları. - İşlev çağrıları (özel araçlar): Sizin tanımladığınız işlevler, modelin kesin olarak yazılan bağımsız değişkenlerle kendi kodunuzu çağırmasını sağlama ve çıkışlarını seçin. Hakkında daha fazla bilgi edinin fonksiyon çağrısı. Ayrıca şunları da kullanabilirsiniz: kendi kodunuzu çağırmak için özel araçlar.	Hayı
└─ top_logprobs	OpenAI.integer (null atanabilir)		Hayı
└─ top_p	OpenAI.numeric (null atanabilir)		Hayı	1
└─ kısaltma	enum	Olası değerler: auto, disabled	Hayı
└─ kullanımı	OpenAI.ResponseUsage	Giriş belirteçleri, çıkış belirteçleri dahil olmak üzere belirteç kullanım ayrıntılarını temsil eder. çıkış belirteçlerinin ve kullanılan toplam belirteçlerin dökümü.	Hayı
└─ kullanıcı	dize (kullanım dışı)	Bu alan ve safety_identifierile prompt_cache_key değiştiriliyor. Bunun yerine önbelleğe alma iyileştirmelerini korumak için kullanın prompt_cache_key . Son kullanıcılarınız için kararlı bir tanımlayıcı. Benzer istekleri daha iyi demetleyerek önbellek isabet oranlarını artırmak ve OpenAI'nin kötüye kullanımı algılayıp önlemesine yardımcı olmak için kullanılır. Daha fazla bilgi edinin.	Hayı
sequence_number	OpenAI.integer		Evet
type	enum	Olayın türü. Her zaman 'response.queued'. Olası değerler: response.queued	Evet

OpenAI.ResponseReasoningSummaryPartAddedEvent

Yeni bir akıl yürütme özeti bölümü eklendiğinde yayımlanır.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	Bu özet bölümün ilişkili olduğu öğenin kimliği.	Evet
output_index	OpenAI.integer		Evet
parça	OpenAI.ResponseReasoningSummaryPartAddedEventPart		Evet
└─ metin	String		Evet
└─ türü	enum	Olası değerler: summary_text	Evet
sequence_number	OpenAI.integer		Evet
summary_index	OpenAI.integer		Evet
type	enum	Olayın türü. Her zaman response.reasoning_summary_part.added. Olası değerler: response.reasoning_summary_part.added	Evet

OpenAI.ResponseReasoningSummaryPartAddedEventPart

İsim	Türü	Description	Gerekli	Varsayılan
text	String		Evet
type	enum	Olası değerler: summary_text	Evet

OpenAI.ResponseReasoningSummaryPartDoneEvent

Bir akıl yürütme özeti bölümü tamamlandığında gönderilir.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	Bu özet bölümün ilişkili olduğu öğenin kimliği.	Evet
output_index	OpenAI.integer		Evet
parça	OpenAI.ResponseReasoningSummaryPartDoneEventPart		Evet
└─ metin	String		Evet
└─ türü	enum	Olası değerler: summary_text	Evet
sequence_number	OpenAI.integer		Evet
summary_index	OpenAI.integer		Evet
type	enum	Olayın türü. Her zaman response.reasoning_summary_part.done. Olası değerler: response.reasoning_summary_part.done	Evet

OpenAI.ResponseReasoningSummaryPartDoneEventPart

İsim	Türü	Description	Gerekli	Varsayılan
text	String		Evet
type	enum	Olası değerler: summary_text	Evet

OpenAI.ResponseReasoningSummaryTextDeltaEvent

Bir muhakeme özeti metnine delta eklendiğinde oluşur.

İsim	Türü	Description	Gerekli	Varsayılan
delta	String	Özete eklenen metin deltası.	Evet
item_id	String	Bu özet metin deltasının ilişkili olduğu öğenin kimliği.	Evet
output_index	OpenAI.integer		Evet
sequence_number	OpenAI.integer		Evet
summary_index	OpenAI.integer		Evet
type	enum	Olayın türü. Her zaman response.reasoning_summary_text.delta. Olası değerler: response.reasoning_summary_text.delta	Evet

OpenAI.ResponseReasoningSummaryTextDoneEvent

Bir akıl yürütme özeti metni tamamlandığında yayılır.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	Bu özet metnin ilişkili olduğu öğenin kimliği.	Evet
output_index	OpenAI.integer		Evet
sequence_number	OpenAI.integer		Evet
summary_index	OpenAI.integer		Evet
text	String	Tamamlanan akıl yürütme özetinin tam metni.	Evet
type	enum	Olayın türü. Her zaman response.reasoning_summary_text.done. Olası değerler: response.reasoning_summary_text.done	Evet

OpenAI.ResponseReasoningTextDeltaEvent

Bir muhakeme metnine delta eklendiğinde yayılır.

İsim	Türü	Description	Gerekli	Varsayılan
content_index	OpenAI.integer		Evet
delta	String	Muhakeme içeriğine eklenen metin deltası.	Evet
item_id	String	Bu muhakeme metni deltasının ilişkili olduğu öğenin kimliği.	Evet
output_index	OpenAI.integer		Evet
sequence_number	OpenAI.integer		Evet
type	enum	Olayın türü. Her zaman response.reasoning_text.delta. Olası değerler: response.reasoning_text.delta	Evet

OpenAI.ResponseReasoningTextDoneEvent

Bir akıl yürütme metni tamamlandığında yayılır.

İsim	Türü	Description	Gerekli	Varsayılan
content_index	OpenAI.integer		Evet
item_id	String	Bu muhakeme metninin ilişkili olduğu öğenin kimliği.	Evet
output_index	OpenAI.integer		Evet
sequence_number	OpenAI.integer		Evet
text	String	Tamamlanmış muhakeme içeriğinin tam metni.	Evet
type	enum	Olayın türü. Her zaman response.reasoning_text.done. Olası değerler: response.reasoning_text.done	Evet

OpenAI.ResponseRefusalDeltaEvent

Kısmi bir reddetme metni olduğunda yayılır.

İsim	Türü	Description	Gerekli	Varsayılan
content_index	OpenAI.integer		Evet
delta	String	Eklenen ret metni.	Evet
item_id	String	Reddetme metninin eklendiği çıkış öğesinin kimliği.	Evet
output_index	OpenAI.integer		Evet
sequence_number	OpenAI.integer		Evet
type	enum	Olayın türü. Her zaman response.refusal.delta. Olası değerler: response.refusal.delta	Evet

OpenAI.ResponseRefusalDoneEvent

Reddeden metin sonlandırıldığında yayılır.

İsim	Türü	Description	Gerekli	Varsayılan
content_index	OpenAI.integer		Evet
item_id	String	Sonlandırılan reddetme metninin ait olduğu çıkış öğesinin kimliği.	Evet
output_index	OpenAI.integer		Evet
Ret	String	Kesinleştirilen reddetme metni.	Evet
sequence_number	OpenAI.integer		Evet
type	enum	Olayın türü. Her zaman response.refusal.done. Olası değerler: response.refusal.done	Evet

OpenAI.ResponseStreamOptions

Akış yanıtları için seçenekler. Bunu yalnızca ayarladığınızda ayarlayın stream: true.

İsim	Türü	Description	Gerekli	Varsayılan
include_obfuscation	Boolean	True olduğunda, akış gizleme etkinleştirilir. Akış gizleme eklemeleri değişiklik olaylarının akışındaki bir obfuscation alana rastgele karakterler yük boyutlarını belirli yan kanal saldırılarına karşı bir azaltma olarak normalleştirin. Bu gizleme alanları varsayılan olarak eklenir, ancak küçük bir miktar eklenir veri akışı için ek yük. Şunu ayarlayabilirsiniz:include_obfuscation arasında ağ bağlantılarına güveniyorsanız bant genişliğini iyileştirmek için false uygulamanızı ve OpenAI API'sini seçin.	Hayı

OpenAI.ResponseTextDeltaEvent

İlave bir metin deltası olduğunda oluşur.

İsim	Türü	Description	Gerekli	Varsayılan
content_index	OpenAI.integer		Evet
delta	String	Eklenen metin deltası.	Evet
item_id	String	Metin deltasının eklendiği çıkış öğesinin kimliği.	Evet
logprobs	OpenAI.ResponseLogProb dizisi	Deltadaki belirteçlerin günlük olasılıkları.	Evet
output_index	OpenAI.integer		Evet
sequence_number	OpenAI.integer		Evet
type	enum	Olayın türü. Her zaman response.output_text.delta. Olası değerler: response.output_text.delta	Evet

OpenAI.ResponseTextDoneEvent

Metin içeriği sonlandırıldığında yayınlanır.

İsim	Türü	Description	Gerekli	Varsayılan
content_index	OpenAI.integer		Evet
item_id	String	Metin içeriğinin sonlandırıldığı çıkış öğesinin kimliği.	Evet
logprobs	OpenAI.ResponseLogProb dizisi	Deltadaki belirteçlerin günlük olasılıkları.	Evet
output_index	OpenAI.integer		Evet
sequence_number	OpenAI.integer		Evet
text	String	Son haline getirilmiş metin içeriği.	Evet
type	enum	Olayın türü. Her zaman response.output_text.done. Olası değerler: response.output_text.done	Evet

OpenAI.ResponseTextParam

Modelden metin yanıtı için yapılandırma seçenekleri. Düz metin veya yapılandırılmış JSON verileri olabilir. Daha fazla bilgi edinin:

• Metin girişleri ve çıktıları
• Yapılandırılmış Çıktılar

İsim	Türü	Description	Gerekli	Varsayılan
format	OpenAI.TextResponseFormatConfiguration	Modelin çıkış yapması gereken biçimi belirten bir nesne. Yapılandırma { "type": "json_schema" } , Yapılandırılmış Çıkışları etkinleştirir, modelin sağlanan JSON şemanızla eşleşmesini sağlar. Daha fazla bilgi için Varsayılan biçim { "type": "text" } ek seçenek yoktur. *gpt-4o ve daha yeni modeller için önerilmez:** { "type": "json_object" } ayarı, eski JSON modunu etkinleştirir. modelin oluşturduğu iletinin geçerli JSON olduğundan emin olur. json_schema’ı kullanma Bu özelliği destekleyen modeller için tercih edilir.	Hayı
Ayrıntı	OpenAI.Verbosity	Modelin yanıtının çok fazla olduğunu sınırlar. Daha düşük değerler, daha kısa yanıtlar elde ederken, daha yüksek değerler daha ayrıntılı yanıtlara neden olur. Şu anda desteklenen değerler , lowve medium'tirhigh.	Hayı

OpenAI.ResponseUsage

Giriş belirteçleri, çıkış belirteçleri, çıkış belirteçlerinin dökümü ve kullanılan toplam belirteçler dahil olmak üzere belirteç kullanım ayrıntılarını temsil eder.

İsim	Türü	Description	Gerekli	Varsayılan
input_tokens	OpenAI.integer		Evet
input_tokens_details	OpenAI.ResponseUsageInputTokensDetails		Evet
└─ önbelleğe alınmış jetonlar	OpenAI.integer		Evet
output_tokens	OpenAI.integer		Evet
output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails		Evet
└─ akıl yürütme_tokenlar	OpenAI.integer		Evet
total_tokens	OpenAI.integer		Evet

OpenAI.ResponseUsageInputTokensDetails

İsim	Türü	Description	Gerekli	Varsayılan
cached_tokens	OpenAI.integer		Evet

OpenAI.ResponseUsageOutputTokensDetails

İsim	Türü	Description	Gerekli	Varsayılan
akıl yürütme birimleri	OpenAI.integer		Evet

OpenAI.ResponseWebSearchCallCompletedEvent

Web araması araması tamamlandığında gönderilir.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	Web arama çağrısıyla ilişkili çıkış öğesinin benzersiz kimliği.	Evet
output_index	OpenAI.integer		Evet
sequence_number	OpenAI.integer		Evet
type	enum	Olayın türü. Her zaman response.web_search_call.completed. Olası değerler: response.web_search_call.completed	Evet

OpenAI.ResponseWebSearchCallInProgressEvent

Bir web arama çağrısı başlatıldığında yayılır.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	Web arama çağrısıyla ilişkili çıkış öğesinin benzersiz kimliği.	Evet
output_index	OpenAI.integer		Evet
sequence_number	OpenAI.integer		Evet
type	enum	Olayın türü. Her zaman response.web_search_call.in_progress. Olası değerler: response.web_search_call.in_progress	Evet

OpenAI.ResponseWebSearchCallSearchingEvent

Bir web arama çağrısı yürütülürken gönderilir.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	Web arama çağrısıyla ilişkili çıkış öğesinin benzersiz kimliği.	Evet
output_index	OpenAI.integer		Evet
sequence_number	OpenAI.integer		Evet
type	enum	Olayın türü. Her zaman response.web_search_call.searching. Olası değerler: response.web_search_call.searching	Evet

OpenAI.Ekran Görüntüsü

Ekran görüntüsü alma işlemi.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olay türünü belirtir. Ekran görüntüsü eylemi için bu özellik her zaman screenshot olarak ayarlanır. Olası değerler: screenshot	Evet

OpenAI.Scroll

Kaydırma eylemi.

İsim	Türü	Description	Gerekli	Varsayılan
scroll_x	OpenAI.integer		Evet
scroll_y	OpenAI.integer		Evet
type	enum	Olay türünü belirtir. Kaydırma eylemi için bu özellik her zaman scroll olarak ayarlanır. Olası değerler: scroll	Evet
x	OpenAI.integer		Evet
y	OpenAI.integer		Evet

OpenAI.SearchContextSize

Mülkiyet	Değer
Türü	String
Değerler	low medium high

OpenAI.ServiceTier

İsteğin sunulması için kullanılan işleme türünü belirtir.

• 'Otomatik' olarak ayarlanırsa, talep Project ayarlarında hizmet seviyesi yapılandırılarak işlenecektir. Başka bir şekilde yapılandırmadıkça, Project 'default' seçeneğini kullanır.
• 'varsayılan' olarak ayarlanırsa istek, seçilen model için standart fiyatlandırma ve performansla işlenir.
• Eğer 'flex' veya 'öncelikli' olarak ayarlanırsa, talep ilgili hizmet katmanıyla işlenecektir.
• Ayarlanmadığında, varsayılan davranış 'auto' şeklindedir. service_tier Parametre ayarlandığında, yanıt gövdesi isteğe hizmet etmek için kullanılan işleme moduna göre değeri içerirservice_tier. Bu yanıt değeri, parametresindeki değerden farklı olabilir.

Mülkiyet	Değer
Türü	String
Nullable	Evet
Değerler	auto default flex scale priority

OpenAI.SpecificApplyPatchParam

Bir araç çağrısı yürütürken modeli apply_patch aracını çağırmaya zorlar.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Çağrılacak araç. Her zaman apply_patch. Olası değerler: apply_patch	Evet

OpenAI.SpecificFunctionShellParam

Bir araç çağrısı gerektiğinde modeli kabuk aracını çağırmaya zorlar.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Çağrılacak araç. Her zaman shell. Olası değerler: shell	Evet

OpenAI.Summary

Modelden özet metin.

İsim	Türü	Description	Gerekli	Varsayılan
text	String	Modelden şimdiye kadar elde edilen mantık çıkarlarının özeti.	Evet
type	enum	Nesnenin türü. Her zaman summary_text. Olası değerler: summary_text	Evet

OpenAI.SummaryTextContent

Modelden özet metin.

İsim	Türü	Description	Gerekli	Varsayılan
text	String	Modelden şimdiye kadar elde edilen mantık çıkarlarının özeti.	Evet
type	enum	Nesnenin türü. Her zaman summary_text. Olası değerler: summary_text	Evet

OpenAI.TextContent

Metin içeriği.

İsim	Türü	Description	Gerekli	Varsayılan
text	String		Evet
type	enum	Olası değerler: text	Evet

OpenAI.TextResponseFormatConfiguration

Modelin çıkış yapması gereken biçimi belirten bir nesne. Yapılandırma { "type": "json_schema" } , modelin sağlanan JSON şemanızla eşleşmesini sağlayan Yapılandırılmış Çıkışlar'ı etkinleştirir. Daha fazla bilgi için

Varsayılan biçim { "type": "text" } ek seçenek yoktur. gpt-4o ve daha yeni modeller için önerilmez:* Modelin oluşturduğu mesajın geçerli olmasını sağlayan eski JSON modunu etkinleştirmek için ayar { "type": "json_object" } . Destekleyen modeller için json_schema kullanılması tercih edilir.

OpenAI.TextResponseFormatConfiguration için Ayrıştırıcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
json_schema	OpenAI.TextResponseFormatJsonSchema
text	OpenAI.TextResponseFormatConfigurationResponseFormatText
json_object	OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.TextResponseFormatConfigurationType		Evet

OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject

JSON nesne yanıt biçimi. JSON yanıtları oluşturmanın eski bir yöntemi. Bunu destekleyen modeller için kullanılması json_schema önerilir. Modelin, bir sistem veya kullanıcı mesajı olmadan JSON oluşturmayacağını unutmayın, bunu to do etmelidir.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Tanımlanan yanıt biçiminin türü. Her zaman json_object. Olası değerler: json_object	Evet

OpenAI.TextResponseFormatConfigurationResponseFormatText

Varsayılan yanıt biçimi. Metin yanıtları oluşturmak için kullanılır.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Tanımlanan yanıt biçiminin türü. Her zaman text. Olası değerler: text	Evet

OpenAI.TextResponseFormatConfigurationType

Mülkiyet	Değer
Türü	String
Değerler	text json_schema json_object

OpenAI.TextResponseFormatJsonSchema

JSON Şeması yanıt biçimi. Yapılandırılmış JSON yanıtları oluşturmak için kullanılır. Yapılandırılmış Çıktılar hakkında daha fazla bilgi edinin.

İsim	Türü	Description	Gerekli	Varsayılan
açıklama	String	Model tarafından kullanılan yanıt biçiminin ne için olduğuna dair bir açıklama. Yanıt formatını nasıl belirleyeceğinizi öğrenin.	Hayı
name	String	Yanıt biçiminin adı. a-z, A-Z, 0-9 veya bunları içermelidir alt çizgi ve tirelerden oluşan, maksimum uzunluk 64 karakterdir.	Evet
şema	OpenAI.YanıtFormatıJsonŞemaŞeması	JSON Şeması nesnesi olarak tanımlanan yanıt biçimi şeması. JSON şemaları oluşturmayı buradan öğrenin.	Evet
Sıkı	boole değeri (null atanabilir)		Hayı
type	enum	Tanımlanan yanıt biçiminin türü. Her zaman json_schema. Olası değerler: json_schema	Evet

OpenAI.Tool

Yanıt oluşturmak için kullanılabilecek bir araç.

OpenAI.Tool için Ayırıcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
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

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.ToolType		Evet

OpenAI.ToolChoiceAllowed

Modelde kullanılabilen araçları önceden tanımlanmış bir kümeyle kısıtlar.

İsim	Türü	Description	Gerekli	Varsayılan
modu	enum	Modelde kullanılabilen araçları önceden tanımlanmış bir kümeyle kısıtlar. auto modelin izin verilen araçlar arasından seçim yapmasına ve İleti. required modelin izin verilen araçlardan birini veya daha fazlasını çağırmasını gerektirir. Olası değerler: auto, required	Evet
araçlar	nesne dizisi	Modelin çağırmasına izin verilmesi gereken araç tanımlarının listesi. Yanıtlar API'sinde araç tanımlarının listesi şöyle görünebilir: json<br> [<br> { "type": "function", "name": "get_weather" },<br> { "type": "mcp", "server_label": "deepwiki" },<br> { "type": "image_generation" }<br> ]<br>	Evet
type	enum	İzin verilen araç yapılandırma türü. Her zaman allowed_tools. Olası değerler: allowed_tools	Evet

OpenAI.ToolChoiceCodeInterpreter

Modelin bir yanıt oluşturmak için yerleşik bir araç kullanması gerektiğini gösterir. Yerleşik araçlar hakkında daha fazla bilgi edinin.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olası değerler: code_interpreter	Evet

OpenAI.ToolChoiceComputerUsePreview

Modelin bir yanıt oluşturmak için yerleşik bir araç kullanması gerektiğini gösterir. Yerleşik araçlar hakkında daha fazla bilgi edinin.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olası değerler: computer_use_preview	Evet

OpenAI.ToolChoiceCustom

Modeli belirli bir özel aracı çağırmaya zorlamak için bu seçeneği kullanın.

İsim	Türü	Description	Gerekli	Varsayılan
name	String	Çağrılacak özel aracın adı.	Evet
type	enum	Özel araç çağrısı için türü her zaman customşeklindedir. Olası değerler: custom	Evet

OpenAI.ToolChoiceFileSearch

Modelin bir yanıt oluşturmak için yerleşik bir araç kullanması gerektiğini gösterir. Yerleşik araçlar hakkında daha fazla bilgi edinin.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olası değerler: file_search	Evet

OpenAI.ToolChoiceFunction

Modeli belirli bir işlevi çağırmaya zorlamak için bu seçeneği kullanın.

İsim	Türü	Description	Gerekli	Varsayılan
name	String	Çağrılacak işlevin adı.	Evet
type	enum	İşlev çağrısı için türü her zaman functionşeklindedir. Olası değerler: function	Evet

OpenAI.ToolChoiceImageGeneration

Modelin bir yanıt oluşturmak için yerleşik bir araç kullanması gerektiğini gösterir. Yerleşik araçlar hakkında daha fazla bilgi edinin.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olası değerler: image_generation	Evet

OpenAI.ToolChoiceMCP

Modeli uzak bir MCP sunucusunda belirli bir aracı çağırmaya zorlamak için bu seçeneği kullanın.

İsim	Türü	Description	Gerekli	Varsayılan
name	dize (null atanabilir)		Hayı
sunucu etiketi	String	Kullanılacak MCP sunucusunun etiketi.	Evet
type	enum	MCP araçları için türü her zaman mcpşeklindedir. Olası değerler: mcp	Evet

OpenAI.ToolChoiceOptions

Model tarafından çağrılan aracı (varsa) denetler. none modelin herhangi bir aracı çağırmayacağı ve bunun yerine bir ileti oluşturduğu anlamına gelir. auto modelin ileti oluşturma veya bir veya daha fazla araç çağırma arasında seçim yapabileceğiniz anlamına gelir. required modelin bir veya daha fazla araç çağırması gerektiği anlamına gelir.

Mülkiyet	Değer
Türü	String
Değerler	none auto required

OpenAI.ToolChoiceParam

Modelin yanıt oluştururken kullanılacak aracı (veya araçları) seçmesi gerekir. Modelin hangi araçları çağırabileceğini belirtmek için tools parametresine bakın.

OpenAI.ToolChoiceParam için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
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

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.ToolChoiceParamType		Evet

OpenAI.ToolChoiceParamType

Mülkiyet	Değer
Türü	String
Değerler	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

Modelin bir yanıt oluşturmak için yerleşik bir araç kullanması gerektiğini gösterir. Yerleşik araçlar hakkında daha fazla bilgi edinin.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olası değerler: web_search_preview	Evet

OpenAI.ToolChoiceWebSearchPreview20250311

Modelin bir yanıt oluşturmak için yerleşik bir araç kullanması gerektiğini gösterir. Yerleşik araçlar hakkında daha fazla bilgi edinin.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olası değerler: web_search_preview_2025_03_11	Evet

OpenAI.AraçTürü

Mülkiyet	Değer
Türü	String
Değerler	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

Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Parametresini ayarlayarak tool_choice hangi aracın kullanılacağını belirtebilirsiniz. Aşağıdaki araç kategorilerini destekliyoruz:

• Yerleşik araçlar: OpenAI tarafından sağlanan ve modelin yeteneklerini genişleten araçlar, örneğin web arama veya dosya arama gibi. yerleşik araçlar.
• MCP Araçları: Özel MCP sunucuları veya Google Drive ve SharePoint gibi önceden tanımlanmış bağlayıcılar aracılığıyla üçüncü taraf sistemlerle tümleştirmeler. MCP Tools hakkında daha fazla bilgi edinin.
• İşlev çağrıları (özel araçlar): Sizin tanımladığınız işlevler, modelin kesin olarak yazılan bağımsız değişkenler ve çıkışlarla kendi kodunuzu çağırmasını sağlar. function calling hakkında daha fazla bilgi edinin. Kendi kodunuzu çağırmak için özel araçlar da kullanabilirsiniz.

Dizisi: OpenAI.Tool

OpenAI.TopLogProb

Belirtecin en yüksek günlük olasılığı.

İsim	Türü	Description	Gerekli	Varsayılan
bytes	OpenAI.integer dizisi		Evet
logprob	OpenAI.numeric		Evet
token	String		Evet

OpenAI.Type

Metin yazmak için bir eylem.

İsim	Türü	Description	Gerekli	Varsayılan
text	String	Yazılacak metin.	Evet
type	enum	Olay türünü belirtir. Tür eylemi için bu özellik her zaman type olarak ayarlanır. Olası değerler: type	Evet

OpenAI.UpdateConversationBody

İsim	Türü	Description	Gerekli	Varsayılan
metadata	OpenAI.Metadata (null atanabilir)	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Evet

OpenAI.UrlCitationBody

Model yanıtı oluşturmak için kullanılan bir web kaynağı alıntısı.

İsim	Türü	Description	Gerekli	Varsayılan
end_index	OpenAI.integer		Evet
start_index	OpenAI.integer		Evet
title	String	Web kaynağının başlığı.	Evet
type	enum	URL alıntısının türü. Her zaman url_citation. Olası değerler: url_citation	Evet
url	String	Web kaynağının URL'si.	Evet

OpenAI.VectorStoreFileAttributes

Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, nesne hakkında ek bilgileri yapılandırılmış biçimde depolamak ve API veya pano aracılığıyla nesneleri sorgulamak için yararlı olabilir. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler, uzunluğu en fazla 512 karakter, boole veya sayı olan dizelerdir.

Tür: nesne

OpenAI.Verbosity

Modelin yanıtının çok fazla olduğunu sınırlar. Daha düşük değerler daha kısa yanıtlar sağlarken, daha yüksek değerler daha fazla sözlü yanıtlar sağlar. Şu anda desteklenen değerler , lowve medium'tirhigh.

Mülkiyet	Değer
Türü	String
Nullable	Evet
Değerler	low medium high

OpenAI.Wait

Bir bekleme eylemi.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olay türünü belirtir. Bir bekleme eylemi için bu özellik her zaman wait olarak ayarlanır. Olası değerler: wait	Evet

OpenAI.WebSearchActionFind

Eylem türü "bul": Yüklenen bir sayfada desen arar.

İsim	Türü	Description	Gerekli	Varsayılan
pattern	String	Sayfa içinde aranacak desen veya metin.	Evet
type	enum	Eylem türü. Olası değerler: find_in_page	Evet
url	String	Sayfanın URL'si deseni aradı.	Evet

OpenAI.WebSearchActionOpenPage

Eylem türü "open_page" - Arama sonuçlarından belirli bir URL'yi açar.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Eylem türü. Olası değerler: open_page	Evet
url	String	Model tarafından açılan URL.	Evet

OpenAI.WebSearchActionSearch

Eylem türü "arama" - Web araması sorgusu gerçekleştirir.

İsim	Türü	Description	Gerekli	Varsayılan
queries	dize dizisi	Arama sorguları.	Hayı
soru	dize (kullanım dışı)	[KULLANIM DIŞI] Arama sorgusu.	Evet
Kaynak	OpenAI.WebSearchActionSearchSources dizisi	Aramada kullanılan kaynaklar.	Hayı
type	enum	Eylem türü. Olası değerler: search	Evet

OpenAI.WebSearchActionSearchSources

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olası değerler: url	Evet
url	String		Evet

OpenAI.WebSearchApproximateLocation

Kullanıcının yaklaşık konumu.

İsim	Türü	Description	Gerekli	Varsayılan
city	dize (null atanabilir)		Hayı
country	dize (null atanabilir)		Hayı
region	dize (null atanabilir)		Hayı
timezone	dize (null atanabilir)		Hayı
type	enum	Konum yaklaşımının türü. Her zaman approximate. Olası değerler: approximate	Hayı

OpenAI.WebSearchPreviewTool

Bu araç, yanıt için ilgili sonuçları internette arar. web arama aracı hakkında daha fazla bilgi edinin.

İsim	Türü	Description	Gerekli	Varsayılan
arama_bağlam_boyutu	OpenAI.SearchContextSize		Hayı
type	enum	Web arama aracının türü. web_search_preview veya web_search_preview_2025_03_11'den biri. Olası değerler: web_search_preview	Evet
kullanıcı_konumu	OpenAI.ApproximateLocation (null atanabilir)		Hayı
└─ şehir	dize (null atanabilir)		Hayı
└─ ülke	dize (null atanabilir)		Hayı
└─ bölge	dize (null atanabilir)		Hayı
└─ saat dilimi	dize (null atanabilir)		Hayı
└─ türü	enum	Konum yaklaşımının türü. Her zaman approximate. Olası değerler: approximate	Evet

OpenAI.WebSearchTool

Yönlendirmeyle ilgili kaynakları internette arayın. web arama aracı hakkında daha fazla bilgi edinin.

İsim	Türü	Description	Gerekli	Varsayılan
custom_search_configuration	WebSearchConfiguration	bing özel arama için bir web arama yapılandırması	Hayı
└─ instance_name	String	Yapılandırmaya verilen özel yapılandırma örneğinin adı.	Evet
└─ project_connection_id	String	Project bağlantı kimliği bing özel arama ile topraklama için	Evet
filters	OpenAI.WebSearchToolFilters (null atanabilir)		Hayı
└─ allowed_domains	dize dizisi (null atanabilir)		Hayı
arama_bağlam_boyutu	enum	Arama için kullanılacak bağlam penceresi alanı miktarına yönelik üst düzey kılavuz. low, mediumveya high. medium varsayılan değerdir. Olası değerler: low, medium, high	Hayı
type	enum	Web arama aracının türü. web_search veya web_search_2025_08_26'den biri. Olası değerler: web_search	Evet
kullanıcı_konumu	OpenAI.WebSearchApproximateLocation (null atanabilir)	Kullanıcının yaklaşık konumu.	Hayı
└─ şehir	dize (null atanabilir)		Hayı
└─ ülke	dize (null atanabilir)		Hayı
└─ bölge	dize (null atanabilir)		Hayı
└─ saat dilimi	dize (null atanabilir)		Hayı
└─ türü	enum	Konum yaklaşımının türü. Her zaman approximate. Olası değerler: approximate	Hayı

OpenAI.WebSearchToolFilters

İsim	Türü	Description	Gerekli	Varsayılan
allowed_domains	dize dizisi		Hayı

OpenAI.integer

Tür: tamsayı

Biçim: int64

OpenAI.numeric

Tür: sayı

Biçim: çift

OpenApiAnonymousAuthDetails

OpenApi anonim kimlik doğrulaması için güvenlik ayrıntıları

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Her zaman 'anonim' olan nesne türü. Olası değerler: anonymous	Evet

OpenApiAuthDetails

OpenApiFunctionDefinition için kimlik doğrulama ayrıntıları

OpenApiAuthDetails için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
anonymous	OpenApiAnonymousAuthDetails
project_connection	OpenApiProjectConnectionAuthDetails
managed_identity	OpenApiManagedAuthDetails

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenApiAuthType	OpenApi uç noktası için kimlik doğrulama türü. İzin verilen türler şunlardır: - Anonim (kimlik doğrulaması gerekmez) - Project Bağlantı (AI Foundry'de kurulduğu gibi uç noktaya project_connection_id gerektirir) - Managed_Identity (kimlik tabanlı kimlik doğrulaması için hedef kitle gerektirir)	Evet

OpenApiAuthType

OpenApi uç noktası için kimlik doğrulama türü. İzin verilen türler şunlardır:

• Anonim (kimlik doğrulaması gerekmez)
• Project Bağlantı (AI Foundry'de kurulduğu gibi uç noktaya project_connection_id gerektirir)
• Managed_Identity (kimlik tabanlı kimlik doğrulama için hedef kitle gerektirir)

Mülkiyet	Değer
Açıklama	OpenApi uç noktası için kimlik doğrulama türü. İzin verilen türler şunlardır: - Anonim (kimlik doğrulaması gerekmez) - Project Bağlantı (AI Foundry'de kurulduğu gibi uç noktaya project_connection_id gerektirir) - Managed_Identity (kimlik tabanlı kimlik doğrulaması için hedef kitle gerektirir)
Türü	String
Değerler	anonymous project_connection managed_identity

OpenApiFunctionDefinition

Openapi işlevinin giriş tanımı bilgileri.

İsim	Türü	Description	Gerekli	Varsayılan
auth	OpenApiAuthDetails	OpenApiFunctionDefinition için kimlik doğrulama ayrıntıları	Evet
└─ türü	OpenApiAuthType	Kimlik doğrulama türü anonim/project_connection/managed_identity olmalıdır	Evet
default_params	dize dizisi	Kullanıcı tarafından sağlanan varsayılanları kullanacak OpenAPI belirtim parametrelerinin listesi	Hayı
açıklama	String	İşlevin ne zaman ve nasıl çağrıldığını seçmek için model tarafından kullanılan işlevin ne yaptığının açıklaması.	Hayı
functions	nesne dizisi	OpenApi aracı tarafından kullanılan işlev tanımlarının listesi	Hayı
name	String	Çağrılacak işlevin adı.	Evet
spec	nesne	JSON Şeması nesnesi olarak tanımlanan openapi işlev şekli.	Evet

OpenApiManagedAuthDetails

OpenApi managed_identity kimlik doğrulaması için güvenlik ayrıntıları

İsim	Türü	Description	Gerekli	Varsayılan
security_scheme	OpenApiManagedSecurityScheme	OpenApi managed_identity kimlik doğrulaması için güvenlik şeması	Evet
└─ hedef kitle	String	managed_identity kimlik doğrulama türü için kimlik doğrulama kapsamı	Evet
type	enum	Her zaman 'managed_identity' olan nesne türü. Olası değerler: managed_identity	Evet

OpenApiManagedSecurityScheme

OpenApi managed_identity kimlik doğrulaması için güvenlik şeması

İsim	Türü	Description	Gerekli	Varsayılan
audience	String	managed_identity kimlik doğrulama türü için kimlik doğrulama kapsamı	Evet

OpenApiProjectConnectionAuthDetails

OpenAPI proje bağlantı doğrulaması için güvenlik detayları

İsim	Türü	Description	Gerekli	Varsayılan
security_scheme	OpenApiProjectConnectionSecurityScheme	OpenApi managed_identity kimlik doğrulaması için güvenlik şeması	Evet
└─ project_connection_id	String	Project bağlantı kimliği için Project bağlantı kimliği	Evet
type	enum	Her zaman 'project_connection' olan nesne türü. Olası değerler: project_connection	Evet

OpenApiProjectConnectionSecurityScheme

OpenApi managed_identity kimlik doğrulaması için güvenlik şeması

İsim	Türü	Description	Gerekli	Varsayılan
project_connection_id	String	Project bağlantı kimliği için Project bağlantı kimliği	Evet

OpenApiTool

Aracıyı yapılandırmak için kullanılan OpenAPI aracının giriş tanımı bilgileri.

İsim	Türü	Description	Gerekli	Varsayılan
openapi	OpenApiFunctionDefinition	Openapi işlevinin giriş tanımı bilgileri.	Evet
└─ kimlik doğrulaması	OpenApiAuthDetails	Açık API kimlik doğrulaması ayrıntıları	Evet
└─ default_params	dize dizisi	Kullanıcı tarafından sağlanan varsayılanları kullanacak OpenAPI belirtim parametrelerinin listesi	Hayı
└─ açıklama	String	İşlevin ne zaman ve nasıl çağrıldığını seçmek için model tarafından kullanılan işlevin ne yaptığının açıklaması.	Hayı
└─ işlevleri	nesne dizisi (salt okunur)	OpenApi aracı tarafından kullanılan işlev tanımlarının listesi	Hayı
└─ açıklama	String	İşlevin ne zaman ve nasıl çağrıldığını seçmek için model tarafından kullanılan işlevin ne yaptığının açıklaması.	Hayı
└─ ad	String	Çağrılacak işlevin adı.	Evet
└─ parametreler	nesne	İşlevlerin kabullediği, JSON Şeması nesnesi olarak tanımlanan parametreler.	Evet
└─ ad	String	Çağrılacak işlevin adı.	Evet
└─ belirtim	nesne	JSON Şeması nesnesi olarak tanımlanan openapi işlev şekli.	Evet
type	enum	Her zaman 'openapi' olan nesne türü. Olası değerler: openapi	Evet

PageOrder

Mülkiyet	Değer
Türü	String
Değerler	asc desc

PagedConnection

Bağlantı öğelerinin sayfalı koleksiyonu

İsim	Türü	Description	Gerekli	Varsayılan
nextLink	String	Öğelerin sonraki sayfasına bağlantı	Hayı
değer	Bağlantı dizisi	Bu sayfadaki Bağlantı öğeleri	Evet

PagedDatasetVersion

DatasetVersion öğelerinin sayfalı koleksiyonu

İsim	Türü	Description	Gerekli	Varsayılan
nextLink	String	Öğelerin sonraki sayfasına bağlantı	Hayı
değer	DatasetVersion dizisi	Bu sayfadaki DatasetVersion öğeleri	Evet

PagedDeployment

Dağıtım öğelerinin sayfalı koleksiyonu

İsim	Türü	Description	Gerekli	Varsayılan
nextLink	String	Öğelerin sonraki sayfasına bağlantı	Hayı
değer	Dağıtım dizisi	Bu sayfadaki Dağıtım öğeleri	Evet

PagedEvaluationRule

EvaluationRule öğelerinin disk belleğine alınmış koleksiyonu

İsim	Türü	Description	Gerekli	Varsayılan
nextLink	String	Öğelerin sonraki sayfasına bağlantı	Hayı
değer	EvaluationRule dizisi	Bu sayfadaki EvaluationRule öğeleri	Evet

PagedEvaluationTaxonomy

EvaluationTaxonomy öğelerinin sayfalanmış koleksiyonu

İsim	Türü	Description	Gerekli	Varsayılan
nextLink	String	Öğelerin sonraki sayfasına bağlantı	Hayı
değer	EvaluationTaxonomy dizisi	Bu sayfadaki EvaluationTaxonomy öğeleri	Evet

PagedEvaluatorVersion

EvaluatorVersion öğelerinin disk belleğine alınmış koleksiyonu

İsim	Türü	Description	Gerekli	Varsayılan
nextLink	String	Öğelerin sonraki sayfasına bağlantı	Hayı
değer	EvaluatorVersion dizisi	Bu sayfadaki EvaluatorVersion öğeleri	Evet

PagedIndex

Dizin öğelerinin sayfalı koleksiyonu

İsim	Türü	Description	Gerekli	Varsayılan
nextLink	String	Öğelerin sonraki sayfasına bağlantı	Hayı
değer	Dizin dizisi	Bu sayfadaki Dizin öğeleri	Evet

PagedInsight

İçgörü öğelerinin disk belleğine alınmış koleksiyonu

İsim	Türü	Description	Gerekli	Varsayılan
nextLink	String	Öğelerin sonraki sayfasına bağlantı	Hayı
değer	insight dizisi	Bu sayfadaki İçgörü öğeleri	Evet

PagedRedTeam

RedTeam öğelerinin sayfalı koleksiyonu

İsim	Türü	Description	Gerekli	Varsayılan
nextLink	String	Öğelerin sonraki sayfasına bağlantı	Hayı
değer	RedTeam dizisi	Bu sayfadaki RedTeam öğeleri	Evet

PagedSchedule

Zamanlama öğelerinin sayfalı koleksiyonu

İsim	Türü	Description	Gerekli	Varsayılan
nextLink	String	Öğelerin sonraki sayfasına bağlantı	Hayı
değer	Zamanlama dizisi	Bu sayfadaki Öğeleri zamanla	Evet

PagedScheduleRun

ScheduleRun öğelerinin disk belleği koleksiyonu

İsim	Türü	Description	Gerekli	Varsayılan
nextLink	String	Öğelerin sonraki sayfasına bağlantı	Hayı
değer	ScheduleRun dizisi	Bu sayfadaki ScheduleRun öğeleri	Evet

PendingUploadRequest

Bekleyen bir yükleme isteğini temsil eder.

İsim	Türü	Description	Gerekli	Varsayılan
connectionName (bağlantıadı)	String	Azure Storage Account connection name to use for generate temporary SAS token	Hayı
pendingUploadId	String	PendingUploadId sağlanmazsa, rastgele bir GUID kullanılır.	Hayı
pendingUploadType	enum	BlobReference desteklenen tek türdür. Olası değerler: BlobReference	Evet

PendingUploadResponse

Bekleyen bir yükleme isteğinin yanıtını temsil eder

İsim	Türü	Description	Gerekli	Varsayılan
blobReference	BlobReference	Blob başvuru ayrıntıları.	Evet
└─ blobUri	String	İstemcinin verileri karşıya yüklemesi için Blob URI yolu. Örnek: https://blob.windows.core.net/Container/Path	Evet
└─ kimlik bilgisi	SasCredential	storage hesabı access kimlik bilgileri.	Evet
└─ storageAccountArmId	String	Kullanılacak storage hesabının ARM ID'si.	Evet
pendingUploadId	String	Bu yükleme isteğinin kimliği.	Evet
pendingUploadType	enum	BlobReference desteklenen tek türdür Olası değerler: BlobReference	Evet
version	String	Kullanıcı ilk yükleme oluşturulurken sürüm belirtmediyse oluşturulacak öğenin sürümü	Hayı

PromptAgentDefinition

İstem aracısı tanımı

İsim	Türü	Description	Gerekli	Varsayılan
instructions	dize (null atanabilir)	Modelin bağlamı içine eklenen bir sistem (veya geliştirici) iletisi.	Hayı
tür	enum	Olası değerler: prompt	Evet
model	String	Bu aracı için kullanılacak model dağıtımı.	Evet
rai_config	RaiConfig	Sorumlu Yapay Zeka (RAI) içerik filtreleme ve güvenlik özellikleri için yapılandırma.	Hayı
└─ rai_policy_name	String	Uygulanacak RAI politikasının adı.	Evet
reasoning	OpenAI.Reasoning (null atanabilir)	yalnızca gpt-5 ve o serisi modeller Için yapılandırma seçenekleri mantıp modelleri.	Hayı
└─ çaba	OpenAI.ReasoningEffort	Akıl yürütme çabasını kısıtlar mantıp modelleri. Şu anda desteklenen değerler none, minimal, low, medium, high, ve xhigh'dir. Azaltma muhakeme çabası daha hızlı yanıtlara ve daha az belirteç kullanılmasına neden olabilir bir yanıtta mantık yürütme. - gpt-5.1 varsayılan olarak noneöğesini kullanır ve mantık yürütmez. Desteklenen gerekçe değerleri gpt-5.1none, low, medium, ve high'dir. Araç çağrıları gpt-5.1'deki tüm akıl yürütme değerleri için desteklenir. - Tüm modeller varsayılan olarak akıl yürütme eforu olmadan gpt-5.1 önce medium ve desteklemeznone. - Model gpt-5-pro varsayılan olarak akıl yürütme eforunu kullanır (ve yalnızca destekler high ). - xhigh , sonrasındaki gpt-5.1-codex-maxtüm modeller için desteklenir.	Hayı
└─ özet oluştur	enum	Olası değerler: auto, concise, detailed	Hayı
└─ özeti	enum	Olası değerler: auto, concise, detailed	Hayı
structured_inputs	nesne	Bilgi istemi şablonu değiştirme veya araç bağımsız değişkeni bağlamalarına katılabilen yapılandırılmış girişler kümesi.	Hayı
sıcaklık	Numara	0 ile 2 arasında hangi örnekleme sıcaklığının kullanılacağı. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir. Genellikle bunu değiştirmenizi öneririz top_p ancak ikisini birden değiştirmemenizi öneririz.	Hayı	1
text	PromptAgentDefinitionTextOptions	Modelden metin yanıtı için yapılandırma seçenekleri. Düz metin veya yapılandırılmış JSON verileri olabilir.	Hayı
└─ biçimi	OpenAI.TextResponseFormatConfiguration	Modelin çıkış yapması gereken biçimi belirten bir nesne. Yapılandırma { "type": "json_schema" } , Yapılandırılmış Çıkışları etkinleştirir, modelin sağlanan JSON şemanızla eşleşmesini sağlar. Daha fazla bilgi için Varsayılan biçim { "type": "text" } ek seçenek yoktur. *gpt-4o ve daha yeni modeller için önerilmez:** { "type": "json_object" } ayarı, eski JSON modunu etkinleştirir. modelin oluşturduğu iletinin geçerli JSON olduğundan emin olur. json_schema’ı kullanma Bu özelliği destekleyen modeller için tercih edilir.	Hayı
tool_choice	string veya OpenAI.ToolChoiceParam	Modelin yanıt oluştururken kullanılacak aracı (veya araçları) seçmesi gerekir. Modelin hangi araçları çağırabileceğini belirtmek için tools parametresine bakın.	Hayı
araçlar	OpenAI.Tool dizisi	Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Siz parametresini ayarlayarak tool_choice hangi aracın kullanılacağını belirtebilir.	Hayı
top_p	Numara	Sıcaklıkla örneklemeye alternatif olarak çekirdek örneklemesi adı verilir, burada model, belirteçlerin sonuçlarını top_p olasılıkla değerlendirir kütle. Yani 0,1 yalnızca ilk 10% olasılık kütlesini oluşturan belirteçler anlamına gelir dikkate alınır. Genellikle bunu değiştirmenizi öneririz temperature ancak ikisini birden değiştirmemenizi öneririz.	Hayı	1

PromptAgentDefinitionTextOptions

Modelden metin yanıtı için yapılandırma seçenekleri. Düz metin veya yapılandırılmış JSON verileri olabilir.

İsim	Türü	Description	Gerekli	Varsayılan
format	OpenAI.TextResponseFormatConfiguration	Modelin çıkış yapması gereken biçimi belirten bir nesne. Yapılandırma { "type": "json_schema" } , Yapılandırılmış Çıkışları etkinleştirir, modelin sağlanan JSON şemanızla eşleşmesini sağlar. Daha fazla bilgi için Varsayılan biçim { "type": "text" } ek seçenek yoktur. *gpt-4o ve daha yeni modeller için önerilmez:** { "type": "json_object" } ayarı, eski JSON modunu etkinleştirir. modelin oluşturduğu iletinin geçerli JSON olduğundan emin olur. json_schema’ı kullanma Bu özelliği destekleyen modeller için tercih edilir.	Hayı

PromptBasedEvaluatorDefinition

İstem tabanlı değerlendirici

İsim	Türü	Description	Gerekli	Varsayılan
data_schema	nesne	Değerlendiricinin giriş verileri için JSON şeması (Taslak 2020-12). Bu, tür, özellikler, gerekli gibi parametreleri içerir.	Hayı
init_parameters	nesne	Değerlendiricinin giriş parametreleri için JSON şeması (Taslak 2020-12). Bu, tür, özellikler, gerekli gibi parametreleri içerir.	Hayı
metrics	nesne	Bu değerlendirici tarafından üretilen çıktı metriklerinin listesi	Hayı
prompt_text	String	Değerlendirme için kullanılan bilgi istemi metni	Evet
type	enum	Olası değerler: prompt	Evet

ProtocolVersionRecord

Tek bir protokol ve sürümü için kayıt eşlemesi.

İsim	Türü	Description	Gerekli	Varsayılan
protokol	AgentProtocol		Evet
version	String	Protokolün sürüm dizesi, örneğin 'v0.1.1'.	Evet

RaiConfig

Sorumlu Yapay Zeka (RAI) içerik filtreleme ve güvenlik özellikleri için yapılandırma.

İsim	Türü	Description	Gerekli	Varsayılan
rai_policy_name	String	Uygulanacak RAI politikasının adı.	Evet

RecurrenceSchedule

Yinelenme zamanlama modeli.

RecurrenceSchedule için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
Hourly	HourlyRecurrenceSchedule
Daily	DailyRecurrenceSchedule
Weekly	WeeklyRecurrenceSchedule
Monthly	MonthlyRecurrenceSchedule

İsim	Türü	Description	Gerekli	Varsayılan
type	RecurrenceType	Yinelenme türü.	Evet

RecurrenceTrigger

Yinelenmeye dayalı tetikleyici.

İsim	Türü	Description	Gerekli	Varsayılan
endTime	String	ISO 8601 biçiminde yinelenme zamanlaması için bitiş saati.	Hayı
interval	tamsayı	Yinelenme zamanlaması aralığı.	Evet
takvim	RecurrenceSchedule	Yinelenme zamanlama modeli.	Evet
└─ türü	RecurrenceType	Yinelenme zamanlaması için yinelenme türü.	Evet
startTime	String	ISO 8601 biçiminde yinelenme zamanlaması için başlangıç saati.	Hayı
timeZone	String	Yinelenme zamanlaması için saat dilimi.	Hayı	UTC (Koordinatlı Evrensel Zaman)
type	enum	Tetikleyicinin türü. Olası değerler: Recurrence	Evet

RecurrenceType

Yinelenme türü.

Mülkiyet	Değer
Açıklama	Yinelenme türü.
Türü	String
Değerler	Hourly Daily Weekly Monthly

RedTeam

Kırmızı takım detayları.

İsim	Türü	Description	Gerekli	Varsayılan
applicationScenario	String	Senaryoya özel saldırılar oluşturmak için kırmızı takım operasyonu için uygulama senaryosu.	Hayı
attackStrategies	AttackStrategy dizisi	Saldırı stratejilerinin listesi veya saldırı stratejilerinin iç içe geçmiş listeleri.	Hayı
ekran adı	String	Kırmızı takım koşusunun adı.	Hayı
kimlik	dize (salt okunur)	Kırmızı takım koşusunun tanımlayıcısı.	Evet
numTurns	tamsayı	Simülasyon turlarının sayısı.	Hayı
properties	nesne	Kırmızı takımın özellikleri. Etiketlerden farklı olarak özellikler yalnızca eklentidir. Bir özellik eklendikten sonra kaldırılamaz.	Hayı
risk Kategorileri	RiskCategory dizisi	Saldırı hedefleri oluşturmak için risk kategorilerinin listesi.	Hayı
simulationOnly	Boolean	Yalnızca simülasyon veya Simülasyon + Değerlendirme. Varsayılan olarak false, doğruysa tarama değerlendirme sonucunu değil konuşma çıktısını verir.	Hayı	Yanlış
durum	dize (salt okunur)	Kırmızı takımın durumu. Hizmet tarafından ayarlanır ve salt okunurdur.	Hayı
tags	nesne	Kırmızı takımın etiketleri. Özelliklerden farklı olarak etiketler tamamen değişebilir.	Hayı
target	TargetConfig	Hedef yapılandırma için soyut sınıf.	Evet
└─ türü	String	Model yapılandırmasının türü.	Evet

RedTeamEvalRunDataSource

İsim	Türü	Description	Gerekli	Varsayılan
item_generation_params	ItemGenerationParams	Öğe oluşturma işlemlerini denetlemek için kullanılan parametre kümesini temsil eder.	Evet
└─ türü	ItemGenerationParamsType	Kullanılacak öğe oluşturma parametrelerinin türü.	Evet
target	Hedef	Ayırıcı desteği olan hedefler için temel sınıf.	Evet
└─ türü	String	Hedefin türü.	Evet
type	enum	Veri kaynağının türü. Her zaman azure_ai_red_team. Olası değerler: azure_ai_red_team	Evet

RedTeamItemGenerationParams

İsim	Türü	Description	Gerekli	Varsayılan
attack_strategies	AttackStrategy dizisi	Kullanılacak saldırı stratejilerinin koleksiyonu.	Evet
num_turns	tamsayı	Oyunda izin verilen dönüş sayısı.	Evet	20
type	enum	Öğe oluşturma parametrelerinin türü. Olası değerler: red_team	Evet

RedTeamSeedPromptsItemGenerationParams

Kırmızı takım çekirdek istemleri öğe oluşturma parametrelerini temsil eder.

İsim	Türü	Description	Gerekli	Varsayılan
attack_strategies	AttackStrategy dizisi	Kullanılacak saldırı stratejilerinin koleksiyonu.	Evet
num_turns	tamsayı	Oyunda izin verilen dönüş sayısı.	Evet	20
kaynak	OpenAI.EvalJsonlFileContentSource		Evet
└─ içerik	OpenAI.EvalJsonlFileContentSourceContent dizisi	jsonl dosyasının içeriği.	Evet
└─ türü	enum	Jsonl kaynağının türü. Her zaman file_content. Olası değerler: file_content	Evet
type	enum	Her zaman red_team_seed_promptsolan öğe oluşturma parametrelerinin türü. Olası değerler: red_team_seed_prompts	Evet

RedTeamTaxonomyItemGenerationParams

Kırmızı takım taksonomisi öğesi oluşturma parametrelerini temsil eder.

İsim	Türü	Description	Gerekli	Varsayılan
attack_strategies	AttackStrategy dizisi	Kullanılacak saldırı stratejilerinin koleksiyonu.	Evet
num_turns	tamsayı	Oyunda izin verilen dönüş sayısı.	Evet	20
kaynak	OpenAI.EvalJsonlFileContentSource		Evet
└─ içerik	OpenAI.EvalJsonlFileContentSourceContent dizisi	jsonl dosyasının içeriği.	Evet
└─ türü	enum	Jsonl kaynağının türü. Her zaman file_content. Olası değerler: file_content	Evet
type	enum	Her zaman red_team_taxonomyolan öğe oluşturma parametrelerinin türü. Olası değerler: red_team_taxonomy	Evet

ResponseRetrievalItemGenerationParams

Yanıt alma öğesi oluşturma parametrelerini temsil eder.

İsim	Türü	Description	Gerekli	Varsayılan
veri eşleme	nesne	Sohbet geçmişini almak için gereken kaynak alanlardan response_id alanına eşleme.	Evet
max_num_turns	tamsayı	Değerlendirilecek sohbet geçmişinin maksimum dönüş sayısı.	Evet
kaynak	OpenAI.EvalJsonlFileContentSource veya OpenAI.EvalJsonlFileIdSource	JSONL içeriğinin okunduğu kaynak.	Evet
type	enum	Her zaman response_retrievalolan öğe oluşturma parametrelerinin türü. Olası değerler: response_retrieval	Evet

RiskCategory

Saldırı hedefi için risk kategorisi.

Mülkiyet	Değer
Açıklama	Saldırı hedefi için risk kategorisi.
Türü	String
Değerler	HateUnfairness Violence Sexual SelfHarm ProtectedMaterial CodeVulnerability UngroundedAttributes ProhibitedActions SensitiveDataLeakage TaskAdherence

SASCredentials

Paylaşılan Access İmzası (SAS) kimlik tanımı

İsim	Türü	Description	Gerekli	Varsayılan
SAS	dize (salt okunur)	SAS belirteci	Hayı
type	enum	Kimlik bilgisi türü Olası değerler: SAS	Evet

SampleType

Analizde kullanılan numunenin türü.

Mülkiyet	Değer
Açıklama	Analizde kullanılan numunenin türü.
Türü	String
Değerler	EvaluationResultSample

SasCredential (SasKimlik Bilgisi)

SAS Kimlik Bilgisi tanımı

İsim	Türü	Description	Gerekli	Varsayılan
sasUri	dize (salt okunur)	SAS uri'si	Evet
type	enum	Kimlik bilgisi türü Olası değerler: SAS	Evet

Schedule

Zamanlama modeli.

İsim	Türü	Description	Gerekli	Varsayılan
açıklama	String	Zamanlamanın açıklaması.	Hayı
ekran adı	String	Zamanlamanın adı.	Hayı
etkinleştirildi	Boolean	Zamanlamanın etkin durumu.	Evet
kimlik	dize (salt okunur)	Zamanlamanın tanımlayıcısı.	Evet
properties	nesne	Schedule'ın özellikleri. Etiketlerden farklı olarak özellikler yalnızca eklentidir. Bir özellik eklendikten sonra kaldırılamaz.	Hayı
provisioningStatus	ScheduleProvisioningStatus (salt okunur)	Sağlama durumunu zamanlayın.	Hayı
sistem verileri	object (salt okunur)	Kaynak için sistem meta verileri.	Evet
tags	nesne	Schedule'un etiketleri. Özelliklerden farklı olarak etiketler tamamen değişebilir.	Hayı
görev	ScheduleTask	Zamanlama görev modeli.	Evet
└─ yapılandırması	nesne	Görev için yapılandırma.	Hayı
└─ türü	ScheduleTaskType	Görevin türü.	Evet
trigger	Trigger	Zamanlamanın tetikleyicisi için temel model.	Evet
└─ türü	TriggerType	Tetikleyicinin türü.	Evet

ScheduleProvisioningStatus

Sağlama durumunu zamanlayın.

Mülkiyet	Değer
Açıklama	Sağlama durumunu zamanlayın.
Türü	String
Değerler	Creating Updating Deleting Succeeded Failed

ScheduleRun

Zamanlama çalıştırma modeli.

İsim	Türü	Description	Gerekli	Varsayılan
hata	dize (salt okunur)	Zamanlama çalıştırması için hata bilgileri.	Hayı
kimlik	dize (salt okunur)	Zamanlama çalıştırmasının tanımlayıcısı.	Evet
properties	object (salt okunur)	Zamanlama çalıştırmasının özellikleri.	Evet
scheduleId	String	Zamanlamanın tanımlayıcısı.	Evet
başarı	boole (salt okunur)	Zamanlama çalıştırmasının başarı durumunu tetikleyin.	Evet
triggerTime	String	Zamanlama çalıştırmasının tetikleme zamanı.	Hayı

Görev Planla

Zamanlama görev modeli.

ScheduleTask için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
Evaluation	EvaluationScheduleTask
Insight	InsightScheduleTask

İsim	Türü	Description	Gerekli	Varsayılan
configuration	nesne	Görev için yapılandırma.	Hayı
type	ScheduleTaskType	Görevin türü.	Evet

ScheduleTaskType

Görevin türü.

Mülkiyet	Değer
Açıklama	Görevin türü.
Türü	String
Değerler	Evaluation Insight

SharepointGroundingToolParameters

Sharepoint topraklama aracı parametreleri.

İsim	Türü	Description	Gerekli	Varsayılan
project_connections	ToolProjectConnection dizisi	Bu araca bağlı proje bağlantıları. En fazla 1 bağlantı olabilir aracına bağlı kaynak.	Hayı

SharepointPreviewTool

Aracıyı yapılandırmak için kullanılan sharepoint aracının giriş tanımı bilgileri.

İsim	Türü	Description	Gerekli	Varsayılan
sharepoint_grounding_preview	SharepointGroundingToolParameters	Sharepoint topraklama aracı parametreleri.	Evet
└─ project_connections	ToolProjectConnection dizisi	Bu araca bağlı proje bağlantıları. En fazla 1 bağlantı olabilir aracına bağlı kaynak. Kısıtlamalar: maxItems: 1	Hayı
type	enum	Nesne türü, ki her zaman 'sharepoint_grounding_preview' olur. Olası değerler: sharepoint_grounding_preview	Evet

Sku

Sku bilgileri

İsim	Türü	Description	Gerekli	Varsayılan
capacity	tamsayı	Sku kapasitesi	Evet
family	String	Sku ailesi	Evet
name	String	Sku adı	Evet
boyut	String	Sku boyutu	Evet
seviye	String	Sku katmanı	Evet

StructuredInputDefinition

Bilgi istemi şablonu değiştirmelerine ve araç bağımsız değişkeni bağlamasına katılabilen yapılandırılmış bir giriş.

İsim	Türü	Description	Gerekli	Varsayılan
default_value		Çalışma zamanı değeri sağlanmamışsa giriş için varsayılan değer.	Hayı
açıklama	String	Girişin okunabilir bir açıklaması.	Hayı
required	Boolean	Aracı çağrıldığında giriş özelliğinin gerekli olup olmadığı.	Hayı	Yanlış
şema	nesne	Yapılandırılmış giriş için JSON şeması (isteğe bağlı).	Hayı

StructuredOutputDefinition

Aracı tarafından üretilebilen yapılandırılmış bir çıkış.

İsim	Türü	Description	Gerekli	Varsayılan
açıklama	String	Yayınlanacak çıkışın açıklaması. Çıktının ne zaman yayınlanacağını belirlemek için model tarafından kullanılır.	Evet
name	String	Yapılandırılmış çıkışın adı.	Evet
şema	nesne	Yapılandırılmış çıkış için JSON şeması.	Evet
Sıkı	boole değeri (null atanabilir)	Sıkı doğrulamanın uygulanıp uygulanmayacağı. Varsayılan true.	Evet

StructuredOutputsOutputItem

İsim	Türü	Description	Gerekli	Varsayılan
agent_reference	AgentReference		Hayı
└─ ad	String	Aracının adı. Kısıtlamalar: maxLength: 256	Evet
└─ türü	enum	Olası değerler: agent_reference	Evet
└─ sürümü	String	Aracının sürüm tanımlayıcısı.	Hayı
çıktı		Yanıt sırasında yakalanan yapılandırılmış çıkış.	Evet
response_id	String	Öğenin oluşturulduğu yanıt.	Hayı
type	enum	Olası değerler: structured_outputs	Evet

SyntheticDataGenerationPreviewEvalRunDataSource

Test amacıyla oluşturulan yapay verileri temel alan değerlendirme çalıştırmaları için bir veri kaynağını temsil eder.

İsim	Türü	Description	Gerekli	Varsayılan
input_mesajları	OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate		Hayı
└─ şablon	object dizisi veya OpenAI.EvalItem		Evet
└─ türü	enum	Olası değerler: template	Evet
item_generation_params	SyntheticDataGenerationPreviewItemGenerationParams		Evet
└─ model_deployment_name	String	Yapay veri oluşturmak için kullanılacak model dağıtımının adı.	Evet
└─ output_dataset_id	dize (salt okunur)	Oluşturulan yapay verilerin depolandığı çıkış veri kümesinin tanımlayıcısı. Oluşturulan veriler, sütun kimliği, sorgu ve test_description içeren bir jsonl dosyasıdır.	Hayı
└─ output_dataset_name	String	Oluşturulan yapay verilerin depolanacağı çıkış veri kümesinin adı. Sağlanmazsa, hizmet otomatik olarak veri kümesi adı oluşturur.	Hayı
└─ istemi	String	Yapay veri oluşturmak için kullanılan istem. Hedef, aracıda yapılandırılan yönergelerle 'azure_ai_agent' türündeyse bu seçenektir.	Hayı
└─ samples_count	tamsayı	Oluşturulacak en fazla veri örneği sayısı.	Evet
└─ kaynaklar	OpenAI.EvalJsonlFileIdSource dizisi	Veri oluşturma için isteğe bağlı çekirdek veri içerik kaynağı dosyaları.	Evet
└─ türü	enum	Öğe oluşturma parametrelerinin türü. Olası değerler: synthetic_data_gen_preview	Evet
target	Hedef	Ayırıcı desteği olan hedefler için temel sınıf.	Evet
└─ türü	String	Hedefin türü.	Evet
type	enum	Her zaman azure_ai_synthetic_data_gen_previewveri kaynağı türü. Olası değerler: azure_ai_synthetic_data_gen_preview	Evet

SyntheticDataGenerationPreviewItemGenerationParams

İsim	Türü	Description	Gerekli	Varsayılan
model_deployment_name	String	Yapay veri oluşturmak için kullanılacak model dağıtımının adı.	Evet
output_dataset_id	dize (salt okunur)	Oluşturulan yapay verilerin depolandığı çıkış veri kümesinin tanımlayıcısı. Oluşturulan veriler, sütun kimliği, sorgu ve test_description içeren bir jsonl dosyasıdır.	Hayı
output_dataset_name	String	Oluşturulan yapay verilerin depolanacağı çıkış veri kümesinin adı. Sağlanmazsa, hizmet otomatik olarak veri kümesi adı oluşturur.	Hayı
prompt	String	Yapay veri oluşturmak için kullanılan istem. Hedef, aracıda yapılandırılan yönergelerle 'azure_ai_agent' türündeyse bu seçenektir.	Hayı
samples_count	tamsayı	Oluşturulacak en fazla veri örneği sayısı.	Evet
Kaynak	OpenAI.EvalJsonlFileIdSource dizisi	Veri oluşturma için isteğe bağlı çekirdek veri içerik kaynağı dosyaları.	Evet
type	enum	Öğe oluşturma parametrelerinin türü. Olası değerler: synthetic_data_gen_preview	Evet

Hedef

Ayırıcı desteği olan hedefler için temel sınıf.

Hedef için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
azure_ai_model	AzureAIModelTarget
azure_ai_agent	AzureAIAgentTarget

İsim	Türü	Description	Gerekli	Varsayılan
type	String	Hedefin türü.	Evet

TargetCompletionEvalRunDataSource

Hedef tabanlı tamamlama değerlendirme yapılandırması için bir veri kaynağını temsil eder.

İsim	Türü	Description	Gerekli	Varsayılan
input_mesajları	OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference		Hayı
└─ öğe_referansı	String		Evet
└─ türü	enum	Olası değerler: item_reference	Evet
kaynak	OpenAI.EvalJsonlFileContentSource veya OpenAI.EvalJsonlFileIdSource	Satır içi veya dosya verileri için kaynak yapılandırma.	Evet
target	Hedef	Ayırıcı desteği olan hedefler için temel sınıf.	Evet
└─ türü	String	Hedefin türü.	Evet
type	enum	Her zaman azure_ai_target_completionsveri kaynağı türü. Olası değerler: azure_ai_target_completions	Evet

TargetConfig

Hedef yapılandırma için soyut sınıf.

TargetConfig için Ayrıştırıcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
AzureOpenAIModel	AzureOpenAIModelConfiguration

İsim	Türü	Description	Gerekli	Varsayılan
type	String	Model yapılandırmasının türü.	Evet

TargetUpdate

Ayırıcı desteği olan hedefler için temel sınıf.

TargetUpdate için Ayrıştırıcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
azure_ai_model	AzureAIModelTargetUpdate
azure_ai_agent	AzureAIAgentTargetUpdate

İsim	Türü	Description	Gerekli	Varsayılan
type	String	Hedefin türü.	Evet

TaksonomiKategorisi

Taksonomi kategori tanımı.

İsim	Türü	Description	Gerekli	Varsayılan
açıklama	String	Taksonomi kategorisinin açıklaması.	Hayı
kimlik	String	Taksonomi kategorisinin benzersiz tanımlayıcısı.	Evet
name	String	Taksonomi kategorisinin adı.	Evet
properties	nesne	Taksonomi kategorisi için ek özellikler.	Hayı
riskCategory	RiskCategory	Saldırı hedefi için risk kategorisi.	Evet
Alt kategori	TaxonomySubCategory dizisi	Taksonomi alt kategorilerinin listesi.	Evet

TaxonomySubCategory

Taksonomi alt kategori tanımı.

İsim	Türü	Description	Gerekli	Varsayılan
açıklama	String	Taksonomi alt kategorisinin açıklaması.	Hayı
etkinleştirildi	Boolean	Bu alt kategori altındaki taksonomi öğelerinin listesi.	Evet
kimlik	String	Taksonomi alt kategorisinin benzersiz tanımlayıcısı.	Evet
name	String	Taksonomi alt kategorisinin adı.	Evet
properties	nesne	Taksonomi alt kategorisi için ek özellikler.	Hayı

ToolDescription

Bir aracı tarafından kullanılabilecek bir aracın açıklaması.

İsim	Türü	Description	Gerekli	Varsayılan
açıklama	String	Aracın amacının kısa bir açıklaması.	Hayı
name	String	Araç adı.	Hayı

ToolProjectConnection

Bir proje bağlantısı kaynağı.

İsim	Türü	Description	Gerekli	Varsayılan
project_connection_id	String	Bu araca bağlı bir ToolProjectConnectionList'teki bir project bağlantısı.	Evet

TracesPreviewEvalRunDataSource

Application Insights'ta depolanan Aracı izlemeleri üzerinde çalışan değerlendirme çalıştırmaları için bir veri kaynağını temsil eder.

İsim	Türü	Description	Gerekli	Varsayılan
agent_id	String	Değerlendirme için izlemeleri filtrelemek için kullanılan aracı kimliği.	Hayı
agent_name	String	Değerlendirme için izlemeleri filtrelemek için kullanılan aracı adı.	Hayı
bitiş_zamanı	tamsayı	İzleme sorgusu penceresinin sonunu işaret eden Unix zaman damgası (saniye olarak). Varsayılan olarak geçerli saati kullanır.	Hayı
ingestion_delay_seconds	tamsayı	İzlemeleri sorgularken alma için uygulanacak gecikme.	Hayı	300
lookback_hours	tamsayı	Application Insights'tan izlemeler alınırken uygulanan geri arama penceresi (saat cinsinden). Zamanlanmış değerlendirmeler için bu, yinelenme aralığından çıkarılır.	Hayı	168
max_traces	tamsayı	Değerlendirme için alınan izlemelere uygulanan örnekleme sınırı.	Hayı	1000
trace_ids	dize dizisi	Değerlendirilmesi gereken Aracı izleme tanımlayıcıları koleksiyonu.	Hayı
type	enum	Her zaman azure_ai_traces_previewveri kaynağı türü. Olası değerler: azure_ai_traces_preview	Evet

TreatmentEffectType

Tedavi Etki Türü.

Mülkiyet	Değer
Açıklama	Tedavi Etki Türü.
Türü	String
Değerler	TooFewSamples Inconclusive Changed Improved Degraded

Tetikleyici

Zamanlamanın tetikleyicisi için temel model.

Tetikleyici için Ayrıştırıcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
Cron	CronTrigger
Recurrence	RecurrenceTrigger
OneTime	OneTimeTrigger

İsim	Türü	Description	Gerekli	Varsayılan
type	TriggerType	Tetikleyicinin türü.	Evet

TriggerType

Tetikleyicinin türü.

Mülkiyet	Değer
Açıklama	Tetikleyicinin türü.
Türü	String
Değerler	Cron Recurrence OneTime

UpdateAgentFromManifestRequest

İsim	Türü	Description	Gerekli	Varsayılan
açıklama	String	Aracının insan tarafından okunabilir bir açıklaması. Kısıtlamalar: maxLength: 512	Hayı
manifest_id	String	Aracı sürümünü içeri aktaracak bildirim kimliği.	Evet
metadata	nesne	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Hayı
parameter_values	nesne	Bildirime yapılan ve tam olarak gerçekleştirilmiş bir Aracı ile sonuçlanacak girişler.	Evet

UpdateAgentRequest

İsim	Türü	Description	Gerekli	Varsayılan
tanım	AgentDefinition		Evet
└─ tür	AgentKind		Evet
└─ rai_config	RaiConfig	Sorumlu Yapay Zeka (RAI) içerik filtreleme ve güvenlik özellikleri için yapılandırma.	Hayı
açıklama	String	Aracının insan tarafından okunabilir bir açıklaması. Kısıtlamalar: maxLength: 512	Hayı
metadata	nesne	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Hayı

UpdateEvalParametersBody

İsim	Türü	Description	Gerekli	Varsayılan
metadata	OpenAI.Metadata (null atanabilir)	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Hayı
name	String		Hayı
properties	nesne	Ek bilgileri depolamak için bir nesneye eklenebilen sabit 16 anahtar-değer çifti kümesi. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler, uzunluğu en fazla 512 karakter olan dizelerdir.	Hayı

UserProfileMemoryItem

Tercihler, ilgi alanları ve kişisel ayrıntılar gibi konuşmalardan çıkarılan kullanıcı profili bilgilerini özel olarak içeren bir bellek öğesi.

İsim	Türü	Description	Gerekli	Varsayılan
içerik	String	Belleğin içeriği.	Evet
tür	enum	Hafıza öğesinin türü. Olası değerler: user_profile	Evet
memory_id	String	Bellek öğesinin benzersiz kimliği.	Evet
kapsam	String	Kullanıcı kimliği gibi anıları mantıksal olarak gruplandıran ve yalıtan ad alanı.	Evet
updated_at	tamsayı	Bellek öğesinin son güncelleme zamanı.	Evet

WebSearchConfiguration

bing özel arama için bir web arama yapılandırması

İsim	Türü	Description	Gerekli	Varsayılan
instance_name	String	Yapılandırmaya verilen özel yapılandırma örneğinin adı.	Evet
project_connection_id	String	Project bağlantı kimliği bing özel arama ile topraklama için	Evet

WeeklyRecurrenceSchedule

Haftalık yineleme programı.

İsim	Türü	Description	Gerekli	Varsayılan
daysOfWeek	DayOfWeek dizisi	Yinelenme zamanlaması için haftanın günleri.	Evet
type	enum	Haftalık yineleme türü. Olası değerler: Weekly	Evet

WorkflowActionOutputItem

İsim	Türü	Description	Gerekli	Varsayılan
action_id	String	Eylem için benzersiz tanımlayıcı.	Evet
agent_reference	AgentReference		Hayı
└─ ad	String	Aracının adı. Kısıtlamalar: maxLength: 256	Evet
└─ türü	enum	Olası değerler: agent_reference	Evet
└─ sürümü	String	Aracının sürüm tanımlayıcısı.	Hayı
tür	String	CSDL eyleminin türü (örneğin, 'SetVariable', 'InvokeAzureAgent').	Evet
parent_action_id	String	Bu iç içe bir eylemse, üst eylemin kimliği.	Hayı
previous_action_id	String	Bu eylem başka bir eylemden sonra gelirse, önceki eylemin kimliği.	Hayı
response_id	String	Öğenin oluşturulduğu yanıt.	Hayı
durum	enum	Eylemin durumu (örneğin, 'in_progress', 'tamamlandı', 'başarısız', 'iptal edildi'). Olası değerler: completed, failed, in_progress, cancelled	Evet
type	enum	Olası değerler: workflow_action	Evet

WorkflowAgentDefinition

İş akışı aracısı tanımı.

İsim	Türü	Description	Gerekli	Varsayılan
tür	enum	Olası değerler: workflow	Evet
rai_config	RaiConfig	Sorumlu Yapay Zeka (RAI) içerik filtreleme ve güvenlik özellikleri için yapılandırma.	Hayı
└─ rai_policy_name	String	Uygulanacak RAI politikasının adı.	Evet
iş akışı	String	İş akışının CSDL YAML tanımı.	Hayı

tamsayı

Tür: tamsayı

Biçim: int64