Microsoft Dökümhanesi

API Sürümü: v1

Kimlik Doğrulaması

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

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

Name	Zorunlu	Türü	Description
Foundry-Features	Yanlış	Dize 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

Name	Türü	Description	Zorunlu	Varsayılan
tanım	AgentDefinition		Yes
└─ tür	AgentKind		Yes
└─ rai_config	RaiConfig	Sorumlu Yapay Zeka (RAI) içerik filtreleme ve güvenlik özellikleri için yapılandırma.	Hayır
Açıklama	Dize	Aracının insan tarafından okunabilir bir açıklaması. Kısıtlamalar: maxLength: 512	Hayır
metadata	Obje	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu olabilir 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ır
name	Dize	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	Yes

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	AgentObject

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/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

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
tür	soru	Hayır	Dize Olası değerler: prompt, hosted, container_app, workflow	Aracıları türe göre filtreleyin. Sağlanmazsa, tüm aracılar döndürülür.
limit	soru	Hayır	integer	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ır	Dize 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ır	Dize	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ır	Dize	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	Yes	Dize	Bu işlem için kullanılacak API sürümü.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	Obje	İstenen öğe listesi için yanıt verileri.

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/json	ApiErrorResponse

Aracılar - aracı alma

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

Aracıyı alır.

URI Parametreleri

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Yes	Dize	Alınacak aracının adı.
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	AgentObject

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/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

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Yes	Dize	Alınacak aracının adı.
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

Name	Zorunlu	Türü	Description
Foundry-Features	Yanlış	Dize 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

Name	Türü	Description	Zorunlu	Varsayılan
tanım	AgentDefinition		Yes
└─ tür	AgentKind		Yes
└─ rai_config	RaiConfig	Sorumlu Yapay Zeka (RAI) içerik filtreleme ve güvenlik özellikleri için yapılandırma.	Hayır
Açıklama	Dize	Aracının insan tarafından okunabilir bir açıklaması. Kısıtlamalar: maxLength: 512	Hayır
metadata	Obje	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu olabilir 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ır

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	AgentObject

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/json	ApiErrorResponse

Aracılar - aracıyı silme

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

Aracıyı siler.

URI Parametreleri

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Yes	Dize	Silinecek aracının adı.
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	DeleteAgentResponse

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/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

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Yes	Dize	Güncelleştirilecek aracının adı.
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.

İstek Gövdesi

İçerik Türü: application/json

Name	Türü	Description	Zorunlu	Varsayılan
Açıklama	Dize	Aracının insan tarafından okunabilir bir açıklaması. Kısıtlamalar: maxLength: 512	Hayır
manifest_id	Dize	Aracı sürümünü içeri aktaracak bildirim kimliği.	Yes
metadata	Obje	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu olabilir 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ır
parameter_values	Obje	Bildirime yapılan ve tam olarak gerçekleştirilmiş bir Aracı ile sonuçlanacak girişler.	Yes

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	AgentObject

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/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

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Yes	Dize	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	Yes	Dize	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

Name	Zorunlu	Türü	Description
Foundry-Features	Yanlış	Dize 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

Name	Türü	Description	Zorunlu	Varsayılan
tanım	AgentDefinition		Yes
└─ tür	AgentKind		Yes
└─ rai_config	RaiConfig	Sorumlu Yapay Zeka (RAI) içerik filtreleme ve güvenlik özellikleri için yapılandırma.	Hayır
Açıklama	Dize	Aracının insan tarafından okunabilir bir açıklaması. Kısıtlamalar: maxLength: 512	Hayır
metadata	Obje	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu olabilir 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ır

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	AgentVersionObject

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/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

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Yes	Dize	Sürümleri alınacak aracının adı.
limit	soru	Hayır	integer	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ır	Dize 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ır	Dize	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ır	Dize	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	Yes	Dize	Bu işlem için kullanılacak API sürümü.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	Obje	İstenen öğe listesi için yanıt verileri.

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/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

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Yes	Dize	Alınacak aracının adı.
agent_version	path	Yes	Dize	Alınacak aracı sürümü.
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	AgentVersionObject

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/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

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Yes	Dize	Silinecek aracının adı.
agent_version	path	Yes	Dize	Silinecek aracı sürümü
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	DeleteAgentVersionResponse

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/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

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Yes	Dize	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	Yes	Dize	Bu işlem için kullanılacak API sürümü.

İstek Gövdesi

İçerik Türü: application/json

Name	Türü	Description	Zorunlu	Varsayılan
Açıklama	Dize	Aracının insan tarafından okunabilir bir açıklaması. Kısıtlamalar: maxLength: 512	Hayır
manifest_id	Dize	Aracı sürümünü içeri aktaracak bildirim kimliği.	Yes
metadata	Obje	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu olabilir 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ır
parameter_values	Obje	Bildirime yapılan ve tam olarak gerçekleştirilmiş bir Aracı ile sonuçlanacak girişler.	Yes

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	AgentVersionObject

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/json	ApiErrorResponse

Aracılar - bildirimden aracı oluşturma

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

Bildirimden bir aracı oluşturur.

URI Parametreleri

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.

İstek Gövdesi

İçerik Türü: application/json

Name	Türü	Description	Zorunlu	Varsayılan
Açıklama	Dize	Aracının insan tarafından okunabilir bir açıklaması. Kısıtlamalar: maxLength: 512	Hayır
manifest_id	Dize	Aracı sürümünü içeri aktaracak bildirim kimliği.	Yes
metadata	Obje	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu olabilir 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ır
name	Dize	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	Yes
parameter_values	Obje	Bildirime yapılan ve tam olarak gerçekleştirilmiş bir Aracı ile sonuçlanacak girişler.	Yes

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	AgentObject

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/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

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Yes	Dize	Aracının adı.
limit	soru	Hayır	integer	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ır	Dize 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ır	Dize	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ır	Dize	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	Yes	Dize	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

Name	Zorunlu	Türü	Description
Foundry-Features	Yanlış	Dize 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.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	Obje	İstenen öğe listesi için yanıt verileri.

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/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

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Yes	Dize	Aracının adı.
operation_id	path	Yes	Dize	İşlem kimliği.
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

Name	Zorunlu	Türü	Description
Foundry-Features	Yanlış	Dize 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.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	AgentContainerOperationObject

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/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

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Yes	Dize	Aracının adı.
agent_version	path	Yes	Dize	Temsilcinin sürümü.
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

Name	Zorunlu	Türü	Description
Foundry-Features	Yanlış	Dize 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.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	AgentContainerObject

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/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

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Yes	Dize	Aracının adı.
agent_version	path	Yes	Dize	Temsilcinin sürümü.
limit	soru	Hayır	integer	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ır	Dize 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ır	Dize	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ır	Dize	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	Yes	Dize	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

Name	Zorunlu	Türü	Description
Foundry-Features	Yanlış	Dize 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.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	Obje	İstenen öğe listesi için yanıt verileri.

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/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. Eğer konteyner yoksa, işlem no-opolur. İşlem uzun süre çalışan bir işlemdir. Azure REST API'lerinde uzun süre çalışan işlemler için tasarım yönergelerini izleyin. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

URI Parametreleri

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Yes	Dize	Aracının adı.
agent_version	path	Yes	Dize	Temsilcinin sürümü.
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

Name	Zorunlu	Türü	Description
Foundry-Features	Yanlış	Dize 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.

Responses

Durum Kodu: 202

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

İçerik Türü	Türü	Tanım
application/json	AgentContainerOperationObject

Yanıt Üst Bilgileri:

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

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/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

Kapsayıcıdan metin öbekleri olarak akışla aktarılan kapsayıcı günlüğü girdisi. Her öbek, akışa alınan kapsayıcı günlüğünün türüne bağlı olarak düz metin günlüğü satırı veya JSON biçimli günlük girişi olabilecek bir UTF-8 dizesidir. İstemciler her öbekleri opak metin olarak işlemeli ve gerekirse günlük gereksinimlerine göre JSON olarak ayrıştırmaya çalışmalıdır.

Sistem günlükleri için, biçim şu yapıya sahip JSON'dir: {"TimeStamp":"2025-12-15T16:51:33Z","Type":"Normal","ContainerAppName":null,"RevisionName":null,"ReplicaName":null,"Msg":"Olay toplayıcısına bağlanma...","Reason":"StartingGettingEvents","EventSource":"ContainerAppController","Count":1} {"TimeStamp":"2025-12-15T16:51:34Z","Type":"Normal","ContainerAppName":null,"RevisionName":null,"ReplicaName":null,"Msg":"Olaylara başarıyla bağlandı server","Reason":"ConnectedToEventsServer","EventSource":"ContainerAppController","Count":1}

Konsol günlükleri için biçim, kapsayıcının stdout/stderr tarafından yayılan düz metindir. 2025-12-15T08:43:48.72656 'agent-container' kapsayıcısına bağlanıyor... 2025-12-15T08:43:48.75451 Successfully Connected to container: 'agent-container' [Revision: 'je90fe655aa742ef9a188b9fd14d6764--7tca06b', Replica: 'je90fe655aa742ef9a188b9fd14d6764--7tca06b-6898b9c89f-mpkjc'] 2025-12-15T08:33:59.0671054Z stdout F INFO: 127.0.0.1:42588 - "GET /readiness HTTP/1.1" 200 OK 2025-12-15T08:34:29.0649033Z stdout F INFO: 127.0.0.1:60246 - "GET /readiness HTTP/1.1" 200 OK 2025-12-15T08:34:59.0644467Z stdout F INFO: 127.0.0.1:43994 - "GET /readiness HTTP/1.1" 200 OK

URI Parametreleri

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Yes	Dize	Aracının adı.
agent_version	path	Yes	Dize	Temsilcinin sürümü.
tür	soru	Hayır	Dize Olası değerler: console, system	konsol, kapsayıcı stdout/stderr, sistem ise kapsayıcı uygulaması olay akışını döndürür. varsayılan olarak konsola
replica_name	soru	Hayır	Dize	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ır	integer	Döndürülen sondaki satır sayısı. 1-300'e zorlandı. Varsayılan değer: 20
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

Name	Zorunlu	Türü	Description
Foundry-Features	Yanlış	Dize 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.

Responses

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ü	Tanım
application/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. Eğer konteyner zaten çalışıyorsa, işlem no-opolacaktır. İşlem uzun süre çalışan bir işlemdir. Azure REST API'lerinde uzun süre çalışan işlemler için tasarım yönergelerini izleyin. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

URI Parametreleri

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Yes	Dize	Aracının adı.
agent_version	path	Yes	Dize	Temsilcinin sürümü.
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

Name	Zorunlu	Türü	Description
Foundry-Features	Yanlış	Dize 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

Name	Türü	Description	Zorunlu	Varsayılan
max_replicas	integer	En fazla çoğaltma sayısı. Varsayılan değer 1'tir.	Hayır	1
min_replicas	integer	En az çoğaltma sayısı. Varsayılan değer 1'tir.	Hayır	1

Responses

Durum Kodu: 202

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

İçerik Türü	Türü	Tanım
application/json	AgentContainerOperationObject

Yanıt Üst Bilgileri:

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

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/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. Konteyner çalışmıyorsa veya zaten durdurulmuşsa, işlem no-opolacaktır. İşlem uzun süre çalışan bir işlemdir. Azure REST API'lerinde uzun süre çalışan işlemler için tasarım yönergelerini izleyin. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

URI Parametreleri

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Yes	Dize	Aracının adı.
agent_version	path	Yes	Dize	Temsilcinin sürümü.
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

Name	Zorunlu	Türü	Description
Foundry-Features	Yanlış	Dize 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.

Responses

Durum Kodu: 202

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

İçerik Türü	Türü	Tanım
application/json	AgentContainerOperationObject

Yanıt Üst Bilgileri:

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

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/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. Konteyner çalışmıyorsa, işlem no-opolacaktır. İşlem uzun süre çalışan bir işlemdir. Azure REST API'lerinde uzun süre çalışan işlemler için tasarım yönergelerini izleyin. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

URI Parametreleri

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Yes	Dize	Aracının adı.
agent_version	path	Yes	Dize	Temsilcinin sürümü.
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

Name	Zorunlu	Türü	Description
Foundry-Features	Yanlış	Dize 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

Name	Türü	Description	Zorunlu	Varsayılan
max_replicas	integer	En fazla çoğaltma sayısı.	Hayır
min_replicas	integer	En az çoğaltma sayısı.	Hayır

Responses

Durum Kodu: 202

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

İçerik Türü	Türü	Tanım
application/json	AgentContainerOperationObject

Yanıt Üst Bilgileri:

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

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/json	ApiErrorResponse

Connections

Bağlantılar - liste

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

Bağlantı kimlik bilgilerini doldurmadan projedeki tüm bağlantıları listeleme

URI Parametreleri

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.
connectionType	soru	Hayır	Dize Olası değerler: AzureOpenAI, AzureBlob, AzureStorageAccount, , CognitiveSearch, CosmosDB, , ApiKey, AppConfigAppInsights, CustomKeys,RemoteTool_Preview	Bu tür bağlantıları listele
defaultConnection	soru	Hayır	boolean	Varsayılan bağlantılar olan bağlantıları listeleme

İstek Başlığı

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

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/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ü	Tanım
application/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	Dize	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

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.
name	path	Yes	Dize	Bağlantının kullanıcı tarafından sağlanan kolay adı.

İstek Başlığı

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

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	Connection

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ü	Tanım
application/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	Dize	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 bağlantı alma

URI Parametreleri

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.
name	path	Yes	Dize	Bağlantının kullanıcı tarafından sağlanan kolay adı.

İstek Başlığı

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

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	Connection

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ü	Tanım
application/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

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

Datasets

Veri kümeleri - en son liste

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

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

URI Parametreleri

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	PagedDatasetVersion

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	Dize	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 listeleme

URI Parametreleri

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.
name	path	Yes	Dize	Kaynağın adı

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	PagedDatasetVersion

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	Dize	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

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.
name	path	Yes	Dize	Kaynağın adı
version	path	Yes	Dize	Alınacak DatasetVersion'ın belirli sürüm kimliği.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	DatasetVersion

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	Dize	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 sürümünü silin. DatasetVersion başarıyla silindiyse veya DatasetVersion yoksa hizmet 204 İçerik Yok döndürür.

URI Parametreleri

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.
name	path	Yes	Dize	Kaynağın adı
version	path	Yes	Dize	Silinecek DatasetVersion sürümü.

Responses

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ü	Tanım
application/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	Dize	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

Yeni bir veri kümesi oluşturun veya mevcut bir DatasetVersion'i verilen sürüm kimliğiyle güncelleştirin

URI Parametreleri

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.
name	path	Yes	Dize	Kaynağın adı
version	path	Yes	Dize	Oluşturulacak veya güncelleştirilecek DatasetVersion'ın belirli sürüm kimliği.

İstek Gövdesi

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

Name	Türü	Description	Zorunlu	Varsayılan
Açıklama	Dize	Varlık açıklaması metni.	Hayır
tags	Obje	Etiket sözlüğü. Etiketler eklenebilir, kaldırılabilir ve güncelleştirilebilir.	Hayır
type	DatasetType	Veri türünü belirlemek için sabit listesi.	Yes

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/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ü	Tanım
application/json	DatasetVersion

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	Dize	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 kümesi sürümüyle ilişkili depolama hesabına erişmek için SAS kimlik bilgilerini alın.

URI Parametreleri

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.
name	path	Yes	Dize	Kaynağın adı
version	path	Yes	Dize	Üzerinde çalışılması gereken DatasetVersion'ın belirli sürüm kimliği.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	AssetCredentialResponse

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	Dize	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 başlangıç başlatın veya bir veri kümesinin bekleyen mevcut karşıya yüklemesini alın.

URI Parametreleri

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.
name	path	Yes	Dize	Kaynağın adı
version	path	Yes	Dize	Üzerinde çalışılması gereken DatasetVersion'ın belirli sürüm kimliği.

İstek Gövdesi

İçerik Türü: application/json

Name	Türü	Description	Zorunlu	Varsayılan
Connectionname	Dize	Geçici SAS belirteci oluşturmak için kullanılacak Azure Depolama Hesabı bağlantı adı	Hayır
pendingUploadId	Dize	PendingUploadId sağlanmazsa, rastgele bir GUID kullanılır.	Hayır
pendingUploadType	enum	BlobReference desteklenen tek türdür. Olası değerler: BlobReference	Yes

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	PendingUploadResponse

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

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

Dağıtımlar

Dağıtımlar - liste

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

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

URI Parametreleri

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.
modelPublisher	soru	Hayır	Dize	Modelleri filtrelemek için model yayımcısı
modelName	soru	Hayır	Dize	Modelleri filtrelemek için model adı (yayımcıya özgü ad)
deploymentType	soru	Hayır	Dize Olası değerler: ModelDeployment	Listeyi filtrelemek için dağıtım türü

İstek Başlığı

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

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/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ü	Tanım
application/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	Dize	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

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.
name	path	Yes	Dize	Dağıtımın adı

İstek Başlığı

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

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/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ü	Tanım
application/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

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

Değerlendirme Taksonomileri

Değerlendirme taksonomileri - liste

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

Değerlendirme taksonomilerini listeleme

URI Parametreleri

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.
inputName	soru	Hayır	Dize	Değerlendirme giriş adına göre filtreleyin.
inputType	soru	Hayır	Dize	Taksonomi giriş türüne göre filtreleyin.

İstek Başlığı

Name	Zorunlu	Türü	Description
Foundry-Features	True	Dize 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.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	PagedEvaluationTaxonomy

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

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

Değerlendirme taksonomileri - get

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

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

URI Parametreleri

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.
name	path	Yes	Dize	Kaynağın adı

İstek Başlığı

Name	Zorunlu	Türü	Description
Foundry-Features	True	Dize 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.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	EvaluationTaxonomy

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

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

Değerlendirme taksonomileri - silme

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

Değerlendirme taksonomilerini ada göre silin.

URI Parametreleri

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.
name	path	Yes	Dize	Kaynağın adı

İstek Başlığı

Name	Zorunlu	Türü	Description
Foundry-Features	True	Dize 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.

Responses

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ü	Tanım
application/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

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

Değerlendirme taksonomileri - oluşturma

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

Değerlendirme taksonomisi oluşturun.

URI Parametreleri

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.
name	path	Yes	Dize	Değerlendirme taksonomisinin adı.

İstek Başlığı

Name	Zorunlu	Türü	Description
Foundry-Features	True	Dize 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

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

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/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ü	Tanım
application/json	EvaluationTaxonomy

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	Dize	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

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.
name	path	Yes	Dize	Değerlendirme taksonomisinin adı.

İstek Başlığı

Name	Zorunlu	Türü	Description
Foundry-Features	True	Dize 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

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

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	EvaluationTaxonomy

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	Dize	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

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.
actionType	soru	Hayır	Dize Olası değerler: continuousEvaluation, humanEvaluationPreview	Değerlendirme kuralı türüne göre filtreleyin.
ajan adı	soru	Hayır	Dize	Temsilci adına göre filtreleyin.
enabled	soru	Hayır	boolean	Etkin duruma göre filtreleyin.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	PagedEvaluationRule

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

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

Değerlendirme kuralları - get

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

Değerlendirme kuralı alın.

URI Parametreleri

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.
kimlik	path	Yes	Dize	Değerlendirme kuralı için benzersiz tanımlayıcı.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	EvaluationRule

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	Dize	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

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.
kimlik	path	Yes	Dize	Değerlendirme kuralı için benzersiz tanımlayıcı.

Responses

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ü	Tanım
application/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	Dize	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

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.
kimlik	path	Yes	Dize	Değerlendirme kuralı için benzersiz tanımlayıcı.

İstek Başlığı

Name	Zorunlu	Türü	Description
Foundry-Features	Yanlış	Dize 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

Name	Türü	Description	Zorunlu	Varsayılan
action	EvaluationRuleAction	Değerlendirme eylem modeli.	Yes
└─ türü	EvaluationRuleActionType	Değerlendirme eyleminin türü.	Yes
Açıklama	Dize	Değerlendirme kuralının açıklaması.	Hayır
displayName	Dize	Değerlendirme kuralı için Görünen Ad.	Hayır
enabled	boolean	Değerlendirme kuralının etkinleştirilip etkinleştirilmediğini gösterir. Varsayılan değer doğrudur	Yes
eventType	EvaluationRuleEventType	Değerlendirme kuralı olayının türü.	Yes
filter	EvaluationRuleFilter	Değerlendirme filtresi modeli.	Hayır
└─ ajanName	Dize	Aracı adına göre filtreleyin.	Yes
kimlik	dize (salt okunur)	Değerlendirme kuralı için benzersiz tanımlayıcı.	Yes
sistem verileri	object (salt okunur)	Değerlendirme kuralı için sistem meta verileri.	Yes

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/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ü	Tanım
application/json	EvaluationRule

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	Dize	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

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.
type	soru	Hayır	Dize Olası değerler: builtin, custom, all	Değerlendiricileri türe göre filtreleyin. Olası değerler: 'all', 'custom', 'builtin'.
limit	soru	Hayır	integer	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ığı

Name	Zorunlu	Türü	Description
Foundry-Features	True	Dize 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.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	PagedEvaluatorVersion

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	Dize	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

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.
name	path	Yes	Dize	Kaynağın adı
type	soru	Hayır	Dize Olası değerler: builtin, custom, all	Değerlendiricileri türe göre filtreleyin. Olası değerler: 'all', 'custom', 'builtin'.
limit	soru	Hayır	integer	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ığı

Name	Zorunlu	Türü	Description
Foundry-Features	True	Dize 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.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	PagedEvaluatorVersion

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	Dize	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

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.
name	path	Yes	Dize	Kaynağın adı

İstek Başlığı

Name	Zorunlu	Türü	Description
Foundry-Features	True	Dize 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

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

Responses

Durum Kodu: 201

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

İçerik Türü	Türü	Tanım
application/json	EvaluatorVersion

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	Dize	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

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.
name	path	Yes	Dize	Kaynağın adı
version	path	Yes	Dize	Alınacak EvaluatorVersion'ın belirli sürüm kimliği.

İstek Başlığı

Name	Zorunlu	Türü	Description
Foundry-Features	True	Dize 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.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	EvaluatorVersion

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	Dize	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

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.
name	path	Yes	Dize	Kaynağın adı
version	path	Yes	Dize	Silinecek EvaluatorVersion sürümü.

İstek Başlığı

Name	Zorunlu	Türü	Description
Foundry-Features	True	Dize 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.

Responses

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ü	Tanım
application/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	Dize	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

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.
name	path	Yes	Dize	Kaynağın adı
version	path	Yes	Dize	Güncelleştirilecek EvaluatorVersion sürümü.

İstek Başlığı

Name	Zorunlu	Türü	Description
Foundry-Features	True	Dize 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

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

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	EvaluatorVersion

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

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

Indexes

Dizinler - en son liste

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

Her dizinin en son sürümünü listeleme

URI Parametreleri

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	PagedIndex

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	Dize	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 listeleme

URI Parametreleri

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.
name	path	Yes	Dize	Kaynağın adı

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	PagedIndex

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	Dize	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ü alın. Dizin yoksa hizmet 404 Bulunamadı hatası döndürür.

URI Parametreleri

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.
name	path	Yes	Dize	Kaynağın adı
version	path	Yes	Dize	Alınacak dizinin belirli sürüm kimliği.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	Dizin

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	Dize	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. Dizin başarıyla silindiyse veya Dizin yoksa hizmet 204 İçerik Yok döndürür.

URI Parametreleri

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.
name	path	Yes	Dize	Kaynağın adı
version	path	Yes	Dize	Silinecek dizinin sürümü.

Responses

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ü	Tanım
application/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	Dize	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

Belirtilen sürüm kimliğiyle yeni bir dizin oluşturun veya mevcut dizini güncelleştirin

URI Parametreleri

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.
name	path	Yes	Dize	Kaynağın adı
version	path	Yes	Dize	Oluşturulacak veya güncelleştirilecek dizinin belirli sürüm kimliği.

İstek Gövdesi

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

Name	Türü	Description	Zorunlu	Varsayılan
Açıklama	Dize	Varlık açıklaması metni.	Hayır
tags	Obje	Etiket sözlüğü. Etiketler eklenebilir, kaldırılabilir ve güncelleştirilebilir.	Hayır
type	IndexType		Yes

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/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ü	Tanım
application/json	Dizin

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

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

Insights

İçgörüler - oluşturma

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

İçgörü oluşturma

URI Parametreleri

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

Name	Zorunlu	Türü	Description
Foundry-Features	True	Dize 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ış	Dize	İ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ış	Dize	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

Name	Türü	Description	Zorunlu	Varsayılan
displayName	Dize	İçgörü için kullanıcı dostu görünen ad.	Yes
kimlik	dize (salt okunur)	İçgörüler raporunun benzersiz tanımlayıcısı.	Yes
metadata	InsightsMetadata (salt okunur)	İçgörülerle ilgili meta veriler.	Yes
└─ tamamlandıAt	Dize	İçgörülerin tamamlandığı zaman damgası.	Hayır
└─ oluşturuldu	Dize	İçgörülerin oluşturulduğu zaman damgası.	Yes
talep	InsightRequest	İçgörüler raporunun isteği.	Yes
└─ türü	InsightType	İstek türü.	Yes
result	InsightResult (salt okunur)	İçgörülerin sonucu.	Hayır
└─ türü	InsightType	İçgörü sonucunun türü.	Yes
state	Azure. Core.Foundations.OperationState (salt okunur)	İzin verilen işlem durumlarını açıklayan sabit listesi.	Yes

Responses

Durum Kodu: 201

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

İçerik Türü	Türü	Tanım
application/json	Insight

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	Dize	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ırada listeleyin (ilk olarak en yeni).

URI Parametreleri

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

İstek Başlığı

Name	Zorunlu	Türü	Description
Foundry-Features	True	Dize 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.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	PagedInsight

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

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

İçgörüler - get

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

Kimlik bilgilerine göre belirli bir içgörü elde edin.

URI Parametreleri

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.
kimlik	path	Yes	Dize	İçgörüler raporunun benzersiz tanımlayıcısı.
includeCoordinates	soru	Hayır	boolean	Yanıta görselleştirme için koordinatların dahil edilip edilmeyeceği. Varsayılan değer false'tur.

İstek Başlığı

Name	Zorunlu	Türü	Description
Foundry-Features	True	Dize 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.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	Insight

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	Dize	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

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

Name	Zorunlu	Türü	Description
Foundry-Features	True	Dize 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

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

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	MemoryStoreObject

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/json	ApiErrorResponse

Bellek depolarını listeleme

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

Tüm bellek depolarını listeleyin.

URI Parametreleri

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
limit	soru	Hayır	integer	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ır	Dize 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ır	Dize	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ır	Dize	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	Yes	Dize	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

Name	Zorunlu	Türü	Description
Foundry-Features	True	Dize 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.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	Obje	İstenen öğe listesi için yanıt verileri.

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/json	ApiErrorResponse

Bellek depolarını güncelleştirme

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

Bellek deposunu güncelleştirin.

URI Parametreleri

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
name	path	Yes	Dize	Güncelleştirilecek bellek deposunun adı.
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

Name	Zorunlu	Türü	Description
Foundry-Features	True	Dize 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

Name	Türü	Description	Zorunlu	Varsayılan
Açıklama	Dize	Bellek deposunun okunabilir bir açıklaması. Kısıtlamalar: maxLength: 512	Hayır
metadata	Obje	Bellek deposuyla ilişkilendirilecek rastgele anahtar-değer meta verileri.	Hayır

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	MemoryStoreObject

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/json	ApiErrorResponse

Bellek deposu alma

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

Bir bellek deposu alın.

URI Parametreleri

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
name	path	Yes	Dize	Alınacak bellek deposunun adı.
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

Name	Zorunlu	Türü	Description
Foundry-Features	True	Dize 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.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	MemoryStoreObject

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/json	ApiErrorResponse

Bellek depolarını silme

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

Bellek deposunu silin.

URI Parametreleri

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
name	path	Yes	Dize	Silinecek bellek deposunun adı.
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

Name	Zorunlu	Türü	Description
Foundry-Features	True	Dize 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.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	DeleteMemoryStoreResponse

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/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

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
name	path	Yes	Dize	Bellek deposunun adı.
update_id	path	Yes	Dize	Bellek güncelleştirme işleminin kimliği.
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

Name	Zorunlu	Türü	Description
Foundry-Features	True	Dize 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.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	MemoryStoreUpdateResponse

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/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

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
name	path	Yes	Dize	Bellek deposunun adı.
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

Name	Zorunlu	Türü	Description
Foundry-Features	True	Dize 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

Name	Türü	Description	Zorunlu	Varsayılan
scope	Dize	Kullanıcı kimliği gibi silinecek bellekleri mantıksal olarak gruplandıran ve yalıtan ad alanı.	Yes

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	MemoryStoreDeleteScopeResponse

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/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

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
name	path	Yes	Dize	Aranacak bellek deposunun adı.
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

Name	Zorunlu	Türü	Description
Foundry-Features	True	Dize 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

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

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	MemoryStoreSearchResponse

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/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

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
name	path	Yes	Dize	Güncelleştirilecek bellek deposunun adı.
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

Name	Zorunlu	Türü	Description
Foundry-Features	True	Dize 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

Name	Türü	Description	Zorunlu	Varsayılan
items	OpenAI.InputItem dizisi	Anıları ayıklamak için konuşma öğeleri.	Hayır
previous_update_id	Dize	Önceki güncelleştirme isteğinin benzersiz kimliği, son işlemin kaldığı yerden artımlı bellek güncelleştirmelerini etkinleştirir.	Hayır
scope	Dize	Kullanıcı kimliği gibi anıları mantıksal olarak gruplandıran ve yalıtan ad alanı.	Yes
update_delay	integer	Bellek güncelleştirmesini saniye cinsinden işlemeden önce zaman aşımı süresi. Bu süre boyunca yeni bir güncelleştirme isteği alınırsa geçerli isteği iptal eder ve zaman aşımını sıfırlar. Güncelleştirmeyi gecikmeden hemen tetiklemesi için 0 olarak ayarlayın. Varsayılan değer: 300 (5 dakika).	Hayır	300

Responses

Durum Kodu: 202

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

İçerik Türü	Türü	Tanım
application/json	MemoryStoreUpdateResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
İşlem Konumu	Dize	İşlem durumunu izlemek için konum.

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/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

Name	Türü	Description	Zorunlu	Varsayılan
items	OpenAI.InputItem dizisi		Hayır
metadata	OpenAI.Metadata (null atanabilir)	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu olabilir 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ır

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	OpenAI.ConversationResource

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/json	ApiErrorResponse

Konuşmaları listeleme

GET {endpoint}/openai/v1/conversations

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

URI Parametreleri

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
limit	soru	Hayır	integer	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ır	Dize 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ır	Dize	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ır	Dize	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ır	Dize	Aracı 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ır	Dize	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.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	Obje	İstenen öğe listesi için yanıt verileri.

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/json	ApiErrorResponse

Konuşmayı güncelleştirme

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

Bir konuşmayı güncelleştirme.

URI Parametreleri

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	path	Yes	Dize	Güncelleştirilecek konuşmanın kimliği.

İstek Gövdesi

İçerik Türü: application/json

Name	Türü	Description	Zorunlu	Varsayılan
metadata	OpenAI.Metadata (null atanabilir)	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu olabilir 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.	Yes

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	OpenAI.ConversationResource

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/json	ApiErrorResponse

Konuşma alma

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

Bir konuşmayı alır.

URI Parametreleri

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	path	Yes	Dize	Alınacak konuşmanın kimliği.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	OpenAI.ConversationResource

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/json	ApiErrorResponse

Konuşmayı silme

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

Bir konuşmayı siler.

URI Parametreleri

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	path	Yes	Dize	Silinecek konuşmanın kimliği.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	OpenAI.DeletedConversationResource

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/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

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	path	Yes	Dize	Öğenin oluşturulması gereken konuşmanın kimliği.
include	soru	Hayır	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

Name	Türü	Description	Zorunlu	Varsayılan
items	OpenAI.Item dizisi	Konuşmaya eklenecek öğeler. Bir kerede en fazla 20 öğe ekleyebilirsiniz.	Yes

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	OpenAI.ConversationItemList

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/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

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	path	Yes	Dize	Öğelerin listelenmesi gereken konuşmanın kimliği.
limit	soru	Hayır	integer	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ır	Dize 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ır	Dize	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ır	Dize	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ır	Dize 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.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	Obje	İstenen öğe listesi için yanıt verileri.

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/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

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	path	Yes	Dize	Öğeyi içeren konuşmanın kimliği.
item_id	path	Yes	Dize	Alınacak konuşma öğesinin kimliği.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	OpenAI.OutputItem

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/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

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	path	Yes	Dize	Öğenin silinmesi gereken konuşmanın kimliği.
item_id	path	Yes	Dize	Silinecek konuşma öğesinin kimliği.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	OpenAI.ConversationResource

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/json	ApiErrorResponse

Değerlendirmeler

Değerlendirmeler - değerlendirmeleri listeleme

GET {endpoint}/openai/v1/evals

Tüm değerlendirmeleri listeleme Proje için değerlendirmeleri listeleyin.

URI Parametreleri

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
after	soru	Hayır	Dize	Önceki sayfalandırma isteğindeki son çalıştırma tanımlayıcısı.
limit	soru	Hayır	integer	Alınacak koşu sayısı.
order	soru	Hayır	Dize 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 değer asc’dır.
sırala_göre	soru	Hayır	Dize 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.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	Obje	İstenen öğe listesi için yanıt verileri.

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/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

Name	Türü	Description	Zorunlu	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.	Yes
metadata	OpenAI.Metadata (null atanabilir)	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu olabilir 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ır
name	Dize	Değerlendirmenin adı.	Hayır
properties	Obje	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ır
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. Değerlendirenler, {{item.variable_name}} gibi çift küme parantez gösterimini kullanarak veri kaynağındaki değişkenlere başvurabilir. Modelin çıkışına başvurmak için sample ad alanına atıfta bulunun (örneğin, {{sample.output_text}}).	Yes

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	Değerlendirme

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/json	ApiErrorResponse

Değerlendirmeler - değerlendirmeyi silme

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

Değerlendirmeyi silme Değerlendirmeyi silin.

URI Parametreleri

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Yes	Dize	Silinecek değerlendirmenin kimliği.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	DeleteEvalResponse

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/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

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Yes	Dize	Elde edilecek değerlendirmenin kimliği.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	Değerlendirme

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/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

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Yes	Dize	Güncelleştirilecek değerlendirmenin kimliği.

İstek Gövdesi

İçerik Türü: application/json

Name	Türü	Description	Zorunlu	Varsayılan
metadata	OpenAI.Metadata (null atanabilir)	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu olabilir 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ır
name	Dize		Hayır
properties	Obje	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ır

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	Değerlendirme

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/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

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Yes	Dize	Çalıştırmaları almak için kullanılacak değerlendirmenin kimliği.
after	soru	Hayır	Dize	Önceki sayfalandırma isteğindeki son çalıştırma tanımlayıcısı.
limit	soru	Hayır	integer	Alınacak koşu sayısı.
order	soru	Hayır	Dize 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 değer asc’dır.
durum	soru	Hayır	Dize Olası değerler: queued, in_progress, completed, canceled, failed . Filtre duruma göre çalışır. queued, , in_progress, failed, completed. canceled

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	Obje	İstenen öğe listesi için yanıt verileri.

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/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

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Yes	Dize	Çalıştırma oluşturulacak değerlendirmenin kimliği.

İstek Gövdesi

İçerik Türü: application/json

Name	Türü	Description	Zorunlu	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.	Yes
metadata	OpenAI.Metadata (null atanabilir)	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu olabilir 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ır
name	Dize	Koşunun adı.	Hayır
properties	Obje	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ır

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	EvalRun

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/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

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Yes	Dize	Silinmesi istenen çalışmanın değerlendirmenin kimliği.
run_id	path	Yes	Dize	Silinecek çalıştırmanın kimliği.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	DeleteEvalRunResponse

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/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

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Yes	Dize	Çalıştırmaları almak için kullanılacak değerlendirmenin kimliği.
run_id	path	Yes	Dize	Alınacak çalıştırmanın kimliği.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	EvalRun

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/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

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Yes	Dize	Çalıştırmasını iptal etmek istediğiniz değerlendirmenin kimliği.
run_id	path	Yes	Dize	İptal edilen çalıştırmanın kimliği.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	EvalRun

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/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

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Yes	Dize
run_id	path	Yes	Dize	Çıkış öğelerini almak için çalıştırmanın kimliği.
after	soru	Hayır	Dize	Önceki sayfalandırma isteğindeki son çalıştırma tanımlayıcısı.
limit	soru	Hayır	integer	Alınacak koşu sayısı.
order	soru	Hayır	Dize 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 değer asc’dır.
durum	soru	Hayır	Dize 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.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	Obje	İstenen öğe listesi için yanıt verileri.

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/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

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Yes	Dize	Çalıştırmaları almak için kullanılacak değerlendirmenin kimliği.
run_id	path	Yes	Dize	Alınacak çalıştırmanın kimliği.
çıktı_öğe_kimliği	path	Yes	Dize	Alınacak çıkış öğesinin kimliği.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	EvalRunOutputItem

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/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 bir modelin oluşturulması sürecine başlayan bir ince ayar görevi oluşturur.

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

İnce ayarlama hakkında daha fazla bilgi edinin

URI Parametreleri

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.

İstek Gövdesi

İçerik Türü: application/json

Name	Türü	Description	Zorunlu	Varsayılan
hiper parametreler	OpenAI.CreateFineTuningJobRequestHyperparameters		Hayır
└─ yığın boyutu	dize veya OpenAI.integer		Hayır	otomatik
└─ öğrenme oranı çarpanı	dize veya OpenAI.numeric		Hayır
└─ n_epochs	dize veya OpenAI.integer		Hayır	otomatik
Entegrasyonlar	OpenAI.CreateFineTuningJobRequestIntegrations dizisi	İnce ayar işiniz için etkinleştirilecek entegrasyonların listesi.	Hayır
metadata	OpenAI.Metadata (null atanabilir)	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu olabilir 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ır
method	OpenAI.FineTuneMethod	İnce ayar için kullanılan yöntem.	Hayır
model	dize (aşağıdaki geçerli modellere bakın)	İnce ayar yapılacak modelin adı. Aşağıdakilerden birini seçebilirsiniz: desteklenen modeller.	Yes
seed	OpenAI.integer (null atanabilir)		Hayır
suffix	dize (null atanabilir)	İnce ayarlı model adınıza eklenecek en fazla 64 karakterlik bir dize. Örneğin, "özel model-adı" olan bir suffix, ft:gpt-4o-mini:openai:custom-model-name:7p4lURel gibi bir model adı üretir. Kısıtlamalar: minLength: 1, maxLength: 64	Hayır
eğitim_dosyası	Dize	Eğitim verilerini içeren karşıya yüklenen bir dosyanın kimliği. Dosya yükle için dosya yükleme konusunda bkz. Veri kümeniz JSONL dosyası olarak biçimlendirilmelidir. Ayrıca, dosyanızı fine-tune amacıyla 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 ayrıntı için ince ayar kılavuzuna bakın.	Yes
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 ince ayarlama sırasında metrikleri düzenli aralıklarla değerlendirin. Bu ölçümler, ... içinde görüntülenebilir. Ince ayar sonucu 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ı fine-tune amacıyla yüklemeniz gerekir. Daha fazla ayrıntı için ince ayar kılavuzuna bakın.	Hayır

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	OpenAI.FineTuningJob

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/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

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
after	soru	Hayır	Dize	Önceki sayfalandırma isteğindeki son işin tanımlayıcısı.
limit	soru	Hayır	integer	Elde edilecek ince ayar işlerinin sayısı.
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	OpenAI.ListPaginatedFineTuningJobsResponse

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/json	ApiErrorResponse

hassas ayarlama işini alma

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

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

İnce ayarlama hakkında daha fazla bilgi edinin

URI Parametreleri

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
ince_ayarlama_iş_id	path	Yes	Dize	İnce ayar işinin kimlik numarası.
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	OpenAI.FineTuningJob

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/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

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
ince_ayarlama_iş_id	path	Yes	Dize	İptal edilecek ince ayar görevinin kimliği.
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	OpenAI.FineTuningJob

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/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

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
ince_ayarlama_iş_id	path	Yes	Dize	İnce ayar görevine ait kontrol noktalarını almak için kimlik numarası.
after	soru	Hayır	Dize	Önceki sayfalandırma isteğindeki son denetim noktası kimliğinin tanımlayıcısı.
limit	soru	Hayır	integer	Geri alınacak kontrol noktası sayısı.
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	OpenAI.ListFineTuningJobCheckpointsResponse

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/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

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
ince_ayarlama_iş_id	path	Yes	Dize	İnce ayar işine ait olayları almak için işin kimliği.
after	soru	Hayır	Dize	Önceki sayfalandırma isteğindeki son olayın tanımlayıcısı.
limit	soru	Hayır	integer	Alınacak olay sayısı.
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	OpenAI.ListFineTuningJobEventsResponse

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/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

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
ince_ayarlama_iş_id	path	Yes	Dize	Duraklatılacak olan ince ayar işinin kimliği.
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	OpenAI.FineTuningJob

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/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şine devam et.

URI Parametreleri

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
ince_ayarlama_iş_id	path	Yes	Dize	Yeniden başlatılacak ince ayar işinin kimliği.
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	OpenAI.FineTuningJob

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/json	ApiErrorResponse

Responses

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

Name	Türü	Description	Zorunlu	Varsayılan
agent_reference	AgentReference		Hayır
└─ ad	Dize	Aracının adı. Kısıtlamalar: maxLength: 256	Yes
└─ türü	enum	Olası değerler: agent_reference	Yes
└─ sürümü	Dize	Aracının sürüm tanımlayıcısı.	Hayır
arka plan	boole değeri (null atanabilir)		Hayır
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ır
include	OpenAI.IncludeEnum dizisi		Hayır
input	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ır
instructions	dize (null atanabilir)		Hayır
max_output_tokens	OpenAI.integer (null atanabilir)		Hayır
max_tool_calls	OpenAI.integer (null atanabilir)		Hayır
metadata	OpenAI.Metadata (null atanabilir)	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu olabilir 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ır
model	Dize	Bu yanıtın oluşturulması için kullanılacak model dağıtımı.	Hayır
paralel araç çağrıları	boole değeri (null atanabilir)		Hayır	True
previous_response_id	dize (null atanabilir)		Hayır
prompt	OpenAI.Prompt	Bir komut şablonuna ve değişkenlerine referans. Daha fazla bilgi edinin.	Hayır
prompt_cache_key	Dize	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ır
prompt_cache_retention	enum	Olası değerler: in-memory, 24h	Hayır
reasoning	OpenAI.Reasoning (null atanabilir)	yalnızca gpt-5 ve o serisi modeller İçin yapılandırma seçenekleri mantık modelleri.	Hayır
└─ çaba	OpenAI.ReasoningEffort	Akıl yürütmeye yönelik çabayı kısıtlar mantık 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ır
└─ özet oluştur	enum	Olası değerler: auto, concise, detailed	Hayır
└─ özeti	enum	Olası değerler: auto, concise, detailed	Hayır
safety_identifier	Dize	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ır
hizmet seviyesi	OpenAI.ServiceTier	İsteğin sunulması için kullanılan işleme türünü belirtir. - 'otomatik' olarak ayarlanırsa istek, Project ayarlarında yapılandırılan hizmet katmanıyla işlenir. Aksi yapılandırılmadığı sürece, Project 'default' kullanır. - 'varsayılan' olarak ayarlanırsa, istek seçilen model için standart fiyatlandırma ve performansla işlenir. - 'esnek' veya 'öncelik' olarak ayarlanırsa istek ilgili hizmet katmanıyla işlenir. - 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ır
store	boole değeri (null atanabilir)		Hayır	True
veri akışı	boole değeri (null atanabilir)		Hayır
stream_options	OpenAI.ResponseStreamOptions (null atanabilir)	Akış yanıtları için seçenekler. Bunu yalnızca stream: true ayarladığınızda yapılandırın.	Hayır
└─ 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ır
structured_inputs	Obje	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ır
sıcaklık	OpenAI.numeric (null atanabilir)		Hayır	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ır
tool_choice	OpenAI.ToolChoiceOptions veya OpenAI.ToolChoiceParam		Hayır
tools	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ır
top_logprobs	OpenAI.integer (null atanabilir)		Hayır
top_p	OpenAI.numeric (null atanabilir)		Hayır	1
truncation	enum	Olası değerler: auto, disabled	Hayır
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ır

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	OpenAI.Response
text/event-stream	OpenAI.CreateResponseStreamingResponse

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/json	ApiErrorResponse

Yanıtları listeleme

GET {endpoint}/openai/v1/responses

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

URI Parametreleri

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
limit	soru	Hayır	integer	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ır	Dize 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ır	Dize	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ır	Dize	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ır	Dize	Aracı 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ır	Dize	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ır	Dize	Konuşma kimliğine göre filtreleyin. Sağlanırsa, yalnızca belirtilen konuşmayla ilişkili yanıtlar döndürülür.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	Obje	İstenen öğe listesi için yanıt verileri.

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/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

Name	Türü	Description	Zorunlu	Varsayılan
input	OpenAI.InputItem dizesi veya dizisi		Hayır
instructions	dize (null atanabilir)		Hayır
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.	Yes
previous_response_id	dize (null atanabilir)		Hayır

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	OpenAI.CompactResource

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/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

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
response_id	path	Yes	Dize
include[]	soru	Hayır	Dizi
veri akışı	soru	Hayır	boolean
starting_after	soru	Hayır	integer

İstek Başlığı

Name	Zorunlu	Türü	Description
kabul et	Yanlış	Dize Olası değerler: text/event-stream

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	OpenAI.Response
text/event-stream	OpenAI.CreateResponseStreamingResponse

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/json	ApiErrorResponse

Yanıtı silme

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

Model yanıtlarını siler.

URI Parametreleri

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
response_id	path	Yes	Dize	Silinecek yanıtın kimliği.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	DeleteResponseResult

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/json	ApiErrorResponse

Yanıtı iptal et

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

Model yanıtlarını iptal eder.

URI Parametreleri

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
response_id	path	Yes	Dize	İptal edilecek yanıtın kimliği.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	OpenAI.Response

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/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

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
response_id	path	Yes	Dize
limit	soru	Hayır	integer	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ır	Dize 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ır	Dize	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ır	Dize	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.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	Obje	İstenen öğe listesi için yanıt verileri.

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/json	ApiErrorResponse

Redteams

Redteams - liste

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

Bir redteam'i ada göre listeleyin.

URI Parametreleri

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

Name	Zorunlu	Türü	Description
Foundry-Features	True	Dize 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.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	PagedRedTeam

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

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

Redteams -

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

Ada göre bir yeniden cihaz edinin.

URI Parametreleri

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.
name	path	Yes	Dize	Kırmızı takım çalıştırmasının tanımlayıcısı.

İstek Başlığı

Name	Zorunlu	Türü	Description
Foundry-Features	True	Dize 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.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	RedTeam

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	Dize	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

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

Name	Zorunlu	Türü	Description
Foundry-Features	True	Dize 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

Name	Türü	Description	Zorunlu	Varsayılan
applicationScenario	Dize	Senaryoya özgü saldırılar oluşturmak için kırmızı takım işlemine yönelik uygulama senaryosu.	Hayır
attackStrategies	AttackStrategy dizisi	Saldırı stratejilerinin listesi veya saldırı stratejilerinin iç içe yerleştirilmiş listeleri.	Hayır
displayName	Dize	Kırmızı takım çalıştırmasının adı.	Hayır
kimlik	dize (salt okunur)	Kırmızı takım çalıştırmasının tanımlayıcısı.	Yes
numTurns	integer	Benzetimi yuvarlama sayısı.	Hayır
properties	Obje	Kırmızı takımın özellikleri. Etiketlerden farklı olarak özellikler yalnızca eklentidir. Bir özellik eklendikten sonra kaldırılamaz.	Hayır
risk Kategorileri	RiskCategory dizisi	Saldırı hedeflerinin oluşturulacağı risk kategorilerinin listesi.	Hayır
simulationOnly	boolean	Yalnızca simülasyon veya Simülasyon + Değerlendirme. Varsayılan false, true ise tarama konuşmanın değerlendirme sonucunu değil çıkışını oluşturur.	Hayır	Yanlış
durum	dize (salt okunur)	Kırmızı takımın durumu. Hizmete göre ayarlanır ve salt okunurdur.	Hayır
tags	Obje	Kırmızı takımın etiketleri. Özelliklerden farklı olarak etiketler tamamen değişebilir.	Hayır
target	TargetConfig	Hedef yapılandırma için soyut sınıf.	Yes
└─ türü	Dize	Model yapılandırmasının türü.	Yes

Responses

Durum Kodu: 201

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

İçerik Türü	Türü	Tanım
application/json	RedTeam

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/json	ApiErrorResponse

Programlar

Zamanlamalar - liste

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

Tüm zamanlamaları listeleyin.

URI Parametreleri

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.
type	soru	Hayır	Dize Olası değerler: Evaluation, Insight	Zamanlama türüne göre filtreleyin.
enabled	soru	Hayır	boolean	Etkin duruma göre filtreleyin.

İstek Başlığı

Name	Zorunlu	Türü	Description
Foundry-Features	True	Dize 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.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	PagedSchedule

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

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

Zamanlamalar - silme

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

Bir programı sil.

URI Parametreleri

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.
kimlik	path	Yes	Dize	Zamanlamanın tanımlayıcısı.

İstek Başlığı

Name	Zorunlu	Türü	Description
Foundry-Features	True	Dize 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.

Responses

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ü	Tanım
application/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

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

Zamanlamalar - get

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

Kimliğine göre bir zamanlama alın.

URI Parametreleri

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.
kimlik	path	Yes	Dize	Zamanlamanın tanımlayıcısı.

İstek Başlığı

Name	Zorunlu	Türü	Description
Foundry-Features	True	Dize 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.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	Schedule

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	Dize	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

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.
kimlik	path	Yes	Dize	Zamanlamanın tanımlayıcısı.

İstek Başlığı

Name	Zorunlu	Türü	Description
Foundry-Features	True	Dize 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

Name	Türü	Description	Zorunlu	Varsayılan
Açıklama	Dize	Zamanlamanın açıklaması.	Hayır
displayName	Dize	Zamanlamanın adı.	Hayır
enabled	boolean	Zamanlamanın durumu etkin.	Yes
kimlik	dize (salt okunur)	Zamanlamanın tanımlayıcısı.	Yes
properties	Obje	Zamanlamanın özellikleri. Etiketlerden farklı olarak özellikler yalnızca eklentidir. Bir özellik eklendikten sonra kaldırılamaz.	Hayır
provisioningStatus	ScheduleProvisioningStatus (salt okunur)	Sağlama durumunu zamanlayın.	Hayır
sistem verileri	object (salt okunur)	Kaynak için sistem meta verileri.	Yes
tags	Obje	Zamanlama etiketleri. Özelliklerden farklı olarak etiketler tamamen değişebilir.	Hayır
görev	ScheduleTask	Zamanlama görev modeli.	Yes
└─ yapılandırması	Obje	Görevin yapılandırması.	Hayır
└─ türü	ScheduleTaskType	Görevin türü.	Yes
trigger	Trigger	Zamanlamanın tetikleyicisi için temel model.	Yes
└─ türü	TriggerType	Tetikleyicinin türü.	Yes

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	Schedule

Durum Kodu: 201

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

İçerik Türü	Türü	Tanım
application/json	Schedule

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	Dize	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

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.
kimlik	path	Yes	Dize	Zamanlamanın tanımlayıcısı.
type	soru	Hayır	Dize Olası değerler: Evaluation, Insight	Zamanlama türüne göre filtreleyin.
enabled	soru	Hayır	boolean	Etkin duruma göre filtreleyin.

İstek Başlığı

Name	Zorunlu	Türü	Description
Foundry-Features	True	Dize 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.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	PagedScheduleRun

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/json	Azure. Core.Foundations.ErrorResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
x-ms-error-code	Dize	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

Kimlikle çalıştırılan bir zamanlama alın.

URI Parametreleri

Name	In	Zorunlu	Türü	Description
endpoint	path	Yes	Dize	Formda döküm Project uç noktası "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Foundry Hub'ınızda yalnızca bir Project varsa veya varsayılan Project hub'ınızda formu kullanın "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
schedule_id	path	Yes	Dize	Zamanlamanın benzersiz tanımlayıcısı.
run_id	path	Yes	Dize	Zamanlama çalıştırmasının benzersiz tanımlayıcısı.
API sürümü	soru	Yes	Dize	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

Name	Zorunlu	Türü	Description
Foundry-Features	True	Dize 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.

Responses

Durum Kodu: 200

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

İçerik Türü	Türü	Tanım
application/json	ScheduleRun

Durum Kodu: varsayılan

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

İçerik Türü	Türü	Tanım
application/json	ApiErrorResponse

Components

A2APreviewTool

A2A protokolünü uygulayan bir aracı.

Name	Türü	Description	Zorunlu	Varsayılan
agent_card_path	Dize	Temsilci kartına göre base_urlgiden yol. Sağlanmazsa, varsayılan olarak /.well-known/agent-card.json	Hayır
base_url	Dize	Aracının temel URL'si.	Hayır
project_connection_id	Dize	A2A sunucusunun project 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ır
type	enum	Aracın türü. Her zaman "a2a_preview. Olası değerler: a2a_preview	Yes

AISearchIndexResource

Bir AI Arama Dizini kaynağı.

Name	Türü	Description	Zorunlu	Varsayılan
filter	Dize	arama kaynağı için filtre dizesi. Burada daha fazla bilgi edinebilirsiniz.	Hayır
index_asset_id	Dize	Arama kaynağı için dizin varlığı kimliği.	Hayır
endeks_adı	Dize	Bu aracıya bağlı bir IndexResource'taki dizinin adı.	Hayır
project_connection_id	Dize	Bu aracıya bağlı bir IndexResource'taki dizin bağlantı kimliği.	Hayır
sorgu_türü	AzureAISearchQueryType	Azure Yapay Zeka Arama tool için mevcut query types.	Hayır
top_k	integer	Aramadan alınacak ve modele sunulacak belge sayısı.	Hayır

AgentClusterInsightRequest

Temsilci Değerlendirme Sonuçları kümesine ilişkin bilgiler

Name	Türü	Description	Zorunlu	Varsayılan
ajan adı	Dize	Aracının tanımlayıcısı.	Yes
model yapılandırması	InsightModelConfiguration	İçgörü oluşturmada kullanılan modelin yapılandırması.	Hayır
└─ modelDeploymentName	Dize	Değerlendirilecek model dağıtımı. Dağıtım adını tek başına veya bağlantı adı olarak {connectionName}/<modelDeploymentName>kabul eder.	Yes
type	enum	İstek türü. Olası değerler: AgentClusterInsight	Yes

AgentClusterInsightResult

Aracı küme analizinden elde edilen bilgiler.

Name	Türü	Description	Zorunlu	Varsayılan
clusterInsight	ClusterInsightResult	Küme analizinden elde edilen bilgiler.	Yes
type	enum	İçgörü sonucunun türü. Olası değerler: AgentClusterInsight	Yes

AgentContainerObject

Bir aracının belirli bir sürümünün kapsayıcısının ayrıntıları.

Name	Türü	Description	Zorunlu	Varsayılan
container	ContainerDetails (salt okunur)	Kapsayıcı hakkında ayrıntılı bilgi.	Hayır
└─ health_state	Dize	Kapsayıcının sistem durumu.	Yes
└─ provisioning_error	Dize	Varsa kapsayıcının sağlama hatası.	Hayır
└─ provisioning_state	Dize	Kapsayıcının sağlama durumu.	Yes
└─ çoğaltmaları	ContainerReplica dizisi	Kapsayıcıdaki çoğaltmaların listesi.	Yes
└─ durumu	Dize	Kapsayıcının durumu.	Yes
└─ updated_on	Dize	Kapsayıcının son güncelleştirme zamanı.	Yes
oluşturulma_tarihi	Dize	Kapsayıcının oluşturma zamanı.	Yes
Error_message	dize (salt okunur)	Varsa, kapsayıcı çalışamadıysa hata iletisi.	Hayır
kimlik	dize (salt okunur)	Kapsayıcının tanımlayıcısı.	Hayır
max_replicas	integer	Kapsayıcı için en fazla çoğaltma sayısı. Varsayılan değer 1'dir.	Hayır
min_replicas	integer	Kapsayıcı için en az çoğaltma sayısı. Varsayılan değer 1'dir.	Hayır
Obje	enum	Her zaman 'agent.container' olan nesne türü. Olası değerler: agent.container	Yes
durum	AgentContainerStatus (salt okunur)	Aracının belirli bir sürümünün kapsayıcısının durumu.	Yes
updated_at	Dize	Kapsayıcının son güncelleştirme zamanı.	Yes

AgentContainerOperationError

Varsa kapsayıcı işleminin hata ayrıntıları.

Name	Türü	Description	Zorunlu	Varsayılan
code	Dize	Varsa kapsayıcı işleminin hata kodu.	Yes
message	Dize	Varsa kapsayıcı işleminin hata iletisi.	Yes
type	Dize	Varsa kapsayıcı işleminin hata türü.	Yes

AgentContainerOperationObject

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

Name	Türü	Description	Zorunlu	Varsayılan
agent_id	Dize	Ajanın kimliği.	Yes
agent_version_id	Dize	Aracı sürümünün kimliği.	Yes
container	AgentContainerObject	Bir aracının belirli bir sürümünün kapsayıcısının ayrıntıları.	Hayır
└─ kapsayıcı	ContainerDetails (salt okunur)	Ayrıntılı kapsayıcı bilgileri.	Hayır
└─ oluşturulma_tarihi	dize (salt okunur)	Kapsayıcının oluşturma zamanı.	Yes
└─ error_message	dize (salt okunur)	Varsa, kapsayıcı çalışamadıysa hata iletisi.	Hayır
└─ kimlik	dize (salt okunur)	Kapsayıcının tanımlayıcısı.	Hayır
└─ max_replicas	integer	Kapsayıcı için en fazla çoğaltma sayısı. Varsayılan değer 1'dir.	Hayır
└─ min_replicas	integer	Kapsayıcı için en az çoğaltma sayısı. Varsayılan değer 1'dir.	Hayır
└─ nesne	enum	Her zaman 'agent.container' olan nesne türü. Olası değerler: agent.container	Yes
└─ durumu	AgentContainerStatus (salt okunur)	Aracının belirli bir sürümünün kapsayıcısının durumu.	Yes
└─ updated_at	dize (salt okunur)	Kapsayıcının son güncelleştirme zamanı.	Yes
hata	AgentContainerOperationError	Varsa kapsayıcı işleminin hata ayrıntıları.	Hayır
└─ kod	Dize	Varsa kapsayıcı işleminin hata kodu.	Yes
└─ ileti	Dize	Varsa kapsayıcı işleminin hata iletisi.	Yes
└─ türü	Dize	Varsa kapsayıcı işleminin hata türü.	Yes
kimlik	Dize	Kapsayıcı işleminin kimliği. Bu kimlik, sistem genelinde benzersiz bir tanımlayıcıdır.	Yes
durum	AgentContainerOperationStatus	Bir aracının belirli bir sürümü için kapsayıcı işleminin durumu.	Yes

AgentContainerOperationStatus

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

Property	Değer
Türü	Dize
Değerler	NotStarted InProgress Succeeded Failed

AgentContainerStatus

Aracının belirli bir sürümünün kapsayıcısının durumu.

Property	Değer
Türü	Dize
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	Schema
prompt	PromptAgentDefinition
workflow	WorkflowAgentDefinition
hosted	HostedAgentDefinition
container_app	ContainerAppAgentDefinition

Name	Türü	Description	Zorunlu	Varsayılan
tür	AgentKind		Yes
rai_config	RaiConfig	Sorumlu Yapay Zeka (RAI) içerik filtreleme ve güvenlik özellikleri için yapılandırma.	Hayır
└─ rai_policy_name	Dize	Uygulanacak RAI ilkesinin adı.	Yes

AgentKind

Property	Değer
Türü	Dize
Değerler	prompt hosted container_app workflow

AgentObject

Name	Türü	Description	Zorunlu	Varsayılan
kimlik	Dize	Aracının benzersiz tanımlayıcısı.	Yes
name	Dize	Aracının adı. Kısıtlamalar: maxLength: 63	Yes
Obje	enum	Her zaman 'aracı' olan nesne türü. Olası değerler: agent	Yes
versions	Obje	Ajanın en son sürümü.	Yes
└─ en son	AgentVersionObject		Yes

AgentProtocol

Property	Değer
Türü	Dize
Değerler	activity_protocol responses

AgentReference

Name	Türü	Description	Zorunlu	Varsayılan
name	Dize	Aracının adı. Kısıtlamalar: maxLength: 256	Yes
type	enum	Olası değerler: agent_reference	Yes
version	Dize	Aracının sürüm tanımlayıcısı.	Hayır

AgentTaxonomyInput

Giriş türü aracı olduğunda değerlendirme taksonomisi için giriş yapılandırması.

Name	Türü	Description	Zorunlu	Varsayılan
risk Kategorileri	RiskCategory dizisi	Değerlendirilecek risk kategorilerinin listesi.	Yes
target	Hedef	Ayırıcı desteği olan hedefler için temel sınıf.	Yes
└─ türü	Dize	Hedefin türü.	Yes
type	enum	Değerlendirme taksonomisinin giriş türü. Olası değerler: agent	Yes

AgentTaxonomyInputUpdate

Giriş türü aracı olduğunda değerlendirme taksonomisi için giriş yapılandırması.

Name	Türü	Description	Zorunlu	Varsayılan
risk Kategorileri	RiskCategory dizisi	Değerlendirilecek risk kategorilerinin listesi.	Hayır
target	TargetUpdate	Ayırıcı desteği olan hedefler için temel sınıf.	Hayır
└─ türü	Dize	Hedefin türü.	Yes
type	enum	Değerlendirme taksonomisinin giriş türü. Olası değerler: agent	Yes

AgentVersionObject

Name	Türü	Description	Zorunlu	Varsayılan
oluşturulma_tarihi	integer	Aracının oluşturulduğu Unix zaman damgası (saniye).	Yes
tanım	AgentDefinition		Yes
Açıklama	Dize	Aracının insan tarafından okunabilir bir açıklaması. Kısıtlamalar: maxLength: 512	Hayır
kimlik	Dize	Aracı sürümünün benzersiz tanımlayıcısı.	Yes
metadata	object (null atanabilir)	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu olabilir 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.	Yes
name	Dize	Aracının adı. Ad, aracıyı almak/güncellemek/silmek için kullanılabilir. Kısıtlamalar: maxLength: 256	Yes
Obje	enum	Her zaman 'agent.version' olan nesne türü. Olası değerler: agent.version	Yes
version	Dize	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.	Yes

AgenticIdentityPreviewCredentials

Aracı kimliği kimlik bilgisi tanımlaması

Name	Türü	Description	Zorunlu	Varsayılan
type	enum	Kimlik türü Olası değerler: AgenticIdentityToken_Preview	Yes

ApiErrorResponse

API hataları için hata yanıtı.

Name	Türü	Description	Zorunlu	Varsayılan
hata	OpenAI.Error		Yes

ApiKeyCredentials

API Anahtarı Kimlik Bilgisi tanımı

Name	Türü	Description	Zorunlu	Varsayılan
key	dize (salt okunur)	API Anahtarı	Hayır
type	enum	Kimlik türü Olası değerler: ApiKey	Yes

AssetCredentialResponse

Tüketim için bir blob başvurusunu temsil eder

Name	Türü	Description	Zorunlu	Varsayılan
blobReference	BlobReference	Blob başvuru ayrıntıları.	Yes
└─ blobUri	Dize	İstemcinin verileri karşıya yüklemesi için Blob URI yolu. Örnek: https://blob.windows.core.net/Container/Path	Yes
└─ kimlik bilgisi	SasCredential	Depolama hesabına erişmek için kimlik bilgileri.	Yes
└─ storageAccountArmId	Dize	Kullanılacak depolama hesabının ARM kimliği.	Yes

Varlık Kimliği

Kaydedilmiş bir varlığın tanımlayıcısı.

Tür: dize

AttackStrategy

Saldırılar için stratejiler.

Property	Değer
Tanım	Saldırılar için stratejiler.
Türü	Dize
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.

Name	Türü	Description	Zorunlu	Varsayılan
code	Dize	Sunucu tanımlı hata kodları kümesinden biri.	Yes
details	Azure dizisi. Core.Foundations.Error	Bu bildirilen hataya yol açan belirli hatalar hakkında bir dizi ayrıntı.	Hayır
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ır
└─ kod	Dize	Sunucu tanımlı hata kodları kümesinden biri.	Hayır
└─ iç hata	Azure. Core.Foundations.InnerError	İç hata.	Hayır
message	Dize	Hatanın insan tarafından okunabilir bir gösterimi.	Yes
target	Dize	Hatanın hedefi.	Hayır

Azure. Core.Foundations.ErrorResponse

Hata ayrıntılarını içeren bir yanıt.

Name	Türü	Description	Zorunlu	Varsayılan
hata	Azure. Core.Foundations.Error	Hata nesnesi.	Yes
└─ kod	Dize	Sunucu tanımlı hata kodları kümesinden biri.	Yes
└─ ayrıntılar	Azure dizisi. Core.Foundations.Error	Bu bildirilen hataya yol açan belirli hatalar hakkında bir dizi ayrıntı.	Hayır
└─ iç hata	Azure. Core.Foundations.InnerError	Hatayla ilgili geçerli nesneden daha belirli bilgiler içeren bir nesne.	Hayır
└─ ileti	Dize	Hatanın insan tarafından okunabilir bir gösterimi.	Yes
└─ hedef	Dize	Hatanın hedefi.	Hayır

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.

Name	Türü	Description	Zorunlu	Varsayılan
code	Dize	Sunucu tanımlı hata kodları kümesinden biri.	Hayır
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ır
└─ kod	Dize	Sunucu tanımlı hata kodları kümesinden biri.	Hayır
└─ iç hata	Azure. Core.Foundations.InnerError	İç hata.	Hayır

Azure. Core.Foundations.OperationState

İzin verilen işlem durumlarını açıklayan sabit listesi.

Property	Değer
Tanım	İzin verilen işlem durumlarını açıklayan sabit listesi.
Türü	Dize
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.

Name	Türü	Description	Zorunlu	Varsayılan
name	Dize	Azure yapay zeka aracısının benzersiz tanımlayıcısı.	Yes
tool_descriptions	ToolDescription dizisi	Metin oluşturma sırasında aracının örnekleme davranışını kontrol etmek için kullanılan parametreler.	Hayır
type	enum	Hedefin türü, her zaman azure_ai_agent. Olası değerler: azure_ai_agent	Yes
version	Dize	Azure AI aracısının sürümü.	Hayır

AzureAIAgentTargetUpdate

Bir Azure AI ajanı belirten bir hedefi temsil eder.

Name	Türü	Description	Zorunlu	Varsayılan
name	Dize	Azure yapay zeka aracısının benzersiz tanımlayıcısı.	Hayır
tool_descriptions	ToolDescription dizisi	Metin oluşturma sırasında aracının örnekleme davranışını kontrol etmek için kullanılan parametreler.	Hayır
type	enum	Hedefin türü, her zaman azure_ai_agent. Olası değerler: azure_ai_agent	Yes
version	Dize	Azure AI aracısının sürümü.	Hayır

AzureAIDataSourceConfig

Name	Türü	Description	Zorunlu	Varsayılan
senaryo	enum	Veri şeması senaryosu. Olası değerler: red_team, responses, traces_preview, synthetic_data_gen_preview	Yes
schema	Obje	Çalıştırma veri kaynağı öğeleri için genel nesne JSON şeması.	Yes
type	enum	Her zaman azure_ai_sourceolan nesne türü. Olası değerler: azure_ai_source	Yes

AzureAIModelTarget

Model seçimi gerektiren işlemler için bir Azure AI modeli belirten bir hedefi temsil eder.

Name	Türü	Description	Zorunlu	Varsayılan
model	Dize	Azure yapay zeka modelinin benzersiz tanımlayıcısı.	Hayır
Ö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ır
└─ maksimum_önem_bitim_kodları	integer	Tamamlanmada izin verilen en fazla belirteç sayısı.	Yes
└─ tohum	integer	Yeniden üretilebilirlik için rastgele tohum.	Yes
└─ sıcaklık	number	Örnekleme için sıcaklık parametresi.	Yes
└─ top_p	number	Çekirdek örnekleme için top-p parametresi.	Yes
type	enum	Hedefin türü, her zaman azure_ai_model. Olası değerler: azure_ai_model	Yes

AzureAIModelTargetUpdate

Model seçimi gerektiren işlemler için bir Azure AI modeli belirten bir hedefi temsil eder.

Name	Türü	Description	Zorunlu	Varsayılan
model	Dize	Azure yapay zeka modelinin benzersiz tanımlayıcısı.	Hayır
Ö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ır
└─ maksimum_önem_bitim_kodları	integer	Tamamlanmada izin verilen en fazla belirteç sayısı.	Hayır
└─ tohum	integer	Yeniden üretilebilirlik için rastgele tohum.	Hayır
└─ sıcaklık	number	Örnekleme için sıcaklık parametresi.	Hayır
└─ top_p	number	Çekirdek örnekleme için top-p parametresi.	Hayır
type	enum	Hedefin türü, her zaman azure_ai_model. Olası değerler: azure_ai_model	Yes

AzureAIResponsesEvalRunDataSource

Sürekli Değerlendirme senaryolarına özgü değerlendirme çalıştırmaları için bir veri kaynağını temsil eder.

Name	Türü	Description	Zorunlu	Varsayılan
event_configuration_id	Dize	Bu değerlendirme çalıştırmasıyla ilişkili olay yapılandırma adı.	Yes
item_generation_params	ResponseRetrievalItemGenerationParams	Yanıt alma öğesi oluşturma parametrelerini temsil eder.	Yes
└─ data_mapping	Obje	Sohbet geçmişini almak için gereken kaynak alanlardan response_id alanına eşleme.	Yes
└─ max_num_turns	integer	Değerlendirilecek sohbet geçmişinin maksimum dönüş sayısı.	Yes
└─ kaynak	OpenAI.EvalJsonlFileContentSource veya OpenAI.EvalJsonlFileIdSource	JSONL içeriğinin okunduğu kaynak.	Yes
└─ türü	enum	Her zaman response_retrievalolan öğe oluşturma parametrelerinin türü. Olası değerler: response_retrieval	Yes
max_runs_hourly	integer	Saat başına izin verilen en fazla değerlendirme çalıştırması sayısı.	Yes
type	enum	Her zaman azure_ai_responsesveri kaynağı türü. Olası değerler: azure_ai_responses	Yes

Azure AISearch Dizini

Azure Yapay Zeka Arama Dizin Tanımı

Name	Türü	Description	Zorunlu	Varsayılan
kimlik	dize (salt okunur)	Öğe kimliği, öğe için benzersiz bir tanımlayıcı	Hayır
name	dize (salt okunur)	Kaynağın adı	Yes
type	enum	Dizin türü Olası değerler: AzureSearch	Yes
version	dize (salt okunur)	Kaynağın sürümü	Yes

AzureAISearchIndexUpdate

Azure Yapay Zeka Arama Dizin Tanımı

Name	Türü	Description	Zorunlu	Varsayılan
Açıklama	Dize	Varlık açıklaması metni.	Hayır
tags	Obje	Etiket sözlüğü. Etiketler eklenebilir, kaldırılabilir ve güncelleştirilebilir.	Hayır
type	enum	Dizin türü Olası değerler: AzureSearch	Yes

AzureAISearchQueryType

Azure Yapay Zeka Arama tool için mevcut query types.

Property	Değer
Tanım	Azure Yapay Zeka Arama tool için mevcut query types.
Türü	Dize
Değerler	simple semantic vector vector_simple_hybrid vector_semantic_hybrid

AzureAISearchTool

Bir aja'yı yapılandırmak için kullanılan Azure AI arama aracı için giriş tanım bilgisi.

Name	Türü	Description	Zorunlu	Varsayılan
azure_ai_search	AzureAISearchToolResource	azure_ai_search aracı tarafından kullanılan dizin kaynakları kümesi.	Yes
└─ dizinler	AISearchIndexResource dizisi	Bu aracıya bağlı dizinler. En fazla 1 dizin olabilir aracıya bağlı kaynak. Kısıtlamalar: maxItems: 1	Yes
type	enum	Her zaman 'azure_ai_search' olan nesne türü. Olası değerler: azure_ai_search	Yes

AzureAISearchToolResource

azure_ai_search aracı tarafından kullanılan dizin kaynakları kümesi.

Name	Türü	Description	Zorunlu	Varsayılan
Dizinler	AISearchIndexResource dizisi	Bu aracıya bağlı dizinler. En fazla 1 dizin olabilir aracıya bağlı kaynak.	Yes

AzureFunctionBinding

Storage kuyruk adını ve URI'sini tutmaya yönelik yapı.

Name	Türü	Description	Zorunlu	Varsayılan
storage_queue	AzureFunctionStorageQueue	Storage kuyruk adını ve URI'sini tutmaya yönelik yapı.	Yes
└─ queue_name	Dize	Azure işlev depolama kuyruğunun adı.	Yes
└─ queue_service_endpoint	Dize	Azure Depolama Kuyruğu hizmetine yönelik URI, bir kuyruğu işlemenizi sağlar.	Yes
type	enum	Her zaman 'storage_queue' olan bağlama türü. Olası değerler: storage_queue	Yes

AzureFunctionDefinition

Azure fonksiyonunun tanımı.

Name	Türü	Description	Zorunlu	Varsayılan
function	Obje	Azure işlevinin tanımı ve parametreleri.	Yes
└─ açıklama	Dize	İş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ır
└─ ad	Dize	Çağrılacak işlevin adı.	Yes
└─ parametreler	Obje	İşlevlerin kabullediği, JSON Şeması nesnesi olarak tanımlanan parametreler.	Yes
input_binding	AzureFunctionBinding	Storage kuyruk adını ve URI'sini tutmaya yönelik yapı.	Yes
└─ storage_queue	AzureFunctionStorageQueue	Depolama kuyruğu.	Yes
└─ türü	enum	Her zaman 'storage_queue' olan bağlama türü. Olası değerler: storage_queue	Yes
output_binding	AzureFunctionBinding	Storage kuyruk adını ve URI'sini tutmaya yönelik yapı.	Yes
└─ storage_queue	AzureFunctionStorageQueue	Depolama kuyruğu.	Yes
└─ türü	enum	Her zaman 'storage_queue' olan bağlama türü. Olası değerler: storage_queue	Yes

AzureFunctionStorageQueue

Storage kuyruk adını ve URI'sini tutmaya yönelik yapı.

Name	Türü	Description	Zorunlu	Varsayılan
queue_name	Dize	Azure işlev depolama kuyruğunun adı.	Yes
queue_service_endpoint	Dize	Azure Depolama Kuyruğu hizmetine yönelik URI, bir kuyruğu işlemenizi sağlar.	Yes

AzureFunctionTool

Bir Azure Fonksiyon Aracı için giriş tanım bilgileri, bir Ajanı yapılandırmak için kullanılan bilgiler.

Name	Türü	Description	Zorunlu	Varsayılan
azure_function	AzureFunctionDefinition	Azure fonksiyonunun tanımı.	Yes
└─ işlevi	Obje	Azure işlevinin tanımı ve parametreleri.	Yes
└─ açıklama	Dize	İş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ır
└─ ad	Dize	Çağrılacak işlevin adı.	Yes
└─ parametreler	Obje	İşlevlerin kabullediği, JSON Şeması nesnesi olarak tanımlanan parametreler.	Yes
└─ input_binding	AzureFunctionBinding	Giriş depolama kuyruğu. Kuyruk depolama tetikleyicisi, iletiler eklendiğinde bir işlev çalıştırır.	Yes
└─ output_binding	AzureFunctionBinding	Çıktı depolama kuyruğu. İşlev, giriş öğeleri işlendiğinde çıkışı bu kuyruğa yazar.	Yes
type	enum	Her zaman 'browser_automation' olan nesne türü. Olası değerler: azure_function	Yes

AzureOpenAIModelConfiguration

OpenAI model yapılandırmasını Azure. API sürümü, modeli sorgulamak için hizmet tarafından seçilir.

Name	Türü	Description	Zorunlu	Varsayılan
modelDeploymentName	Dize	AOAI modeli için dağıtım adı. Örnek: AIServices veya bağlantı tabanlıysa connection_name/deployment_name gpt-4o (ör. my-aoai-connection/gpt-4o).	Yes
type	enum	Olası değerler: AzureOpenAIModel	Yes

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	Schema
ApiKey	ApiKeyCredentials
AAD	EntraIDCredentials
CustomKeys	Customcredential
SAS	SASCredentials
None	NoAuthenticationCredentials
AgenticIdentityToken_Preview	AgenticIdentityPreviewCredentials

Name	Türü	Description	Zorunlu	Varsayılan
type	CredentialType (salt okunur)	Bağlantı tarafından kullanılan kimlik bilgisi türü	Yes

BingCustomSearchConfiguration

bing özel arama yapılandırması.

Name	Türü	Description	Zorunlu	Varsayılan
count	integer	Bing API yanıtında döndürülecek arama sonuçlarının sayısı	Hayır
freshness	Dize	Arama sonuçlarını belirli bir zaman aralığına göre filtreleyin. Burada kabul edilen değerlere bakın.	Hayır
instance_name	Dize	Yapılandırmaya verilen özel yapılandırma örneğinin adı.	Yes
Pazar	Dize	Sonuçların geldiği pazar.	Hayır
project_connection_id	Dize	bing araması ile topraklama için Project bağlantı kimliği	Yes
set_lang	Dize	Bing API'sini çağırırken kullanıcı arabirimi dizeleri için kullanılacak dil.	Hayır

BingCustomSearchPreviewTool

Aracıyı yapılandırmak için kullanılan Bing özel arama aracının giriş tanımı bilgileri.

Name	Türü	Description	Zorunlu	Varsayılan
bing_custom_search_preview	BingCustomSearchToolParameters	Özel arama aracı parametrelerini bing.	Yes
└─ search_configurations	BingCustomSearchConfiguration dizisi	Bu ara çubuğuna bağlı project bağlantıları. En fazla 1 bağlantı olabilir aracına bağlı kaynak. Kısıtlamalar: maxItems: 1	Yes
type	enum	Her zaman 'bing_custom_search_preview' olan nesne türü. Olası değerler: bing_custom_search_preview	Yes

BingCustomSearchToolParameters

Özel arama aracı parametrelerini bing.

Name	Türü	Description	Zorunlu	Varsayılan
search_configurations	BingCustomSearchConfiguration dizisi	Bu ara çubuğuna bağlı project bağlantıları. En fazla 1 bağlantı olabilir aracına bağlı kaynak.	Yes

BingGroundingSearchConfiguration

Bing Topraklama için arama yapılandırması

Name	Türü	Description	Zorunlu	Varsayılan
count	integer	Bing API yanıtında döndürülecek arama sonuçlarının sayısı	Hayır
freshness	Dize	Arama sonuçlarını belirli bir zaman aralığına göre filtreleyin. Burada kabul edilen değerlere bakın.	Hayır
Pazar	Dize	Sonuçların geldiği pazar.	Hayır
project_connection_id	Dize	bing araması ile topraklama için Project bağlantı kimliği	Yes
set_lang	Dize	Bing API'sini çağırırken kullanıcı arabirimi dizeleri için kullanılacak dil.	Hayır

BingGroundingSearchToolParameters

bing topraklama arama aracı parametreleri.

Name	Türü	Description	Zorunlu	Varsayılan
search_configurations	BingGroundingSearchConfiguration dizisi	Bu araci ekli arama yapılandırmaları. En fazla 1 olabilir ara çubuğuna bağlı arama yapılandırma kaynağı.	Yes

BingGroundingTool

Aracıyı yapılandırmak için kullanılan bing topraklama arama aracının giriş tanımı bilgileri.

Name	Türü	Description	Zorunlu	Varsayılan
bing_grounding	BingGroundingSearchToolParameters	bing topraklama arama aracı parametreleri.	Yes
└─ search_configurations	BingGroundingSearchConfiguration dizisi	Bu araci ekli arama yapılandırmaları. En fazla 1 olabilir ara çubuğuna bağlı arama yapılandırma kaynağı. Kısıtlamalar: maxItems: 1	Yes
type	enum	Her zaman 'bing_grounding' olan nesne türü. Olası değerler: bing_grounding	Yes

BlobReference

Blob başvuru ayrıntıları.

Name	Türü	Description	Zorunlu	Varsayılan
blobUri	Dize	İstemcinin verileri karşıya yüklemesi için Blob URI yolu. Örnek: https://blob.windows.core.net/Container/Path	Yes
credential	SasCredential	SAS Kimlik Bilgisi tanımı	Yes
└─ sasUri	dize (salt okunur)	SAS uri'si	Yes
└─ türü	enum	Kimlik bilgisi türü Olası değerler: SAS	Yes
storageAccountArmId	Dize	Kullanılacak depolama hesabının ARM kimliği.	Yes

BrowserAutomationPreviewTool

Bir Aracıyı yapılandırmak için kullanılan bir Tarayıcı Otomasyon Aracı için giriş tanımı bilgileri.

Name	Türü	Description	Zorunlu	Varsayılan
browser_automation_preview	BrowserAutomationToolParameters	Tarayıcı Otomasyon Aracı için giriş parametrelerinin tanımı.	Yes
└─ bağlantı	BrowserAutomationToolConnectionParameters	Tarayıcı Otomasyon Aracı ile ilişkili proje bağlantı parametreleri.	Yes
type	enum	Nesne türü, ki bu her zaman 'browser_automation_preview' olur. Olası değerler: browser_automation_preview	Yes

BrowserAutomationToolConnectionParameters

Tarayıcı Otomasyon Aracı tarafından kullanılan bağlantı için giriş parametrelerinin tanımı.

Name	Türü	Description	Zorunlu	Varsayılan
project_connection_id	Dize	Azure Playwright kaynağınıza proje bağlantısının kimliği.	Yes

BrowserAutomationToolParameters

Tarayıcı Otomasyon Aracı için giriş parametrelerinin tanımı.

Name	Türü	Description	Zorunlu	Varsayılan
bağlantı	BrowserAutomationToolConnectionParameters	Tarayıcı Otomasyon Aracı tarafından kullanılan bağlantı için giriş parametrelerinin tanımı.	Yes
└─ project_connection_id	Dize	Azure Playwright kaynağınıza proje bağlantısının kimliği.	Yes

CaptureStructuredOutputsTool

Yapılandırılmış çıktıları yakalamak için bir araç

Name	Türü	Description	Zorunlu	Varsayılan
outputs	StructuredOutputDefinition	Aracı tarafından üretilebilen yapılandırılmış bir çıkış.	Yes
└─ açıklama	Dize	Yaymak için çıkışın açıklaması. Modeli tarafından çıkışın ne zaman yayılabileceğini belirlemek için kullanılır.	Yes
└─ ad	Dize	Yapılandırılmış çıkışın adı.	Yes
└─ şeması	Obje	Yapılandırılmış çıktı için JSON şeması.	Yes
└─ katı	boole değeri (null atanabilir)	Katı doğrulamanın zorunlu kılınıp uygulanmayacağı. Varsayılan true.	Yes
type	enum	Aracın türü. Her zaman capture_structured_outputs. Olası değerler: capture_structured_outputs	Yes

ChartCoordinate

Analiz tablosu için koordinatlar.

Name	Türü	Description	Zorunlu	Varsayılan
size	integer	Grafik öğesinin boyutu.	Yes
x	integer	X ekseni koordinatı.	Yes
y	integer	Y ekseni koordinatı.	Yes

ChatSummaryMemoryItem

Konuşmalardan çıkarılan bir özet içeren bir bellek öğesi.

Name	Türü	Description	Zorunlu	Varsayılan
içerik	Dize	Belleğin içeriği.	Yes
tür	enum	Bellek öğesinin türü. Olası değerler: chat_summary	Yes
memory_id	Dize	Bellek öğesinin benzersiz kimliği.	Yes
scope	Dize	Kullanıcı kimliği gibi anıları mantıksal olarak gruplandıran ve yalıtan ad alanı.	Yes
updated_at	integer	Bellek öğesinin son güncelleme zamanı.	Yes

ClusterInsightResult

Küme analizinden elde edilen bilgiler.

Name	Türü	Description	Zorunlu	Varsayılan
clusters	InsightCluster dizisi	İçgörülerde tanımlanan kümelerin listesi.	Yes
koordinatlar	Obje	Kimliklerin görselleştirme için UX tarafından kullanılan 2B koordinatlara isteğe bağlı eşlemesi. 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ır
summary	InsightSummary	Hata kümesi analizinin özeti.	Yes
└─ yöntemi	Dize	Kümeleme için kullanılan yöntem.	Yes
└─ sampleCount	integer	Analiz edilen toplam örnek sayısı.	Yes
└─ uniqueClusterCount	integer	Toplam benzersiz küme sayısı.	Yes
└─ uniqueSubclusterCount	integer	Benzersiz alt küme etiketlerinin toplam sayısı.	Yes
└─ kullanımı	ClusterTokenUsage	Kümeleme analizi gerçekleştirirken belirteç kullanımı	Yes

ClusterTokenUsage

Küme analizi için belirteç kullanımı

Name	Türü	Description	Zorunlu	Varsayılan
inputTokenUsage	integer	giriş belirteci kullanımı	Yes
outputTokenUsage	integer	çıkış belirteci kullanımı	Yes
totalTokenUsage	integer	toplam belirteç kullanımı	Yes

CodeBasedEvaluatorDefinition

Python kodunu kullanarak kod tabanlı değerlendirici tanımı

Name	Türü	Description	Zorunlu	Varsayılan
code_text	Dize	Değerlendirici için satır içi kod metni	Yes
data_schema	Obje	Değerlendiricinin giriş verileri için JSON şeması (Taslak 2020-12). Bu, tür, özellikler, gerekli gibi parametreleri içerir.	Hayır
init_parameters	Obje	Değerlendiricinin giriş parametreleri için JSON şeması (Taslak 2020-12). Bu, tür, özellikler, gerekli gibi parametreleri içerir.	Hayır
metrics	Obje	Bu değerlendirici tarafından üretilen çıktı metriklerinin listesi	Hayır
type	enum	Olası değerler: code	Yes

CompletionMessageToolCallChunk

bir iletinin içindeki araç arama ayrıntıları.

Name	Türü	Description	Zorunlu	Varsayılan
function	FunctionToolCall	İşlev aracı çağrısının ayrıntıları.	Hayır
└─ argümanlar	Dize	Model tarafından JSON formatında oluşturulan ve işlevin çağırılması için kullanılan bağımsız değişkenler.	Yes
└─ ad	Dize	Çağrılacak işlevin adı.	Yes
kimlik	Dize	Araç çağrısının kimliği.	Yes
type	enum	Her zaman "işlev" olan araç çağrısının türü. Olası değerler: function	Yes

Bağlantı

Listeden yanıt alma ve bağlantı alma işlemleri

Name	Türü	Description	Zorunlu	Varsayılan
credentials	BaseCredentials (salt okunur)	Bağlantı kimlik bilgileri için bir temel sınıf	Yes
└─ türü	CredentialType (salt okunur)	Bağlantı tarafından kullanılan kimlik bilgisi türü	Yes
kimlik	dize (salt okunur)	Hizmet tarafından oluşturulan bağlantı için benzersiz bir tanımlayıcı	Yes
isDefault	boole (salt okunur)	Bağlantının türünün varsayılan bağlantısı olarak etiketlenip etiketli olmadığı	Yes
metadata	object (salt okunur)	Bağlantının meta verileri	Yes
name	dize (salt okunur)	Bağlantının kullanıcı tarafından sağlanan kolay adı.	Yes
target	dize (salt okunur)	Bu hizmet için kullanılacak bağlantı URL'si	Yes
type	ConnectionType (salt okunur)	Bağlantının Türü (veya kategorisi)	Yes

ConnectionType

Bağlantının Türü (veya kategorisi)

Property	Değer
Tanım	Bağlantının Türü (veya kategorisi)
Türü	Dize
Değerler	AzureOpenAI AzureBlob AzureStorageAccount CognitiveSearch CosmosDB ApiKey AppConfig AppInsights CustomKeys RemoteTool_Preview

ContainerAppAgentDefinition

Kapsayıcı uygulaması aracısı tanımı.

Name	Türü	Description	Zorunlu	Varsayılan
container_app_resource_id	Dize	Bu aracıyı barındıran Azure Kapsayıcı Uygulamasının kaynak kimliği. Sürümler arasında değiştirilemez.	Yes
container_protocol_versions	ProtocolVersionRecord dizisi	Aracının kapsayıcıların giriş iletişimi için desteklediği protokoller.	Yes
ingress_subdomain_suffix	Dize	Aracıya giriş gönderirken uygulama alt etki alanına uygulanacak sonek. Bu bir etiket (örneğin, '---current'), belirli bir düzeltme (örneğin, '--0000001') veya kapsayıcı uygulamasının varsayılan uç noktasını kullanmak için boş olabilir.	Yes
tür	enum	Olası değerler: container_app	Yes
rai_config	RaiConfig	Sorumlu Yapay Zeka (RAI) içerik filtreleme ve güvenlik özellikleri için yapılandırma.	Hayır
└─ rai_policy_name	Dize	Uygulanacak RAI ilkesinin adı.	Yes

ContainerDetails

Kapsayıcı hakkında ayrıntılı bilgi.

Name	Türü	Description	Zorunlu	Varsayılan
health_state	Dize	Kapsayıcının sistem durumu.	Yes
provisioning_error	Dize	Varsa kapsayıcının sağlama hatası.	Hayır
provisioning_state	Dize	Kapsayıcının sağlama durumu.	Yes
replicas	ContainerReplica dizisi	Kapsayıcıdaki çoğaltmaların listesi.	Yes
state	Dize	Kapsayıcının durumu.	Yes
updated_on	Dize	Kapsayıcının son güncelleştirme zamanı.	Yes

ContainerLogKind

Bir kapsayıcıdan akışa alınacak günlüklerin türü.

Property	Değer
Türü	Dize
Değerler	console system

ContainerReplica

Kapsayıcı çoğaltması hakkında bilgi.

Name	Türü	Description	Zorunlu	Varsayılan
container_state	Dize	Çoğaltmanın kapsayıcı durumu.	Yes
name	Dize	Replikanın adı.	Yes
state	Dize	Çoğaltmanın durumu.	Yes

ContinuousEvaluationRuleAction

Sürekli değerlendirme için değerlendirme kuralı eylemi.

Name	Türü	Description	Zorunlu	Varsayılan
evalId	Dize	Sürekli değerlendirme çalıştırmalarının ekleneceği değerlendirme kimliği.	Yes
maxHourlyRuns	integer	Saat başına izin verilen en fazla değerlendirme çalıştırması sayısı.	Hayır
type	enum	Olası değerler: continuousEvaluation	Yes

CosmosDB Dizini

CosmosDB Vektör Deposu Dizin Tanımı

Name	Türü	Description	Zorunlu	Varsayılan
kimlik	dize (salt okunur)	Öğe kimliği, öğe için benzersiz bir tanımlayıcı	Hayır
name	dize (salt okunur)	Kaynağın adı	Yes
type	enum	Dizin türü Olası değerler: CosmosDBNoSqlVectorStore	Yes
version	dize (salt okunur)	Kaynağın sürümü	Yes

CosmosDBIndexUpdate

CosmosDB Vektör Deposu Dizin Tanımı

Name	Türü	Description	Zorunlu	Varsayılan
Açıklama	Dize	Varlık açıklaması metni.	Hayır
tags	Obje	Etiket sözlüğü. Etiketler eklenebilir, kaldırılabilir ve güncelleştirilebilir.	Hayır
type	enum	Dizin türü Olası değerler: CosmosDBNoSqlVectorStore	Yes

CreateAgentFromManifestRequest

Name	Türü	Description	Zorunlu	Varsayılan
Açıklama	Dize	Aracının insan tarafından okunabilir bir açıklaması. Kısıtlamalar: maxLength: 512	Hayır
manifest_id	Dize	Aracı sürümünü içeri aktaracak bildirim kimliği.	Yes
metadata	Obje	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu olabilir 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ır
name	Dize	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	Yes
parameter_values	Obje	Bildirime yapılan ve tam olarak gerçekleştirilmiş bir Aracı ile sonuçlanacak girişler.	Yes

CreateAgentRequest

Name	Türü	Description	Zorunlu	Varsayılan
tanım	AgentDefinition		Yes
└─ tür	AgentKind		Yes
└─ rai_config	RaiConfig	Sorumlu Yapay Zeka (RAI) içerik filtreleme ve güvenlik özellikleri için yapılandırma.	Hayır
Açıklama	Dize	Aracının insan tarafından okunabilir bir açıklaması. Kısıtlamalar: maxLength: 512	Hayır
metadata	Obje	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu olabilir 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ır
name	Dize	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	Yes

CreateAgentVersionFromManifestRequest

Name	Türü	Description	Zorunlu	Varsayılan
Açıklama	Dize	Aracının insan tarafından okunabilir bir açıklaması. Kısıtlamalar: maxLength: 512	Hayır
manifest_id	Dize	Aracı sürümünü içeri aktaracak bildirim kimliği.	Yes
metadata	Obje	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu olabilir 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ır
parameter_values	Obje	Bildirime yapılan ve tam olarak gerçekleştirilmiş bir Aracı ile sonuçlanacak girişler.	Yes

CreateAgentVersionRequest

Name	Türü	Description	Zorunlu	Varsayılan
tanım	AgentDefinition		Yes
└─ tür	AgentKind		Yes
└─ rai_config	RaiConfig	Sorumlu Yapay Zeka (RAI) içerik filtreleme ve güvenlik özellikleri için yapılandırma.	Hayır
Açıklama	Dize	Aracının insan tarafından okunabilir bir açıklaması. Kısıtlamalar: maxLength: 512	Hayır
metadata	Obje	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu olabilir 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ır

Değerlendirme İstek Oluştur

Name	Türü	Description	Zorunlu	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.	Yes
metadata	OpenAI.Metadata (null atanabilir)	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu olabilir 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ır
name	Dize	Değerlendirmenin adı.	Hayır
properties	Obje	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ır
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. Değerlendirenler, {{item.variable_name}} gibi çift küme parantez gösterimini kullanarak veri kaynağındaki değişkenlere başvurabilir. Modelin çıkışına başvurmak için sample ad alanına atıfta bulunun (örneğin, {{sample.output_text}}).	Yes

Değerlendirme Çalışması İsteği Oluştur

Name	Türü	Description	Zorunlu	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.	Yes
metadata	OpenAI.Metadata (null atanabilir)	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu olabilir 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ır
name	Dize	Koşunun adı.	Hayır
properties	Obje	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ır

CredentialType

Bağlantı tarafından kullanılan kimlik bilgisi türü

Property	Değer
Tanım	Bağlantı tarafından kullanılan kimlik bilgisi türü
Türü	Dize
Değerler	ApiKey AAD SAS CustomKeys None AgenticIdentityToken_Preview

CronTrigger

Cron tabanlı tetikleyici.

Name	Türü	Description	Zorunlu	Varsayılan
endTime	Dize	ISO 8601 biçiminde cron zamanlaması için bitiş saati.	Hayır
expression	Dize	Zamanlama sıklığını tanımlayan cron ifadesi.	Yes
startTime	Dize	ISO 8601 biçiminde cron zamanlaması için başlangıç saati.	Hayır
timeZone	Dize	Cron zamanlaması için saat dilimi.	Hayır	UTC
type	enum	Olası değerler: Cron	Yes

Customcredential

Özel kimlik bilgisi tanımı

Name	Türü	Description	Zorunlu	Varsayılan
type	enum	Kimlik türü Olası değerler: CustomKeys	Yes

Bu nesne şu tür ek özellikleri de kabul eder: dize

DailyRecurrenceSchedule

Günlük yineleme programı.

Name	Türü	Description	Zorunlu	Varsayılan
hours	tamsayı dizisi	Yinelenme zamanlaması için saatler.	Yes
type	enum	Günlük yinelenme türü. Olası değerler: Daily	Yes

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	Schema

Name	Türü	Description	Zorunlu	Varsayılan
schema	Obje	Çalıştırma veri kaynağı öğeleri için genel nesne JSON şeması.	Yes
type	Dize	Veri kaynağı türü ayrıştırıcısı.	Yes

DatasetType

Veri türünü belirlemek için sabit listesi.

Property	Değer
Tanım	Veri türünü belirlemek için sabit listesi.
Türü	Dize
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	Schema
uri_file	FileDatasetVersion
uri_folder	FolderDatasetVersion

Name	Türü	Description	Zorunlu	Varsayılan
Connectionname	Dize	Azure Depolama Hesabı bağlantı adı. Veri Kümesi oluşturulmadan önce startPendingUploadVersion çağrılmadıysa gereklidir	Hayır
dataUri	Dize	Verilerin URI'sini (örnek) Kısıtlamalar: minLength: 1, desen: [a-zA-Z0-9_]	Yes
kimlik	dize (salt okunur)	Öğe kimliği, öğe için benzersiz bir tanımlayıcı	Hayır
isReference	boole (salt okunur)	Veri kümesinin depolamaya bir başvurusu olup olmadığını veya veri kümesinin depolamayı yönetip yönetmediğini gösterir. Doğruysa, veri kümesi sürümü silindiğinde temel alınan veriler silinmez	Hayır
name	dize (salt okunur)	Kaynağın adı	Yes
type	DatasetType	Veri türünü belirlemek için sabit listesi.	Yes
version	dize (salt okunur)	Kaynağın sürümü	Yes

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	Schema
uri_file	FileDatasetVersionUpdate
uri_folder	FolderDatasetVersionUpdate

Name	Türü	Description	Zorunlu	Varsayılan
Açıklama	Dize	Varlık açıklaması metni.	Hayır
tags	Obje	Etiket sözlüğü. Etiketler eklenebilir, kaldırılabilir ve güncelleştirilebilir.	Hayır
type	DatasetType	Veri türünü belirlemek için sabit listesi.	Yes

HaftanınGünü

Tekrarlama zamanlaması için haftanın günleri.

Property	Değer
Tanım	Tekrarlama zamanlaması için haftanın günleri.
Türü	Dize
Değerler	Sunday Monday Tuesday Wednesday Thursday Friday Saturday

DeleteAgentResponse

Silinmiş bir aracı Nesnesi

Name	Türü	Description	Zorunlu	Varsayılan
silindi	boolean	Aracının başarıyla silinip silinmediği.	Yes
name	Dize	Aracının adı.	Yes
Obje	enum	Nesne türü. Her zaman 'agent.deleted'. Olası değerler: agent.deleted	Yes

DeleteAgentVersionResponse

Silinmiş bir aracı sürümü Nesnesi

Name	Türü	Description	Zorunlu	Varsayılan
silindi	boolean	Aracının başarıyla silinip silinmediği.	Yes
name	Dize	Aracının adı.	Yes
Obje	enum	Nesne türü. Her zaman 'agent.version.deleted'. Olası değerler: agent.version.deleted	Yes
version	Dize	Aracının sürüm tanımlayıcısı.	Yes

DeleteEvalResponse

Silinen değerlendirme Nesnesi

Name	Türü	Description	Zorunlu	Varsayılan
silindi	boolean	Değerlendirmenin başarıyla silinip silinmediği.	Yes
eval_id	Dize	değerlendirmenin kimliği.	Yes
Obje	enum	Nesne türü. Her zaman 'eval.deleted'. Olası değerler: eval.deleted	Yes

DeleteEvalRunResponse

Silinen değerlendirme çalıştırma nesnesi.

Name	Türü	Description	Zorunlu	Varsayılan
silindi	boolean	Değerlendirmenin başarıyla silinip silinmediği.	Hayır
Obje	enum	Nesne türü. Her zaman 'eval.deleted'. Olası değerler: eval.deleted	Hayır
run_id	Dize	değerlendirmenin kimliği.	Hayır

DeleteMemoryStoreResponse

Name	Türü	Description	Zorunlu	Varsayılan
silindi	boolean	Bellek deposunun başarıyla silinip silinmediği.	Yes
name	Dize	Bellek deposunun adı.	Yes
Obje	enum	Nesne türü. Her zaman 'memory_store.deleted'. Olası değerler: memory_store.deleted	Yes

DeleteResponseResult

Yanıt silme işleminin sonucu.

Name	Türü	Description	Zorunlu	Varsayılan
silindi	enum	Her zaman true döndür Olası değerler: True	Yes
kimlik	Dize	İşlem kimliği.	Yes
Obje	enum	Her zaman 'yanıt' döndür. Olası değerler: response	Yes

Deployment

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	Schema
ModelDeployment	ModelDeployment

Name	Türü	Description	Zorunlu	Varsayılan
name	dize (salt okunur)	Dağıtımın adı	Yes
type	Deploymenttype		Yes

Deploymenttype

Property	Değer
Türü	Dize
Değerler	ModelDeployment

EntraIDCredentials

Entra ID credential tanımı

Name	Türü	Description	Zorunlu	Varsayılan
type	enum	Kimlik türü Olası değerler: AAD	Yes

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. Beğen:

• 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

Name	Türü	Description	Zorunlu	Varsayılan
oluşturulma_tarihi	integer	Değerlendirmenin oluşturulduğu zaman için Unix zaman damgası (saniye olarak).	Yes
Oluşturan	Dize	çalıştırmayı oluşturan kişinin adı.	Hayır
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ı.	Yes
kimlik	Dize	Değerlendirme için benzersiz tanımlayıcı.	Yes
metadata	OpenAI.Metadata (null atanabilir)	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu olabilir 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.	Yes
modified_at	tamsayı		Hayır
name	Dize	Değerlendirmenin adı.	Yes
Obje	enum	Nesne türü. Olası değerler: eval	Yes
properties	Obje	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ır
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.	Yes

EvalCsvFileIdSource

Değerlendirme verileri için kaynak olarak kullanılan karşıya yüklenen CSV dosyasına başvuruyu temsil eder.

Name	Türü	Description	Zorunlu	Varsayılan
kimlik	Dize	Karşıya yüklenen CSV dosyasının tanımlayıcısı.	Yes
type	enum	Kaynak türü, her zaman file_id. Olası değerler: file_id	Yes

EvalCsvRunDataSource

Değerlendirme çalıştırmaları için csv veri kaynağını temsil eder.

Name	Türü	Description	Zorunlu	Varsayılan
kaynak	EvalCsvFileIdSource	Değerlendirme verileri için kaynak olarak kullanılan karşıya yüklenen CSV dosyasına başvuruyu temsil eder.	Yes
└─ kimlik	Dize	Karşıya yüklenen CSV dosyasının tanımlayıcısı.	Yes
└─ türü	enum	Kaynak türü, her zaman file_id. Olası değerler: file_id	Yes
type	enum	Her zaman csvveri kaynağı türü. Olası değerler: csv	Yes

EvalGraderAzureAIEvaluator

Name	Türü	Description	Zorunlu	Varsayılan
veri eşleme	Obje	Değerlendirme için kullanılacak model. Yapılandırılmış çıktıları destekleme zorunluluğu vardır.	Hayır
evaluator_name	Dize	Değerlendiricinin adı.	Yes
evaluator_version	Dize	Değerlendiricinin sürümü. Belirtilmezse en son sürüm.	Hayır
initialization_parameters	Obje	Değerlendirme için başlatma parametreleri. Yapılandırılmış çıktıları destekleme zorunluluğu vardır.	Hayır
name	Dize	Değerlendiricinin adı.	Yes
type	enum	Her zaman azure_ai_evaluatorolan nesne türü. Olası değerler: azure_ai_evaluator	Yes

EvalResult

Değerlendirme sonucu.

Name	Türü	Description	Zorunlu	Varsayılan
name	Dize	denetimin adı	Yes
Geçirilen	boolean	denetimin geçirilip geçirilmediğini gösterir	Yes
Skor	number	Skor	Yes
type	Dize	denetimin türü	Yes

EvalRun

Değerlendirme oturumunu temsil eden şema.

Name	Türü	Description	Zorunlu	Varsayılan
oluşturulma_tarihi	integer	Değerlendirme çalıştırması oluşturulduğunda Unix zaman damgası (saniye olarak).	Yes
Oluşturan	Dize	çalıştırmayı oluşturan kişinin adı.	Hayır
veri_kaynağı	OpenAI.CreateEvalJsonlRunDataSource veya OpenAI.CreateEvalCompletionsRunDataSource veya OpenAI.CreateEvalResponsesRunDataSource veya EvalRunDataSource	Çalıştırmanın veri kaynağı hakkında bilgi.	Yes
hata	OpenAI.EvalApiError	Değerlendirme API'sinden bir hata yanıtını temsil eden nesne.	Yes
eval_id	Dize	İlişkili değerlendirmenin tanımlayıcısı.	Yes
kimlik	Dize	Değerlendirme çalışması için benzersiz tanımlayıcı.	Yes
metadata	OpenAI.Metadata (null atanabilir)	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu olabilir 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.	Yes
model	Dize	Değerlendirilen model, eğer uygulanabiliyorsa.	Yes
modified_at	tamsayı		Hayır
name	Dize	Değerlendirme çalıştırmasının adı.	Yes
Obje	enum	Nesnenin türü. Her zaman "eval.run". Olası değerler: eval.run	Yes
model_başına_kullanım	OpenAI.EvalRunPerModelUsage dizisi	Değerlendirme çalıştırması sırasında her model için kullanım istatistikleri.	Yes
test_kriterlerine_göre_sonuçlar	OpenAI.EvalRunPerTestingCriteriaResults dizisi	Değerlendirme çalıştırması sırasında uygulanan test kriterlerine göre sonuçlar.	Yes
properties	Obje	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ır
rapor_url	Dize	kullanıcı arabirimi panosunda görüntülenen değerlendirme raporunun URL'si.	Yes
sonuç_sayıları	OpenAI.EvalRunResultCounts		Yes
└─ hata	OpenAI.integer		Yes
└─ başarısız oldu	OpenAI.integer		Yes
└─ geçti	OpenAI.integer		Yes
└─ toplam	OpenAI.integer		Yes
durum	Dize	Çalıştırma değerlendirmesinin durumu.	Yes

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	Schema
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

Name	Türü	Description	Zorunlu	Varsayılan
type	Dize	Veri kaynağı türü ayrıştırıcısı.	Yes

EvalRunOutputItem

Değerlendirme çalıştırmasının çıkış öğesini temsil eden bir şema.

Name	Türü	Description	Zorunlu	Varsayılan
oluşturulma_tarihi	integer	Değerlendirme çalıştırması oluşturulduğunda Unix zaman damgası (saniye olarak).	Yes
veri kaynağı öğesi	Obje	Giriş veri kaynağı öğesinin ayrıntıları.	Yes
veri_kaynağı_öğe_kimliği	OpenAI.integer		Yes
eval_id	Dize	Değerlendirme grubunun tanımlayıcısı.	Yes
kimlik	Dize	Değerlendirme çalıştırma çıkış öğesinin benzersiz tanımlayıcısı.	Yes
Obje	enum	Nesnenin türü. Her zaman "eval.run.output_item". Olası değerler: eval.run.output_item	Yes
results	EvalRunOutputItemResult dizisi	Bu çıkış öğesi için not veren sonuçlarının listesi.	Yes
run_id	Dize	Bu çıkış öğesiyle ilişkili değerlendirme çalıştırmasının tanımlayıcısı.	Yes
örnek	OpenAI.EvalRunOutputItemSample		Yes
└─ hata	OpenAI.EvalApiError	Değerlendirme API'sinden bir hata yanıtını temsil eden nesne.	Yes
└─ bitiş_nedeni	Dize		Yes
└─ giriş	EvalRunOutputItemSampleInput dizisi		Yes
└─ maksimum_önem_bitim_kodları	OpenAI.integer		Yes
└─ modeli	Dize		Yes
└─ çıkış	EvalRunOutputItemSampleOutput dizisi		Yes
└─ tohum	OpenAI.integer		Yes
└─ sıcaklık	OpenAI.numeric		Yes
└─ top_p	OpenAI.numeric		Yes
└─ kullanımı	OpenAI.EvalRunOutputItemSampleUsage		Yes
durum	Dize	Çalıştırma değerlendirmesinin durumu.	Yes

EvalRunOutputItemResult

Değerlendirme çalıştırması çıkış öğesi için tek bir not veren sonucu.

Name	Türü	Description	Zorunlu	Varsayılan
etiket	Dize	Test ölçütü ölçümüyle ilişkili etiket (örneğin, "pass", "fail", "good", "bad").	Hayır
metric	Dize	Ölçümün adı (örneğin, "akıcılık", "f1_score").	Hayır
name	Dize	Değerlendiricinin adı.	Yes
Geçirilen	boolean	Not verenin çıkışı bir geçiş olarak değerlendirip değerlendirmediği.	Yes
properties	Obje	Test ölçütleri ölçümü hakkında ek ayrıntılar.	Hayır
neden	Dize	Test ölçütleri ölçüm nedeni.	Hayır
örnek	object (null atanabilir)	Not veren tarafından üretilen isteğe bağlı örnek veya ara veriler.	Hayır
Skor	OpenAI.numeric		Yes
threshold	number	Sayısalsa, bu test ölçütlerinin başarılı/başarısız olduğunu belirlemek için kullanılan eşik.	Hayır
type	Dize	Not veren türü (örneğin, "string-check-grader").	Hayır

Bu nesne ek özellikleri de kabul eder.

EvalRunOutputItemSampleInput

Değerlendirme çalıştırmasında bir ileti.

Name	Türü	Description	Zorunlu	Varsayılan
içerik	Dize		Yes
role	Dize		Yes
tool_calls	CompletionMessageToolCallChunk dizisi	Varsa, ileti içinde yapılan araç çağrıları.	Yes

EvalRunOutputItemSampleOutput

Değerlendirme çalıştırmasında bir ileti.

Name	Türü	Description	Zorunlu	Varsayılan
içerik	Dize		Hayır
role	Dize		Hayır
tool_calls	CompletionMessageToolCallChunk dizisi	Varsa, ileti içinde yapılan araç çağrıları.	Yes

EvalRunResultCompareItem

Bir tedavi için taban çizgisine karşı metrik karşılaştırma.

Name	Türü	Description	Zorunlu	Varsayılan
deltaEstimate	number	Tedavi ile taban çizgisi arasındaki tahmini fark.	Yes
pValue	number	Tedavi etkisi için P değeri.	Yes
treatmentEffect	TreatmentEffectType	Tedavi Etki Türü.	Yes
treatmentRunId	Dize	İşlem çalıştırma kimliği.	Yes
treatmentRunSummary	EvalRunResultSummary	Değerlendirme çalıştırmasındaki bir ölçümün özet istatistikleri.	Yes
└─ ortalama	number	Değerlendirme çalıştırmasında ölçümün ortalama değeri.	Yes
└─ runId	Dize	Değerlendirme çalıştırma kimliği.	Yes
└─ sampleCount	integer	Değerlendirme çalıştırmasında örnek sayısı.	Yes
└─ standardDeviation	number	Değerlendirme çalıştırmasında ölçümün standart sapması.	Yes

EvalRunResultComparison

Tedavi için karşılaştırma sonuçları taban çizgisine göre çalışır.

Name	Türü	Description	Zorunlu	Varsayılan
baselineRunSummary	EvalRunResultSummary	Değerlendirme çalıştırmasındaki bir ölçümün özet istatistikleri.	Yes
└─ ortalama	number	Değerlendirme çalıştırmasında ölçümün ortalama değeri.	Yes
└─ runId	Dize	Değerlendirme çalıştırma kimliği.	Yes
└─ sampleCount	integer	Değerlendirme çalıştırmasında örnek sayısı.	Yes
└─ standardDeviation	number	Değerlendirme çalıştırmasında ölçümün standart sapması.	Yes
compareItems	EvalRunResultCompareItem dizisi	Her işlem çalıştırması için karşılaştırma sonuçlarının listesi.	Yes
Değerlendir -ici	Dize	Bu test ölçütleri için değerlendiricinin adı.	Yes
metric	Dize	Değerlendirilen ölçüm.	Yes
testingCriteria	Dize	Test ölçütlerinin adı.	Yes

EvalRunResultSummary

Değerlendirme çalıştırmasındaki bir ölçümün özet istatistikleri.

Name	Türü	Description	Zorunlu	Varsayılan
ortalama	number	Değerlendirme çalıştırmasında ölçümün ortalama değeri.	Yes
runId	Dize	Değerlendirme çalıştırma kimliği.	Yes
sampleCount	integer	Değerlendirme çalıştırmasında örnek sayısı.	Yes
standardDeviation	number	Değerlendirme çalıştırmasında ölçümün standart sapması.	Yes

EvaluationComparisonInsightRequest

Değerlendirme Karşılaştırma İsteği

Name	Türü	Description	Zorunlu	Varsayılan
baselineRunId	Dize	Karşılaştırma için temel çalıştırma kimliği.	Yes
evalId	Dize	Değerlendirme tanımlayıcısı.	Yes
treatmentRunIds	dize dizisi	Karşılaştırma için işlem çalıştırması kimliklerinin listesi.	Yes
type	enum	İstek türü. Olası değerler: EvaluationComparison	Yes

EvaluationComparisonInsightResult

Değerlendirme karşılaştırmasından elde edilen bilgiler.

Name	Türü	Description	Zorunlu	Varsayılan
Karşılaştırma	EvalRunResultComparison dizisi	Her bir işlem çalıştırmasının karşılaştırma sonuçları taban çizgisine göre çalıştırılabilir.	Yes
method	Dize	Karşılaştırma için kullanılan istatistiksel yöntem.	Yes
type	enum	İçgörü sonucunun türü. Olası değerler: EvaluationComparison	Yes

EvaluationResultSample

Değerlendirme sonucundan bir örnek.

Name	Türü	Description	Zorunlu	Varsayılan
correlationInfo	Obje	Analiz örneğinin bağıntısı hakkında bilgi.	Yes
evaluationResult	EvalResult	Değerlendirme sonucu.	Yes
└─ ad	Dize	denetimin adı	Yes
└─ geçti	boolean	denetimin geçirilip geçirilmediğini gösterir	Yes
└─ puanı	number	Skor	Yes
└─ türü	Dize	denetimin türü	Yes
features	Obje	UX'te verilerin ek filtrelenmesine yardımcı olacak özellikler.	Yes
kimlik	Dize	Analiz örneğinin benzersiz tanımlayıcısı.	Yes
type	enum	Değerlendirme Sonucu Örnek Türü Olası değerler: EvaluationResultSample	Yes

Değerlendirme Kuralı

Değerlendirme kuralı modeli.

Name	Türü	Description	Zorunlu	Varsayılan
action	EvaluationRuleAction	Değerlendirme eylem modeli.	Yes
└─ türü	EvaluationRuleActionType	Değerlendirme eyleminin türü.	Yes
Açıklama	Dize	Değerlendirme kuralının açıklaması.	Hayır
displayName	Dize	Değerlendirme kuralı için Görünen Ad.	Hayır
enabled	boolean	Değerlendirme kuralının etkinleştirilip etkinleştirilmediğini gösterir. Varsayılan değer doğrudur	Yes
eventType	EvaluationRuleEventType	Değerlendirme kuralı olayının türü.	Yes
filter	EvaluationRuleFilter	Değerlendirme filtresi modeli.	Hayır
└─ ajanName	Dize	Aracı adına göre filtreleyin.	Yes
kimlik	dize (salt okunur)	Değerlendirme kuralı için benzersiz tanımlayıcı.	Yes
sistem verileri	object (salt okunur)	Değerlendirme kuralı için sistem meta verileri.	Yes

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	Schema
continuousEvaluation	ContinuousEvaluationRuleAction
humanEvaluationPreview	HumanEvaluationPreviewRuleAction

Name	Türü	Description	Zorunlu	Varsayılan
type	EvaluationRuleActionType	Değerlendirme eyleminin türü.	Yes

EvaluationRuleActionType

Değerlendirme eyleminin türü.

Property	Değer
Tanım	Değerlendirme eyleminin türü.
Türü	Dize
Değerler	continuousEvaluation humanEvaluationPreview

EvaluationRuleEventType

Değerlendirme kuralı olayının türü.

Property	Değer
Tanım	Değerlendirme kuralı olayının türü.
Türü	Dize
Değerler	responseCompleted manual

EvaluationRuleFilter

Değerlendirme filtresi modeli.

Name	Türü	Description	Zorunlu	Varsayılan
ajan adı	Dize	Aracı adına göre filtreleyin.	Yes

EvaluationRunClusterInsightRequest

Değerlendirme Sonuçları kümesine ilişkin içgörüler

Name	Türü	Description	Zorunlu	Varsayılan
evalId	Dize	İçgörüler için değerlendirme kimliği.	Yes
model yapılandırması	InsightModelConfiguration	İçgörü oluşturmada kullanılan modelin yapılandırması.	Hayır
└─ modelDeploymentName	Dize	Değerlendirilecek model dağıtımı. Dağıtım adını tek başına veya bağlantı adı olarak {connectionName}/<modelDeploymentName>kabul eder.	Yes
runId'ler	dize dizisi	İçgörüler için değerlendirme çalıştırması kimliklerinin listesi.	Yes
type	enum	İçgörü isteğinin türü. Olası değerler: EvaluationRunClusterInsight	Yes

EvaluationRunClusterInsightResult

Değerlendirmeden elde edilen içgörüler küme analizini çalıştırır.

Name	Türü	Description	Zorunlu	Varsayılan
clusterInsight	ClusterInsightResult	Küme analizinden elde edilen bilgiler.	Yes
type	enum	İçgörü sonucunun türü. Olası değerler: EvaluationRunClusterInsight	Yes

EvaluationScheduleTask

Zamanlama için değerlendirme görevi.

Name	Türü	Description	Zorunlu	Varsayılan
configuration	Obje	Görevin yapılandırması.	Hayır
evalId	Dize	Değerlendirme grubunun tanımlayıcısı.	Yes
evalRun	Obje	Değerlendirme çalıştırma yükü.	Yes
type	enum	Olası değerler: Evaluation	Yes

EvaluationTaxonomy

Değerlendirme Taksonomisi Tanımı

Name	Türü	Description	Zorunlu	Varsayılan
kimlik	dize (salt okunur)	Öğe kimliği, öğe için benzersiz bir tanımlayıcı	Hayır
name	dize (salt okunur)	Kaynağın adı	Yes
properties	Obje	Değerlendirme taksonomisi için ek özellikler.	Hayır
taksonomi Kategorileri	TaxonomyCategory dizisi	Taksonomi kategorilerinin listesi.	Hayır
taksonomiInput	EvaluationTaxonomyInput	Değerlendirme taksonomisi için giriş yapılandırması.	Yes
└─ türü	EvaluationTaxonomyInputType	Değerlendirme taksonomisinin giriş türü.	Yes
version	dize (salt okunur)	Kaynağın sürümü	Yes

EvaluationTaxonomyCreateOrUpdate

Değerlendirme Taksonomisi Tanımı

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

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	Schema
agent	AgentTaxonomyInput

Name	Türü	Description	Zorunlu	Varsayılan
type	EvaluationTaxonomyInputType	Değerlendirme taksonomisi girişinin türü.	Yes

EvaluationTaxonomyInputType

Değerlendirme taksonomisi girişinin türü.

Property	Değer
Tanım	Değerlendirme taksonomisi girişinin türü.
Türü	Dize
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	Schema
agent	AgentTaxonomyInputUpdate

Name	Türü	Description	Zorunlu	Varsayılan
type	EvaluationTaxonomyInputType	Değerlendirme taksonomisi girişinin türü.	Yes

EvaluationTaxonomyUpdate

Değerlendirme Taksonomisi Tanımı

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

DeğerlendiriciKategorisi

Değerlendiricinin kategorisi

Property	Değer
Tanım	Değerlendiricinin kategorisi
Türü	Dize
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	Schema
code	CodeBasedEvaluatorDefinition
prompt	PromptBasedEvaluatorDefinition

Name	Türü	Description	Zorunlu	Varsayılan
data_schema	Obje	Değerlendiricinin giriş verileri için JSON şeması (Taslak 2020-12). Bu, tür, özellikler, gerekli gibi parametreleri içerir.	Hayır
init_parameters	Obje	Değerlendiricinin giriş parametreleri için JSON şeması (Taslak 2020-12). Bu, tür, özellikler, gerekli gibi parametreleri içerir.	Hayır
metrics	Obje	Bu değerlendirici tarafından üretilen çıktı metriklerinin listesi	Hayır
type	EvaluatorDefinitionType	Değerlendirici tanımının türü	Yes

EvaluatorDefinitionType

Değerlendirici tanımının türü

Property	Değer
Tanım	Değerlendirici tanımının türü
Türü	Dize
Değerler	prompt code prompt_and_code service openai_graders

DeğerlendiriciÖlçerÖlçer

Değerlendirici Metriği

Name	Türü	Description	Zorunlu	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ır
is_primary	boolean	Birden çok ölçüm olduğunda bu ölçümün birincil olup olmadığını gösterir.	Hayır
max_value	number	Ölçüm için en yüksek değer. Belirtilmezse, ilişkisiz olduğu varsayılır.	Hayır
min_value	number	Ölçüm için en düşük değer	Hayır
type	DeğerlendiriciMetricType	Değerlendiricinin türü	Hayır

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ü

Property	Değer
Tanım	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ü	Dize
Değerler	increase decrease neutral

DeğerlendiriciMetricType

Değerlendiricinin türü

Property	Değer
Tanım	Değerlendiricinin türü
Türü	Dize
Değerler	ordinal continuous boolean

Değerlendirici Türü

Değerlendiricinin türü

Property	Değer
Tanım	Değerlendiricinin türü
Türü	Dize
Değerler	builtin custom

EvaluatorVersion

Değerlendirici Tanımı

Name	Türü	Description	Zorunlu	Varsayılan
categories	DeğerlendiriciKatgorisi dizisi	Değerlendiricinin kategorileri	Yes
oluşturulma_tarihi	dize (salt okunur)	Değerlendiricinin oluşturulma tarihi/saati	Yes
Oluşturan	dize (salt okunur)	Değerlendiricinin yaratıcısı	Yes
tanım	DeğerlendiriciDefinition	Ayırıcılı temel değerlendirici konfigürasyonu	Yes
└─ data_schema	Obje	Değerlendiricinin giriş verileri için JSON şeması (Taslak 2020-12). Bu, tür, özellikler, gerekli gibi parametreleri içerir.	Hayır
└─ init_parameters	Obje	Değerlendiricinin giriş parametreleri için JSON şeması (Taslak 2020-12). Bu, tür, özellikler, gerekli gibi parametreleri içerir.	Hayır
└─ ölçümler	Obje	Bu değerlendirici tarafından üretilen çıktı metriklerinin listesi	Hayır
└─ türü	EvaluatorDefinitionType	Değerlendirici tanımının türü	Yes
display_name	Dize	Değerlendirici için Görünen Ad. AI Foundry'de değerlendiriciyi kolayca bulmak yardımcı olur. Benzersiz olması gerekmez.	Hayır
evaluator_type	Değerlendirici Türü	Değerlendiricinin türü	Yes
kimlik	dize (salt okunur)	Öğe kimliği, öğe için benzersiz bir tanımlayıcı	Hayır
metadata	Obje	Değerlendirici hakkında meta veriler	Hayır
modified_at	dize (salt okunur)	Değerlendiricinin son değiştirilme tarihi/saati	Yes
name	dize (salt okunur)	Kaynağın adı	Yes
version	dize (salt okunur)	Kaynağın sürümü	Yes

EvaluatorVersionCreate

Değerlendirici Tanımı

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

EvaluatorVersionUpdate

Değerlendirici Tanımı

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

FabricDataAgentToolParameters

Yapı veri aracısı aracı parametreleri.

Name	Türü	Description	Zorunlu	Varsayılan
project_connections	ToolProjectConnection dizisi	Bu ara çubuğuna bağlı project bağlantıları. En fazla 1 bağlantı olabilir aracına bağlı kaynak.	Hayır

FileDatasetVersion

FileDatasetVersion Tanımı

Name	Türü	Description	Zorunlu	Varsayılan
Connectionname	Dize	Azure Depolama Hesabı bağlantı adı. Veri Kümesi oluşturulmadan önce startPendingUploadVersion çağrılmadıysa gereklidir	Hayır
dataUri	Dize	Verilerin URI'sini (örnek) Kısıtlamalar: minLength: 1, desen: [a-zA-Z0-9_]	Yes
kimlik	dize (salt okunur)	Öğe kimliği, öğe için benzersiz bir tanımlayıcı	Hayır
isReference	boole (salt okunur)	Veri kümesinin depolamaya bir başvurusu olup olmadığını veya veri kümesinin depolamayı yönetip yönetmediğini gösterir. Doğruysa, veri kümesi sürümü silindiğinde temel alınan veriler silinmez	Hayır
name	dize (salt okunur)	Kaynağın adı	Yes
type	enum	Veri kümesi türü Olası değerler: uri_file	Yes
version	dize (salt okunur)	Kaynağın sürümü	Yes

FileDatasetVersionUpdate

FileDatasetVersion Tanımı

Name	Türü	Description	Zorunlu	Varsayılan
Açıklama	Dize	Varlık açıklaması metni.	Hayır
tags	Obje	Etiket sözlüğü. Etiketler eklenebilir, kaldırılabilir ve güncelleştirilebilir.	Hayır
type	enum	Veri kümesi türü Olası değerler: uri_file	Yes

FolderDatasetVersion

FileDatasetVersion Tanımı

Name	Türü	Description	Zorunlu	Varsayılan
Connectionname	Dize	Azure Depolama Hesabı bağlantı adı. Veri Kümesi oluşturulmadan önce startPendingUploadVersion çağrılmadıysa gereklidir	Hayır
dataUri	Dize	Verilerin URI'sini (örnek) Kısıtlamalar: minLength: 1, desen: [a-zA-Z0-9_]	Yes
kimlik	dize (salt okunur)	Öğe kimliği, öğe için benzersiz bir tanımlayıcı	Hayır
isReference	boole (salt okunur)	Veri kümesinin depolamaya bir başvurusu olup olmadığını veya veri kümesinin depolamayı yönetip yönetmediğini gösterir. Doğruysa, veri kümesi sürümü silindiğinde temel alınan veriler silinmez	Hayır
name	dize (salt okunur)	Kaynağın adı	Yes
type	enum	Veri kümesi türü Olası değerler: uri_folder	Yes
version	dize (salt okunur)	Kaynağın sürümü	Yes

FolderDatasetVersionUpdate

FileDatasetVersion Tanımı

Name	Türü	Description	Zorunlu	Varsayılan
Açıklama	Dize	Varlık açıklaması metni.	Hayır
tags	Obje	Etiket sözlüğü. Etiketler eklenebilir, kaldırılabilir ve güncelleştirilebilir.	Hayır
type	enum	Veri kümesi türü Olası değerler: uri_folder	Yes

FunctionToolCall

İşlev aracı çağrısının ayrıntıları.

Name	Türü	Description	Zorunlu	Varsayılan
arguments	Dize	Model tarafından JSON formatında oluşturulan ve işlevin çağırılması için kullanılan bağımsız değişkenler.	Yes
name	Dize	Çağrılacak işlevin adı.	Yes

HostedAgentDefinition

Barındırılan aracı tanımı.

Name	Türü	Description	Zorunlu	Varsayılan
container_protocol_versions	ProtocolVersionRecord dizisi	Aracının kapsayıcıların giriş iletişimi için desteklediği protokoller.	Yes
cpu	Dize	Barındırılan aracının CPU yapılandırması.	Yes
environment_variables	Obje	Barındırılan aracı kapsayıcısında ayarlanacak ortam değişkenleri.	Hayır
image	Dize	Görüntü tabanlı barındırılan aracılar için geçerli olan aracının görüntü kimliği.	Hayır
tür	enum	Olası değerler: hosted	Yes
memory	Dize	Barındırılan aracının bellek yapılandırması.	Yes
rai_config	RaiConfig	Sorumlu Yapay Zeka (RAI) içerik filtreleme ve güvenlik özellikleri için yapılandırma.	Hayır
└─ rai_policy_name	Dize	Uygulanacak RAI ilkesinin adı.	Yes
tools	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ır

HourlyRecurrenceSchedule

Saatlik yinelenme zamanlaması.

Name	Türü	Description	Zorunlu	Varsayılan
type	enum	Olası değerler: Hourly	Yes

HumanEvaluationPreviewRuleAction

İnsan değerlendirmesi için değerlendirme kuralı eylemi.

Name	Türü	Description	Zorunlu	Varsayılan
templateId	AssetId	Kaydedilmiş bir varlığın tanımlayıcısı.	Yes
type	enum	Olası değerler: humanEvaluationPreview	Yes

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	Schema
AzureSearch	AzureAISearchIndex
ManagedAzureSearch	ManagedAzureAISearchIndex
CosmosDBNoSqlVectorStore	CosmosDBIndex

Name	Türü	Description	Zorunlu	Varsayılan
kimlik	dize (salt okunur)	Öğe kimliği, öğe için benzersiz bir tanımlayıcı	Hayır
name	dize (salt okunur)	Kaynağın adı	Yes
type	IndexType		Yes
version	dize (salt okunur)	Kaynağın sürümü	Yes

IndexType

Property	Değer
Türü	Dize
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	Schema
AzureSearch	AzureAISearchIndexUpdate
ManagedAzureSearch	ManagedAzureAISearchIndexUpdate
CosmosDBNoSqlVectorStore	CosmosDBIndexUpdate

Name	Türü	Description	Zorunlu	Varsayılan
Açıklama	Dize	Varlık açıklaması metni.	Hayır
tags	Obje	Etiket sözlüğü. Etiketler eklenebilir, kaldırılabilir ve güncelleştirilebilir.	Hayır
type	IndexType		Yes

İçgörü

Küme içgörüleri için yanıt gövdesi.

Name	Türü	Description	Zorunlu	Varsayılan
displayName	Dize	İçgörü için kullanıcı dostu görünen ad.	Yes
kimlik	dize (salt okunur)	İçgörüler raporunun benzersiz tanımlayıcısı.	Yes
metadata	InsightsMetadata (salt okunur)	İçgörülerle ilgili meta veriler.	Yes
└─ tamamlandıAt	Dize	İçgörülerin tamamlandığı zaman damgası.	Hayır
└─ oluşturuldu	Dize	İçgörülerin oluşturulduğu zaman damgası.	Yes
talep	InsightRequest	İçgörüler raporunun isteği.	Yes
└─ türü	InsightType	İstek türü.	Yes
result	InsightResult (salt okunur)	İçgörülerin sonucu.	Hayır
└─ türü	InsightType	İçgörü sonucunun türü.	Yes
state	Azure. Core.Foundations.OperationState (salt okunur)	İzin verilen işlem durumlarını açıklayan sabit listesi.	Yes

InsightCluster

Analiz örneklerinden oluşan bir küme.

Name	Türü	Description	Zorunlu	Varsayılan
Açıklama	Dize	Çözümleme kümesinin açıklaması.	Yes
kimlik	Dize	Çözümleme kümesinin kimliği.	Yes
etiket	Dize	Küme etiketi	Yes
Örnekleri	InsightSample dizisi	Bu kümeye ait örneklerin listesi. Örnekler alt kümelerin bir parçasıysa boş.	Hayır
alt kümeler	InsightCluster dizisi	Bu küme içindeki alt kümelerin listesi. Alt küme yoksa boş.	Hayır
Öneri	Dize	Küme önerisi	Yes
suggestionTitle	Dize	Küme önerisinin başlığı	Yes
weight	integer	Analiz kümesinin ağırlığı. Bu, kümedeki örnek sayısını gösterir.	Yes

InsightModelConfiguration

İçgörü oluşturmada kullanılan modelin yapılandırması.

Name	Türü	Description	Zorunlu	Varsayılan
modelDeploymentName	Dize	Değerlendirilecek model dağıtımı. Dağıtım adını tek başına veya bağlantı adı olarak {connectionName}/<modelDeploymentName>kabul eder.	Yes

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	Schema
EvaluationRunClusterInsight	EvaluationRunClusterInsightRequest
AgentClusterInsight	AgentClusterInsightRequest
EvaluationComparison	EvaluationComparisonInsightRequest

Name	Türü	Description	Zorunlu	Varsayılan
type	InsightType	İçgörülerin isteği.	Yes

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	Schema
EvaluationComparison	EvaluationComparisonInsightResult
EvaluationRunClusterInsight	EvaluationRunClusterInsightResult
AgentClusterInsight	AgentClusterInsightResult

Name	Türü	Description	Zorunlu	Varsayılan
type	InsightType	İçgörülerin isteği.	Yes

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	Schema
EvaluationResultSample	EvaluationResultSample

Name	Türü	Description	Zorunlu	Varsayılan
correlationInfo	Obje	Analiz örneğinin bağıntısı hakkında bilgi.	Yes
features	Obje	UX'te verilerin ek filtrelenmesine yardımcı olacak özellikler.	Yes
kimlik	Dize	Analiz örneğinin benzersiz tanımlayıcısı.	Yes
type	Sampletype	Analizde kullanılan numunenin türü.	Yes

InsightScheduleTask

Zamanlama için içgörü görevi.

Name	Türü	Description	Zorunlu	Varsayılan
configuration	Obje	Görevin yapılandırması.	Hayır
içgörü	Insight	Küme içgörüleri için yanıt gövdesi.	Yes
└─ displayName	Dize	İçgörü için kullanıcı dostu görünen ad.	Yes
└─ kimlik	dize (salt okunur)	İçgörüler raporunun benzersiz tanımlayıcısı.	Yes
└─ meta veriler	InsightsMetadata (salt okunur)	İçgörüler raporu hakkındaki meta veriler.	Yes
└─ isteği	InsightRequest	İçgörü analizi isteği.	Yes
└─ sonuç	InsightResult (salt okunur)	İçgörüler raporunun sonucu.	Hayır
└─ durumu	Azure. Core.Foundations.OperationState (salt okunur)	İçgörülerin geçerli durumu.	Yes
type	enum	Olası değerler: Insight	Yes

InsightSummary

Hata kümesi analizinin özeti.

Name	Türü	Description	Zorunlu	Varsayılan
method	Dize	Kümeleme için kullanılan yöntem.	Yes
sampleCount	integer	Analiz edilen toplam örnek sayısı.	Yes
uniqueClusterCount	integer	Toplam benzersiz küme sayısı.	Yes
uniqueSubclusterCount	integer	Benzersiz alt küme etiketlerinin toplam sayısı.	Yes
usage	ClusterTokenUsage	Küme analizi için belirteç kullanımı	Yes
└─ inputTokenUsage	integer	giriş belirteci kullanımı	Yes
└─ outputTokenUsage	integer	çıkış belirteci kullanımı	Yes
└─ totalTokenUsage	integer	toplam belirteç kullanımı	Yes

InsightType

İçgörülerin isteği.

Property	Değer
Tanım	İçgörülerin isteği.
Türü	Dize
Değerler	EvaluationRunClusterInsight AgentClusterInsight EvaluationComparison

InsightsMetadata

İçgörülerle ilgili meta veriler.

Name	Türü	Description	Zorunlu	Varsayılan
completedAt	Dize	İçgörülerin tamamlandığı zaman damgası.	Hayır
createdAt	Dize	İçgörülerin oluşturulduğu zaman damgası.	Yes

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	Schema
red_team	RedTeamItemGenerationParams
red_team_seed_prompts	RedTeamSeedPromptsItemGenerationParams
red_team_taxonomy	RedTeamTaxonomyItemGenerationParams
response_retrieval	ResponseRetrievalItemGenerationParams

Name	Türü	Description	Zorunlu	Varsayılan
type	ItemGenerationParamsType	Kırmızı takım öğesi oluşturma için parametre türleri.	Yes

ItemGenerationParamsType

Kırmızı takım öğesi oluşturma için parametre türleri.

Property	Değer
Tanım	Kırmızı takım öğesi oluşturma için parametre türleri.
Türü	Dize
Değerler	red_team response_retrieval red_team_seed_prompts red_team_taxonomy synthetic_data_gen_preview

ManagedAzureAISearchIndex

Yönetilen Azure Yapay Zeka Arama Dizin Tanımı

Name	Türü	Description	Zorunlu	Varsayılan
kimlik	dize (salt okunur)	Öğe kimliği, öğe için benzersiz bir tanımlayıcı	Hayır
name	dize (salt okunur)	Kaynağın adı	Yes
type	enum	Dizin türü Olası değerler: ManagedAzureSearch	Yes
version	dize (salt okunur)	Kaynağın sürümü	Yes

ManagedAzureAISearchIndexUpdate

Yönetilen Azure Yapay Zeka Arama Dizin Tanımı

Name	Türü	Description	Zorunlu	Varsayılan
Açıklama	Dize	Varlık açıklaması metni.	Hayır
tags	Obje	Etiket sözlüğü. Etiketler eklenebilir, kaldırılabilir ve güncelleştirilebilir.	Hayır
type	enum	Dizin türü Olası değerler: ManagedAzureSearch	Yes

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	Schema
user_profile	UserProfileMemoryItem
chat_summary	ChatSummaryMemoryItem

Name	Türü	Description	Zorunlu	Varsayılan
içerik	Dize	Belleğin içeriği.	Yes
tür	MemoryItemKind	Bellek öğesi türü.	Yes
memory_id	Dize	Bellek öğesinin benzersiz kimliği.	Yes
scope	Dize	Kullanıcı kimliği gibi anıları mantıksal olarak gruplandıran ve yalıtan ad alanı.	Yes
updated_at	integer	Bellek öğesinin son güncelleme zamanı.	Yes

MemoryItemKind

Bellek öğesi türü.

Property	Değer
Tanım	Bellek öğesi türü.
Türü	Dize
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.

Name	Türü	Description	Zorunlu	Varsayılan
tür	MemoryOperationKind	Bellek işlemi türü.	Yes
memory_item	MemoryItem	Bellek deposunda saklanan, içerik ve meta verileri içeren tek bir bellek öğesi.	Yes
└─ içerik	Dize	Belleğin içeriği.	Yes
└─ tür	MemoryItemKind	Bellek öğesinin türü.	Yes
└─ memory_id	Dize	Bellek öğesinin benzersiz kimliği.	Yes
└─ kapsam	Dize	Kullanıcı kimliği gibi anıları mantıksal olarak gruplandıran ve yalıtan ad alanı.	Yes
└─ updated_at	integer	Bellek öğesinin son güncelleme zamanı.	Yes

MemoryOperationKind

Bellek işlemi türü.

Property	Değer
Tanım	Bellek işlemi türü.
Türü	Dize
Değerler	create update delete

MemorySearchItem

Bellek aramasından alınan bir bellek öğesi.

Name	Türü	Description	Zorunlu	Varsayılan
memory_item	MemoryItem	Bellek deposunda saklanan, içerik ve meta verileri içeren tek bir bellek öğesi.	Yes
└─ içerik	Dize	Belleğin içeriği.	Yes
└─ tür	MemoryItemKind	Bellek öğesinin türü.	Yes
└─ memory_id	Dize	Bellek öğesinin benzersiz kimliği.	Yes
└─ kapsam	Dize	Kullanıcı kimliği gibi anıları mantıksal olarak gruplandıran ve yalıtan ad alanı.	Yes
└─ updated_at	integer	Bellek öğesinin son güncelleme zamanı.	Yes

MemorySearchOptions

Bellek arama seçenekleri.

Name	Türü	Description	Zorunlu	Varsayılan
max_memories	integer	Döndürülecek en fazla bellek öğesi sayısı.	Hayır

MemorySearchPreviewTool

Anıları aracıya entegre etmek için bir araç.

Name	Türü	Description	Zorunlu	Varsayılan
memory_store_name	Dize	Kullanılacak bellek deposunun adı.	Yes
scope	Dize	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.	Yes
search_options	MemorySearchOptions	Bellek arama seçenekleri.	Hayır
└─ max_memories	integer	Döndürülecek en fazla bellek öğesi sayısı.	Hayır
type	enum	Aracın türü. Her zaman memory_search_preview. Olası değerler: memory_search_preview	Yes
update_delay	integer	Hareketsizlikten sonra anıları güncellemeden önce bekleme süresi (saniye). Varsayılan 300.	Hayır	300

MemorySearchToolCallItemParam

Name	Türü	Description	Zorunlu	Varsayılan
results	MemorySearchItem dizisi	Bellek aramasından döndürülen sonuçlar.	Hayır
type	enum	Olası değerler: memory_search_call	Yes

MemorySearchToolCallItemResource

Name	Türü	Description	Zorunlu	Varsayılan
agent_reference	AgentReference		Hayır
└─ ad	Dize	Aracının adı. Kısıtlamalar: maxLength: 256	Yes
└─ türü	enum	Olası değerler: agent_reference	Yes
└─ sürümü	Dize	Aracının sürüm tanımlayıcısı.	Hayır
response_id	Dize	Öğenin oluşturulduğu yanıt.	Hayır
results	MemorySearchItem dizisi	Bellek aramasından döndürülen sonuçlar.	Hayır
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	Yes
type	enum	Olası değerler: memory_search_call	Yes

MemoryStoreDefaultDefinition

Varsayılan bellek deposu uygulaması.

Name	Türü	Description	Zorunlu	Varsayılan
chat_model	Dize	Bellek işleme için kullanılan sohbet tamamlama modeli dağıtımının adı veya tanımlayıcısı.	Yes
embedding_model	Dize	Bellek işleme için kullanılan ekleme modeli dağıtımının adı veya tanımlayıcısı.	Yes
tür	enum	Bellek deposunun türü. Olası değerler: default	Yes
options	MemoryStoreDefaultOptions	Varsayılan bellek deposu yapılandırmaları.	Hayır
└─ chat_summary_enabled	boolean	Sohbet özeti ayıklama ve storage etkinleştirilip etkinleştirilmeyileceği. Varsayılan değer doğrudur	Yes	True
└─ user_profile_details	Dize	Ayıklanacak ve saklanacak belirli kategoriler veya kullanıcı profili bilgisi türleri.	Hayır
└─ user_profile_enabled	boolean	Kullanıcı profili ayıklama ve storage etkinleştirilip etkinleştirilmeyileceği. Varsayılan değer doğrudur	Yes	True

MemoryStoreDefaultOptions

Varsayılan bellek deposu yapılandırmaları.

Name	Türü	Description	Zorunlu	Varsayılan
chat_summary_enabled	boolean	Sohbet özeti ayıklama ve storage etkinleştirilip etkinleştirilmeyileceği. Varsayılan değer doğrudur	Yes	True
user_profile_details	Dize	Ayıklanacak ve saklanacak belirli kategoriler veya kullanıcı profili bilgisi türleri.	Hayır
user_profile_enabled	boolean	Kullanıcı profili ayıklama ve storage etkinleştirilip etkinleştirilmeyileceği. Varsayılan değer doğrudur	Yes	True

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	Schema
default	MemoryStoreDefaultDefinition

Name	Türü	Description	Zorunlu	Varsayılan
tür	MemoryStoreKind	Kullanılacak bellek deposu uygulamasının türü.	Yes

MemoryStoreDeleteScopeResponse

Bir kapsamdan anıları silme yanıtı.

Name	Türü	Description	Zorunlu	Varsayılan
silindi	boolean	Silme işleminin başarılı olup olmadığı.	Yes
name	Dize	Bellek deposunun adı.	Yes
Obje	enum	Nesne türü. Her zaman 'memory_store.scope.deleted'. Olası değerler: memory_store.scope.deleted	Yes
scope	Dize	Belleklerin silindiği kapsam.	Yes

MemoryStoreKind

Kullanılacak bellek deposu uygulamasının türü.

Property	Değer
Tanım	Kullanılacak bellek deposu uygulamasının türü.
Türü	Dize
Değerler	default

MemoryStoreObject

Kullanıcı anılarını depolayabilen ve alabilen bir bellek deposu.

Name	Türü	Description	Zorunlu	Varsayılan
oluşturulma_tarihi	integer	Bellek deposunun oluşturulduğu Unix zaman damgası (saniye).	Yes
tanım	MemoryStoreDefinition	Bellek deposu yapılandırmaları için temel tanım.	Yes
└─ tür	MemoryStoreKind	Bellek deposunun türü.	Yes
Açıklama	Dize	Bellek deposunun okunabilir bir açıklaması. Kısıtlamalar: maxLength: 512	Hayır
kimlik	Dize	Bellek deposunun benzersiz tanımlayıcısı.	Yes
metadata	Obje	Bellek deposuyla ilişkilendirilecek rastgele anahtar-değer meta verileri.	Hayır
name	Dize	Bellek deposunun adı. Kısıtlamalar: maxLength: 256	Yes
Obje	enum	Her zaman 'memory_store' olan nesne türü. Olası değerler: memory_store	Yes
updated_at	integer	Bellek deposunun son güncelleştirildiği Unix zaman damgası (saniye).	Yes

MemoryStoreOperationUsage

Bellek deposu işleminin kullanım istatistikleri.

Name	Türü	Description	Zorunlu	Varsayılan
embedding_tokens	integer	Ekleme belirteçlerinin sayısı.	Yes
input_tokens	OpenAI.integer		Yes
input_tokens_details	OpenAI.ResponseUsageInputTokensDetails		Yes
└─ önbelleğe alınmış jetonlar	OpenAI.integer		Yes
output_tokens	OpenAI.integer		Yes
output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails		Yes
└─ akıl yürütme_tokenlar	OpenAI.integer		Yes
total_tokens	OpenAI.integer		Yes

MemoryStoreSearchResponse

Bellek arama yanıtı.

Name	Türü	Description	Zorunlu	Varsayılan
Anıları	MemorySearchItem dizisi	Arama işlemi sırasında bulunan ilgili bellek öğeleri.	Yes
search_id	Dize	Bu arama isteğinin benzersiz kimliği. Artımlı aramalar yapmak için sonraki isteklerde bu değeri previous_search_id olarak kullanın.	Yes
usage	MemoryStoreOperationUsage	Bellek deposu işleminin kullanım istatistikleri.	Yes
└─ embedding_tokens	integer	Ekleme belirteçlerinin sayısı.	Yes
└─ girdi_simgeleri	OpenAI.integer	Giriş belirteçlerinin sayısı.	Yes
└─ giriş_jeton_detayları	OpenAI.ResponseUsageInputTokensDetails	Giriş belirteçlerinin ayrıntılı dökümü.	Yes
└─ çıkış_birimleri	OpenAI.integer	Çıkış belirteçlerinin sayısı.	Yes
└─ output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails	Çıkış belirteçlerinin ayrıntılı dökümü.	Yes
└─ toplam_jetonlar	OpenAI.integer	Kullanılan toplam belirteç sayısı.	Yes

MemoryStoreUpdateCompletedResult

Bellek güncelleme sonucu.

Name	Türü	Description	Zorunlu	Varsayılan
memory_operations	MemoryOperation dizisi	Güncelleştirme sırasında gerçekleştirilen tek tek bellek işlemlerinin listesi.	Yes
usage	MemoryStoreOperationUsage	Bellek deposu işleminin kullanım istatistikleri.	Yes
└─ embedding_tokens	integer	Ekleme belirteçlerinin sayısı.	Yes
└─ girdi_simgeleri	OpenAI.integer	Giriş belirteçlerinin sayısı.	Yes
└─ giriş_jeton_detayları	OpenAI.ResponseUsageInputTokensDetails	Giriş belirteçlerinin ayrıntılı dökümü.	Yes
└─ çıkış_birimleri	OpenAI.integer	Çıkış belirteçlerinin sayısı.	Yes
└─ output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails	Çıkış belirteçlerinin ayrıntılı dökümü.	Yes
└─ toplam_jetonlar	OpenAI.integer	Kullanılan toplam belirteç sayısı.	Yes

MemoryStoreUpdateResponse

Bellek deposu güncelleştirme işleminin durumunu sağlar.

Name	Türü	Description	Zorunlu	Varsayılan
hata	OpenAI.Error		Hayır
└─ ekBilgi	Obje		Hayır
└─ kod	dize (null atanabilir)		Yes
└─ debugInfo	Obje		Hayır
└─ ayrıntılar	OpenAI.Error dizisi		Hayır
└─ ileti	Dize		Yes
└─ parametre	dize (null atanabilir)		Hayır
└─ türü	Dize		Hayır
result	MemoryStoreUpdateCompletedResult	Bellek güncelleme sonucu.	Hayır
└─ memory_operations	MemoryOperation dizisi	Güncelleştirme sırasında gerçekleştirilen tek tek bellek işlemlerinin listesi.	Yes
└─ kullanımı	MemoryStoreOperationUsage	Bellek güncelleştirme işlemiyle ilişkili kullanım istatistikleri.	Yes
durum	MemoryStoreUpdateStatus	Bellek deposu güncelleştirme işleminin durumu.	Yes
superseded_by	Dize	durum "yerine" olduğunda işlemin update_id yerini alır.	Hayır
update_id	Dize	Bu güncelleştirme isteğinin benzersiz kimliği. Artımlı güncelleştirmeleri gerçekleştirmek için sonraki isteklerde bu değeri previous_update_id olarak kullanın.	Yes

MemoryStoreUpdateStatus

Bellek deposu güncelleştirme işleminin durumu.

Property	Değer
Türü	Dize
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.

Name	Türü	Description	Zorunlu	Varsayılan
fabric_dataagent_preview	FabricDataAgentToolParameters	Yapı veri aracısı aracı parametreleri.	Yes
└─ project_connections	ToolProjectConnection dizisi	Bu ara çubuğuna bağlı project bağlantıları. En fazla 1 bağlantı olabilir aracına bağlı kaynak. Kısıtlamalar: maxItems: 1	Hayır
type	enum	Her zaman 'fabric_dataagent_preview' olan nesne türü. Olası değerler: fabric_dataagent_preview	Yes

Model Dağıtımı

Model Dağıtım Tanımı

Name	Türü	Description	Zorunlu	Varsayılan
capabilities	object (salt okunur)	Dağıtılan modelin özellikleri	Yes
Connectionname	dize (salt okunur)	Dağıtımın geldiği bağlantının adı	Hayır
modelName	dize (salt okunur)	Dağıtılan modelin Publisher özel adı	Yes
modelPublisher	dize (salt okunur)	Dağıtılan modelin yayımcısının adı	Yes
modelVersion	dize (salt okunur)	Dağıtılan modelin Publisher özel sürümü	Yes
name	dize (salt okunur)	Dağıtımın adı	Yes
sku	Sku (salt okunur)	Sku bilgileri	Yes
└─ kapasite	integer	Sku kapasitesi	Yes
└─ aile	Dize	Sku ailesi	Yes
└─ ad	Dize	Sku adı	Yes
└─ boyutu	Dize	Sku boyutu	Yes
└─ katmanı	Dize	Sku katmanı	Yes
type	enum	Dağıtımın türü Olası değerler: ModelDeployment	Yes

ModelÖrnekLemeParamları

Metin oluşturma sırasında dil modelinin örnekleme davranışını denetlemek için kullanılan bir parametre kümesini temsil eder.

Name	Türü	Description	Zorunlu	Varsayılan
max_completion_tokens	integer	Tamamlanmada izin verilen en fazla belirteç sayısı.	Yes
seed	integer	Yeniden üretilebilirlik için rastgele tohum.	Yes
sıcaklık	number	Örnekleme için sıcaklık parametresi.	Yes
top_p	number	Çekirdek örnekleme için top-p parametresi.	Yes

ModelSamplingParamsUpdate

Metin oluşturma sırasında dil modelinin örnekleme davranışını denetlemek için kullanılan bir parametre kümesini temsil eder.

Name	Türü	Description	Zorunlu	Varsayılan
max_completion_tokens	integer	Tamamlanmada izin verilen en fazla belirteç sayısı.	Hayır
seed	integer	Yeniden üretilebilirlik için rastgele tohum.	Hayır
sıcaklık	number	Örnekleme için sıcaklık parametresi.	Hayır
top_p	number	Çekirdek örnekleme için top-p parametresi.	Hayır

MonthlyRecurrenceSchedule

Aylık yinelenme zamanlaması.

Name	Türü	Description	Zorunlu	Varsayılan
daysOfMonth	tamsayı dizisi	Yinelenme zamanlaması için ayın günleri.	Yes
type	enum	Aylık yinelenme türü. Olası değerler: Monthly	Yes

NoAuthenticationCredentials

Kimlik doğrulaması gerektirmeyen kimlik bilgileri

Name	Türü	Description	Zorunlu	Varsayılan
type	enum	Kimlik bilgisi türü Olası değerler: None	Yes

OAuthConsentRequestOutputItem

Hizmetten kullanıcının OAuth onayı gerçekleştirmesini isteyin.

Name	Türü	Description	Zorunlu	Varsayılan
agent_reference	AgentReference		Hayır
└─ ad	Dize	Aracının adı. Kısıtlamalar: maxLength: 256	Yes
└─ türü	enum	Olası değerler: agent_reference	Yes
└─ sürümü	Dize	Aracının sürüm tanımlayıcısı.	Hayır
consent_link	Dize	Kullanıcının OAuth onayı gerçekleştirmek için kullanabileceği bağlantı.	Yes
kimlik	Dize		Yes
response_id	Dize	Öğenin oluşturulduğu yanıt.	Hayır
sunucu etiketi	Dize	OAuth onay isteğinin sunucu etiketi.	Yes
type	enum	Olası değerler: oauth_consent_request	Yes

OneTimeTrigger

Tek seferlik tetikleyici.

Name	Türü	Description	Zorunlu	Varsayılan
timeZone	Dize	Tek seferlik tetikleyici için saat dilimi.	Hayır	UTC
triggerAt	Dize	ISO 8601 biçiminde tek seferlik tetikleyicinin tarih ve saati.	Yes
type	enum	Olası değerler: OneTime	Yes

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	Schema
file_citation	OpenAI.FileCitationBody
url_citation	OpenAI.UrlCitationBody
container_file_citation	OpenAI.ContainerFileCitationBody
file_path	OpenAI.FilePath

Name	Türü	Description	Zorunlu	Varsayılan
type	OpenAI.AnnotationType		Yes

OpenAI.AnnotationType

Property	Değer
Türü	Dize
Değerler	file_citation url_citation container_file_citation file_path

OpenAI.ApplyPatchCallOutputStatus

Property	Değer
Türü	Dize
Değerler	completed failed

OpenAI.ApplyPatchCallOutputStatusParam

apply_patch araç çağrısı çıkışları için bildirilen sonuç değerleri.

Property	Değer
Türü	Dize
Değerler	completed failed

OpenAI.ApplyPatchCallStatus

Property	Değer
Türü	Dize
Değerler	in_progress completed

OpenAI.ApplyPatchCallStatusParam

apply_patch araç çağrıları için bildirilen durum değerleri.

Property	Değer
Türü	Dize
Değerler	in_progress completed

OpenAI.ApplyPatchCreateFileOperation

apply_patch aracı aracılığıyla dosya oluşturmayı açıklayan yönerge.

Name	Türü	Description	Zorunlu	Varsayılan
Fark	Dize	Uygulanacak fark.	Yes
path	Dize	Oluşturulacak dosyanın yolu.	Yes
type	enum	Sağlanan fark ile yeni bir dosya oluşturun. Olası değerler: create_file	Yes

OpenAI.ApplyPatchCreateFileOperationParam

apply_patch aracı aracılığıyla yeni dosya oluşturma yönergesi.

Name	Türü	Description	Zorunlu	Varsayılan
Fark	Dize	Dosyayı oluştururken uygulanacak birleşik fark içeriği. Kısıtlamalar: maxLength: 10485760	Yes
path	Dize	Çalışma alanı köküne göre oluşturulacak dosyanın yolu. Kısıtlamalar: minLength: 1	Yes
type	enum	İşlem türü. Her zaman create_file. Olası değerler: create_file	Yes

OpenAI.ApplyPatchDeleteFileOperation

apply_patch aracı aracılığıyla bir dosyanın nasıl silineceği hakkında yönergeler.

Name	Türü	Description	Zorunlu	Varsayılan
path	Dize	Silinecek dosyanın yolu.	Yes
type	enum	Belirtilen dosyayı silin. Olası değerler: delete_file	Yes

OpenAI.ApplyPatchDeleteFileOperationParam

apply_patch aracı aracılığıyla var olan bir dosyayı silme yönergesi.

Name	Türü	Description	Zorunlu	Varsayılan
path	Dize	Çalışma alanı köküne göre silinecek dosyanın yolu. Kısıtlamalar: minLength: 1	Yes
type	enum	İşlem türü. Her zaman delete_file. Olası değerler: delete_file	Yes

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	Schema
create_file	OpenAI.ApplyPatchCreateFileOperation
delete_file	OpenAI.ApplyPatchDeleteFileOperation
update_file	OpenAI.ApplyPatchUpdateFileOperation

Name	Türü	Description	Zorunlu	Varsayılan
type	OpenAI.ApplyPatchFileOperationType		Yes

OpenAI.ApplyPatchFileOperationType

Property	Değer
Türü	Dize
Değerler	create_file delete_file update_file

OpenAI.ApplyPatchOperationParam

apply_patch aracına sağlanan create_file, delete_file veya update_file işlemlerinden 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	Schema
create_file	OpenAI.ApplyPatchCreateFileOperationParam
delete_file	OpenAI.ApplyPatchDeleteFileOperationParam
update_file	OpenAI.ApplyPatchUpdateFileOperationParam

Name	Türü	Description	Zorunlu	Varsayılan
type	OpenAI.ApplyPatchOperationParamType		Yes

OpenAI.ApplyPatchOperationParamType

Property	Değer
Türü	Dize
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.

Name	Türü	Description	Zorunlu	Varsayılan
type	enum	Aracın türü. Her zaman apply_patch. Olası değerler: apply_patch	Yes

OpenAI.ApplyPatchUpdateFileOperation

apply_patch aracı aracılığıyla bir dosyanın nasıl güncelleştirileceklerini açıklayan yönerge.

Name	Türü	Description	Zorunlu	Varsayılan
Fark	Dize	Uygulanacak fark.	Yes
path	Dize	Güncelleştirilecek dosyanın yolu.	Yes
type	enum	Mevcut bir dosyayı sağlanan farkla güncelleştirin. Olası değerler: update_file	Yes

OpenAI.ApplyPatchUpdateFileOperationParam

apply_patch aracı aracılığıyla var olan bir dosyayı güncelleştirme yönergesi.

Name	Türü	Description	Zorunlu	Varsayılan
Fark	Dize	Mevcut dosyaya uygulanacak birleşik fark içeriği. Kısıtlamalar: maxLength: 10485760	Yes
path	Dize	Çalışma alanı köküne göre güncelleştirilecek dosyanın yolu. Kısıtlamalar: minLength: 1	Yes
type	enum	İşlem türü. Her zaman update_file. Olası değerler: update_file	Yes

OpenAI.YaklaşıkKonum

Name	Türü	Description	Zorunlu	Varsayılan
city	dize (null atanabilir)		Hayır
country	dize (null atanabilir)		Hayır
region	dize (null atanabilir)		Hayır
timezone	dize (null atanabilir)		Hayır
type	enum	Konum yaklaşımının türü. Her zaman approximate. Olası değerler: approximate	Yes

OpenAI Sohbet Tamamlama Aracı

Yanıt oluşturmak için kullanılabilecek bir işlev aracı.

Name	Türü	Description	Zorunlu	Varsayılan
function	OpenAI.FunctionObject		Yes
type	enum	Aracın türü. Şu anda yalnızca function desteklenmektedir. Olası değerler: function	Yes

OpenAI.ChatModel

Property	Değer
Türü	Dize
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

Property	Değer
Türü	Dize
Değerler	left right wheel back forward

OpenAI.ClickParam

Tıklama eylemi.

Name	Türü	Description	Zorunlu	Varsayılan
düğme	OpenAI.ClickButtonType		Yes
type	enum	Olay türünü belirtir. Tıklama hareketi için bu özellik her clickzaman . Olası değerler: click	Yes
x	OpenAI.integer		Yes
y	OpenAI.integer		Yes

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.

Name	Türü	Description	Zorunlu	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ır
bellek sınırı	OpenAI.ContainerMemoryLimit (null atanabilir)		Hayır
type	enum	Her zaman auto. Olası değerler: auto	Yes

OpenAI.KodYorumlayıcıÇıktıGörüntüsü

Kod yorumlayıcıdan görüntü çıkışı.

Name	Türü	Description	Zorunlu	Varsayılan
type	enum	Çıktının türü. Her zaman image. Olası değerler: image	Yes
url	Dize	Kod yorumlayıcıdan görüntü çıkışının URL'si.	Yes

OpenAI.KodYorumlayıcıÇıkışLogları

Kod yorumlayıcısının günlük çıktısı.

Name	Türü	Description	Zorunlu	Varsayılan
logs	Dize	Kod yorumlayıcısının günlük çıktısı.	Yes
type	enum	Çıktının türü. Her zaman logs. Olası değerler: logs	Yes

OpenAI.CodeInterpreterTool

Bir istem için yanıt oluşturmaya yardımcı olmak için Python kodu çalıştıran bir araç.

Name	Türü	Description	Zorunlu	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ır
type	enum	Kod yorumlayıcı aracının türü. Her zaman code_interpreter. Olası değerler: code_interpreter	Yes

OpenAI.CompactResource

Name	Türü	Description	Zorunlu	Varsayılan
oluşturulma_tarihi	integer	Sıkıştırılmış konuşmanın oluşturulduğu Unix zaman damgası (saniye).	Yes
kimlik	Dize	Sıkıştırılmış yanıtın benzersiz tanımlayıcısı.	Yes
Obje	enum	Nesne türü. Her zaman response.compaction. Olası değerler: response.compaction	Yes
output	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.	Yes
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ü.	Yes
└─ girdi_simgeleri	OpenAI.integer	Giriş belirteçlerinin sayısı.	Yes
└─ giriş_jeton_detayları	OpenAI.ResponseUsageInputTokensDetails	Giriş belirteçlerinin ayrıntılı dökümü.	Yes
└─ çıkış_birimleri	OpenAI.integer	Çıkış belirteçlerinin sayısı.	Yes
└─ output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails	Çıkış belirteçlerinin ayrıntılı dökümü.	Yes
└─ toplam_jetonlar	OpenAI.integer	Kullanılan toplam belirteç sayısı.	Yes

OpenAI.CompactResponseMethodPublicBody

Name	Türü	Description	Zorunlu	Varsayılan
input	OpenAI.InputItem dizesi veya dizisi		Hayır
instructions	dize (null atanabilir)		Hayır
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.	Yes
previous_response_id	dize (null atanabilir)		Hayır

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.

Name	Türü	Description	Zorunlu	Varsayılan
key	Dize	Değerle karşılaştırmak için anahtar.	Yes
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	Yes
value	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.	Yes

OpenAI.ComparisonFilterValueItems

Tür: dize veya OpenAI.numeric

OpenAI.CompoundFilter

and veya or kullanarak birden çok filtreyi birleştirin.

Name	Türü	Description	Zorunlu	Varsayılan
filters	OpenAI.ComparisonFilter dizisi veya nesnesi	Birleştirilecek filtreler dizisi. Öğeler ComparisonFilter veya CompoundFilter olabilir.	Yes
type	enum	İşlem türü: and veya or. Olası değerler: and, or	Yes

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	Schema
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

Name	Türü	Description	Zorunlu	Varsayılan
type	OpenAI.ComputerActionType		Yes

OpenAI.ComputerActionType

Property	Değer
Türü	Dize
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.

Name	Türü	Description	Zorunlu	Varsayılan
code	dize (null atanabilir)		Hayır
kimlik	Dize	Bekleyen güvenlik denetiminin kimliği.	Yes
message	dize (null atanabilir)		Hayır

OpenAI.ComputerEnvironment

Property	Değer
Türü	Dize
Değerler	windows mac linux ubuntu browser

OpenAI.ComputerScreenshotContent

Bilgisayarın ekran görüntüsü.

Name	Türü	Description	Zorunlu	Varsayılan
dosya_kimlik	dize (null atanabilir)		Yes
image_url	Dize		Yes
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	Yes

OpenAI.ComputerScreenshotImage

Bilgisayar kullanım aracıyla kullanılan bir bilgisayar ekran görüntüsü.

Name	Türü	Description	Zorunlu	Varsayılan
dosya_kimlik	Dize	Yüklenmiş dosyanın, ekran görüntüsünü içeren kimliği.	Hayır
image_url	Dize	Ekran görüntüsü URL'si.	Hayır
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	Yes

OpenAI Bilgisayar Kullanımı Önizleme Aracı

Sanal bilgisayarı denetleyebilen bir araç.

Name	Türü	Description	Zorunlu	Varsayılan
görüntü yüksekliği	OpenAI.integer		Yes
görüntü genişliği	OpenAI.integer		Yes
environment	OpenAI.ComputerEnvironment		Yes
type	enum	Bilgisayar kullanım aracının türü. Her zaman computer_use_preview. Olası değerler: computer_use_preview	Yes

OpenAI.ContainerFileCitationBody

Model yanıtı oluşturmak için kullanılan bir konteyner dosyası için bir atıf.

Name	Türü	Description	Zorunlu	Varsayılan
container_id	Dize	Konteyner dosyasının kimliği.	Yes
end_index	OpenAI.integer		Yes
dosya_kimlik	Dize	Dosyanın kimliği.	Yes
filename	Dize	Bahsedilen konteyner dosyasının dosya adı.	Yes
start_index	OpenAI.integer		Yes
type	enum	Konteyner dosyası atıfının türü. Her zaman container_file_citation. Olası değerler: container_file_citation	Yes

OpenAI.ContainerMemoryLimit

Property	Değer
Türü	Dize
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	Schema
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

Name	Türü	Description	Zorunlu	Varsayılan
type	OpenAI.ConversationItemType		Yes

OpenAI.ConversationItemApplyPatchToolCall

Dosya oluşturarak, silerek veya güncelleştirerek dosya farklarını uygulayan bir araç çağrısı.

Name	Türü	Description	Zorunlu	Varsayılan
call_id	Dize	Model tarafından oluşturulan uygulama yama aracı çağrısının benzersiz kimliği.	Yes
Oluşturan	Dize	Bu araç çağrısını oluşturan varlığın kimliği.	Hayır
kimlik	Dize	Düzeltme eki uygulama aracı çağrısının benzersiz kimliği. Bu öğe, API aracılığıyla iade edildiğinde doldurulur.	Yes
Operasyon	OpenAI.ApplyPatchFileOperation	apply_patch aracılığıyla uygulanan create_file, delete_file veya update_file işlemlerinden biri.	Yes
└─ türü	OpenAI.ApplyPatchFileOperationType		Yes
durum	OpenAI.ApplyPatchCallStatus		Yes
type	enum	Öğenin türü. Her zaman apply_patch_call. Olası değerler: apply_patch_call	Yes

OpenAI.ConversationItemApplyPatchToolCallOutput

Bir düzeltme eki uygulama aracı çağrısı tarafından yayılan çıkış.

Name	Türü	Description	Zorunlu	Varsayılan
call_id	Dize	Model tarafından oluşturulan uygulama yama aracı çağrısının benzersiz kimliği.	Yes
Oluşturan	Dize	Bu aracı oluşturan varlığın kimliği çağrı çıktısı.	Hayır
kimlik	Dize	Düzeltme eki uygulama aracı çağrı çıkışının benzersiz kimliği. Bu öğe, API aracılığıyla iade edildiğinde doldurulur.	Yes
output	dize (null atanabilir)		Hayır
durum	OpenAI.ApplyPatchCallOutputStatus		Yes
type	enum	Öğenin türü. Her zaman apply_patch_call_output. Olası değerler: apply_patch_call_output	Yes

OpenAI.ConversationItemCodeInterpreterToolCall

Kodu çalıştırmak için bir araç çağrısı.

Name	Türü	Description	Zorunlu	Varsayılan
code	dize (null atanabilir)		Yes
container_id	Dize	Kodu çalıştırmak için kullanılan kapsayıcının kimliği.	Yes
kimlik	Dize	Kod yorumlayıcısı araç çağrısının benzersiz kimliği.	Yes
outputs	OpenAI.CodeInterpreterOutputLogs veya OpenAI.CodeInterpreterOutputImage dizisi		Yes
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	Yes
type	enum	Kod yorumlayıcı aracı çağrısının türü. Her zaman code_interpreter_call. Olası değerler: code_interpreter_call	Yes

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.

Name	Türü	Description	Zorunlu	Varsayılan
action	OpenAI.ComputerAction		Yes
call_id	Dize	Çıkış verisi ile araç çağrısına yanıt verirken kullanılan tanımlayıcı.	Yes
kimlik	Dize	Bilgisayar çağrısının benzersiz tanımlayıcısı.	Yes
pending_safety_checks	OpenAI.ComputerCallSafetyCheckParam dizisi	Bilgisayar çağrısı için bekleyen güvenlik denetimleri.	Yes
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	Yes
type	enum	Bilgisayar çağrısının türü. Her zaman computer_call. Olası değerler: computer_call	Yes

OpenAI.ConversationItemComputerToolCallOutputResource

Name	Türü	Description	Zorunlu	Varsayılan
acknowledged_safety_checks	OpenAI.ComputerCallSafetyCheckParam dizisi	API tarafından bildirilen ve kabul edilen güvenlik kontrolleri geliştirici.	Hayır
call_id	Dize	Çıktı üreten bilgisayar aracı çağrısının kimliği.	Yes
kimlik	Dize	Bilgisayar aracı çağrısı çıkış kimliği.	Hayır
output	OpenAI.ComputerScreenshotImage	Bilgisayar kullanım aracıyla kullanılan bir bilgisayar ekran görüntüsü.	Yes
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ır
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	Yes

OpenAI.ConversationItemCustomToolCall

Model tarafından oluşturulan özel bir araca çağrı.

Name	Türü	Description	Zorunlu	Varsayılan
call_id	Dize	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ı.	Yes
kimlik	Dize	OpenAI platformundaki özel araç çağrısının benzersiz kimliği.	Hayır
input	Dize	Model tarafından oluşturulan özel araç çağrısı için girdi.	Yes
name	Dize	Çağrılan özel aracın adı.	Yes
type	enum	Özel araç çağrısının türü. Her zaman custom_tool_call. Olası değerler: custom_tool_call	Yes

OpenAI.ConversationItemCustomToolCallOutput

Kodunuzdan özel bir araç çağrısının çıktısı, modele geri gönderiliyor.

Name	Türü	Description	Zorunlu	Varsayılan
call_id	Dize	Ç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.	Yes
kimlik	Dize	OpenAI platformunda çıkan özel araç çağrısının benzersiz kimliği.	Hayır
output	OpenAI.FunctionAndCustomToolCallOutput dizesi veya dizisi	Kodunuz tarafından oluşturulan özel araç çağrısından çıkan çıktı. Bir dize veya çıkış içeriği listesi olabilir.	Yes
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	Yes

OpenAI.ConversationItemFileSearchToolCall

Dosya arama aracı çağrısının sonuçları. Daha fazla bilgi için dosya arama rehberi adresine bakınız.

Name	Türü	Description	Zorunlu	Varsayılan
kimlik	Dize	Dosya arama aracı çağrısının benzersiz kimliği.	Yes
queries	dize dizisi	Dosyaları aramak için kullanılan sorgular.	Yes
results	OpenAI.FileSearchToolCallResults dizisi		Hayır
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	Yes
type	enum	Dosya arama aracı çağrısının türü. Her zaman file_search_call. Olası değerler: file_search_call	Yes

OpenAI.ConversationItemFunctionShellCall

Yönetilen bir ortamda bir veya daha fazla kabuk komutu yürüten bir araç çağrısı.

Name	Türü	Description	Zorunlu	Varsayılan
action	OpenAI.FunctionShellAction	Bir kabuk komutu yürütür.	Yes
└─ komutları	dize dizisi		Yes
└─ max_output_length	OpenAI.integer (null atanabilir)		Yes
└─ timeout_ms	OpenAI.integer (null atanabilir)		Yes
call_id	Dize	Model tarafından oluşturulan shell araç çağrısının benzersiz kimliği.	Yes
Oluşturan	Dize	Bu araç çağrısını oluşturan varlığın kimliği.	Hayır
kimlik	Dize	Kabuk aracı çağrısının benzersiz kimliği. Bu öğe, API aracılığıyla iade edildiğinde doldurulur.	Yes
durum	OpenAI.LocalShellCallStatus		Yes
type	enum	Öğenin türü. Her zaman shell_call. Olası değerler: shell_call	Yes

OpenAI.ConversationItemFunctionShellCallOutput

Yayılan bir kabuk aracı çağrısının çıktısı.

Name	Türü	Description	Zorunlu	Varsayılan
call_id	Dize	Model tarafından oluşturulan shell araç çağrısının benzersiz kimliği.	Yes
Oluşturan	Dize	Öğeyi oluşturan aktörün tanımlayıcısı.	Hayır
kimlik	Dize	Kabuk çağrısı çıkışının benzersiz kimliği. Bu öğe, API aracılığıyla iade edildiğinde doldurulur.	Yes
max_output_length	OpenAI.integer (null atanabilir)		Yes
output	OpenAI.FunctionShellCallOutputContent dizisi	Kabuk çağrısı çıkış içeriği dizisi	Yes
type	enum	Kabuk çağrısı çıkışının türü. Her zaman shell_call_output. Olası değerler: shell_call_output	Yes

OpenAI.ConversationItemFunctionToolCallOutputResource

Name	Türü	Description	Zorunlu	Varsayılan
call_id	Dize	Model tarafından oluşturulan işlev aracı çağrısının benzersiz kimliği.	Yes
kimlik	Dize	İş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ır
output	OpenAI.FunctionAndCustomToolCallOutput dizesi veya dizisi	Kodunuz tarafından oluşturulan işlev çağrısının çıktısı. Bir dize veya çıkış içeriği listesi olabilir.	Yes
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ır
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	Yes

OpenAI.ConversationItemFunctionToolCallResource

Name	Türü	Description	Zorunlu	Varsayılan
arguments	Dize	İşleve geçirecek bağımsız değişkenlerin JSON dizesi.	Yes
call_id	Dize	Model tarafından oluşturulan işlev aracı çağrısının benzersiz kimliği.	Yes
kimlik	Dize	İşlev aracı çağrısının benzersiz kimliği.	Hayır
name	Dize	Çalıştırılacak işlevin adı.	Yes
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ır
type	enum	İşlev aracı çağrısının türü. Her zaman function_call. Olası değerler: function_call	Yes

OpenAI.ConversationItemImageGenToolCall

Model tarafından yapılan bir görüntü oluşturma isteği.

Name	Türü	Description	Zorunlu	Varsayılan
kimlik	Dize	Görüntü oluşturma çağrısının benzersiz kimliği.	Yes
result	dize (null atanabilir)		Yes
durum	enum	Görüntü oluşturma çağrısının durumu. Olası değerler: in_progress, completed, generating, failed	Yes
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	Yes

OpenAI.ConversationItemList

Konuşma öğelerinin listesi.

Name	Türü	Description	Zorunlu	Varsayılan
data	OpenAI.ConversationItem dizisi	Konuşma öğelerinin listesi.	Yes
ilk_kimlik	Dize	Listedeki ilk öğenin kimliği.	Yes
daha_fazla	boolean	Kullanılabilir daha fazla öğe olup olmadığı.	Yes
son_kimlik	Dize	Listedeki son öğenin kimliği.	Yes
Obje	enum	Döndürülen nesnenin türü olmalıdır list. Olası değerler: list	Yes

OpenAI.ConversationItemLocalShellToolCall

Yerel kabukta komut çalıştırmak için bir araç çağrısı.

Name	Türü	Description	Zorunlu	Varsayılan
action	OpenAI.LocalShellExecAction	Sunucuda bir shell komutu çalıştırın.	Yes
call_id	Dize	Model tarafından oluşturulan yerel kabuk aracı çağrısının benzersiz kimliği.	Yes
kimlik	Dize	Yerel shell çağrısının benzersiz kimliği.	Yes
durum	enum	Yerel shell çağrısının durumu. Olası değerler: in_progress, completed, incomplete	Yes
type	enum	Yerel shell call'ın türü. Her zaman local_shell_call. Olası değerler: local_shell_call	Yes

OpenAI.ConversationItemLocalShellToolCallOutput

Yerel kabuk aracı çağrısının çıktısı.

Name	Türü	Description	Zorunlu	Varsayılan
kimlik	Dize	Model tarafından oluşturulan yerel kabuk aracı çağrısının benzersiz kimliği.	Yes
output	Dize	Yerel shell aracı çağrısının çıktısının JSON dizesi.	Yes
durum	enum	Olası değerler: in_progress, completed, incomplete	Hayır
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	Yes

OpenAI.ConversationItemMcpApprovalRequest

Bir araç çağrısı işlemi için insan onayı isteği.

Name	Türü	Description	Zorunlu	Varsayılan
arguments	Dize	Araç için bir JSON bağımsız değişken dizesi.	Yes
kimlik	Dize	Onay talebinin benzersiz kimliği.	Yes
name	Dize	Çalıştırılacak aracın adı.	Yes
sunucu etiketi	Dize	İsteği yapan MCP sunucusunun etiketi.	Yes
type	enum	Öğenin türü. Her zaman mcp_approval_request. Olası değerler: mcp_approval_request	Yes

OpenAI.ConversationItemMcpApprovalResponseResource

MCP onay isteğine yanıt.

Name	Türü	Description	Zorunlu	Varsayılan
approval_request_id	Dize	Yanıtlanan onay isteğinin ID'si.	Yes
approve	boolean	İsteğin onaylanıp onaylanmadı.	Yes
kimlik	Dize	Onay yanıtının benzersiz kimliği	Yes
neden	dize (null atanabilir)		Hayır
type	enum	Öğenin türü. Her zaman mcp_approval_response. Olası değerler: mcp_approval_response	Yes

OpenAI.ConversationItemMcpListTools

MCP sunucusunda kullanılabilen araçların listesi.

Name	Türü	Description	Zorunlu	Varsayılan
hata	dize (null atanabilir)		Hayır
kimlik	Dize	Listenin benzersiz kimliği.	Yes
sunucu etiketi	Dize	MCP sunucusunun etiketi.	Yes
tools	OpenAI.MCPListToolsTool dizisi	Sunucuda bulunan araçlar.	Yes
type	enum	Öğenin türü. Her zaman mcp_list_tools. Olası değerler: mcp_list_tools	Yes

OpenAI.ConversationItemMcpToolCall

MCP sunucusundaki bir aracın çağrılması.

Name	Türü	Description	Zorunlu	Varsayılan
approval_request_id	dize (null atanabilir)		Hayır
arguments	Dize	Araca geçirilen bağımsız değişkenlerin JSON dizesi.	Yes
hata	dize (null atanabilir)		Hayır
kimlik	Dize	Araç çağrısının benzersiz kimliği.	Yes
name	Dize	Çalıştırılan aracın adı.	Yes
output	dize (null atanabilir)		Hayır
sunucu etiketi	Dize	Aracı çalıştıran MCP sunucusunun etiketi.	Yes
durum	OpenAI.MCPToolCallStatus		Hayır
type	enum	Öğenin türü. Her zaman mcp_call. Olası değerler: mcp_call	Yes

OpenAI.ConversationItemMessage

Modele veya modelden gelen bir ileti.

Name	Türü	Description	Zorunlu	Varsayılan
içerik	OpenAI.MessageContent dizisi	İletinin içeriği	Yes
kimlik	Dize	İletinin benzersiz kimliği.	Yes
role	OpenAI.MessageRole		Yes
durum	OpenAI.MessageStatus		Yes
type	enum	İletinin türü. Her zaman messageolarak ayarlayın. Olası değerler: message	Yes

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 input ile manuel olarak konuşuyorsanız, Responses API'ye hesabınıza dahil edin.

Name	Türü	Description	Zorunlu	Varsayılan
içerik	OpenAI.ReasoningTextContent dizisi	Metin içeriğini akıl yürütme.	Hayır
encrypted_content	dize (null atanabilir)		Hayır
kimlik	Dize	Akıl yürütme içeriğinin benzersiz tanımlayıcısı.	Yes
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ır
summary	OpenAI.Summary dizisi	Akıl yürütme özeti içeriği.	Yes
type	enum	Nesnenin türü. Her zaman reasoning. Olası değerler: reasoning	Yes

OpenAI.ConversationItemType

Property	Değer
Türü	Dize
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.

Name	Türü	Description	Zorunlu	Varsayılan
action	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).	Yes
kimlik	Dize	Web arama aracının benzersiz kimliği çağrı.	Yes
durum	enum	Web arama aracı çağrısının durumu. Olası değerler: in_progress, searching, completed, failed	Yes
type	enum	Web arama aracının türü. Her zaman web_search_call. Olası değerler: web_search_call	Yes

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.

Name	Türü	Description	Zorunlu	Varsayılan
kimlik	Dize	Konuşmanın benzersiz kimliği.	Yes

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.

Name	Türü	Description	Zorunlu	Varsayılan
kimlik	Dize	Bu yanıtın ilişkilendirildiği konuşmanın benzersiz kimliği.	Yes

OpenAI.ConversationResource

Name	Türü	Description	Zorunlu	Varsayılan
oluşturulma_tarihi	integer	Unix döneminin ardından saniye cinsinden ölçülen konuşmanın oluşturulduğu zaman.	Yes
kimlik	Dize	Konuşmanın benzersiz kimliği.	Yes
metadata	OpenAI.Metadata	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu olabilir 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.	Yes
Obje	enum	Her zaman conversationolan nesne türü. Olası değerler: conversation	Yes

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	Schema
text	OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText
json_object	OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject

Name	Türü	Description	Zorunlu	Varsayılan
type	OpenAI.CreateChatCompletionRequestResponseFormatType		Yes

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ı iletisi olmadan JSON oluşturmayacağını unutmayın.

Name	Türü	Description	Zorunlu	Varsayılan
type	enum	Tanımlanan yanıt biçiminin türü. Her zaman json_object. Olası değerler: json_object	Yes

OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText

Varsayılan yanıt biçimi. Metin yanıtları oluşturmak için kullanılır.

Name	Türü	Description	Zorunlu	Varsayılan
type	enum	Tanımlanan yanıt biçiminin türü. Her zaman text. Olası değerler: text	Yes

OpenAI.CreateChatCompletionRequestResponseFormatType

Property	Değer
Türü	Dize
Değerler	text json_schema json_object

OpenAI.CreateConversationBody

Name	Türü	Description	Zorunlu	Varsayılan
items	OpenAI.InputItem dizisi		Hayır
metadata	OpenAI.Metadata (null atanabilir)	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu olabilir 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ır

OpenAI.CreateEvalCompletionsRunDataSource

Model örnekleme yapılandırmasını açıklayan CompletionsRunDataSource nesnesi.

Name	Türü	Description	Zorunlu	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ır
model	Dize	Tamamlanmaları oluşturmak için kullanılacak modelin adı (örneğin, "o3-mini").	Hayır
Örnekleme_Parametreleri	OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams		Hayır
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.	Yes
type	enum	Çalıştırma veri kaynağının türü. Her zaman completions. Olası değerler: completions	Yes

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference

Name	Türü	Description	Zorunlu	Varsayılan
item_reference	Dize		Yes
type	enum	Olası değerler: item_reference	Yes

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesTemplate

Name	Türü	Description	Zorunlu	Varsayılan
template	OpenAI.EasyInputMessage veya OpenAI.EvalItem dizisi		Yes
type	enum	Olası değerler: template	Yes

OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams

Name	Türü	Description	Zorunlu	Varsayılan
max_completion_tokens	OpenAI.integer		Hayır
akıl yürütme çabası	OpenAI.ReasoningEffort	Akıl yürütmeye yönelik çabayı kısıtlar mantık 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ır
yanıt formatı	OpenAI.ResponseFormatText veya OpenAI.ResponseFormatJsonSchema veya OpenAI.ResponseFormatJsonObject		Hayır
seed	OpenAI.integer		Hayır	42
sıcaklık	OpenAI.numeric		Hayır	1
tools	OpenAI.ChatCompletionTool dizisi		Hayır
top_p	OpenAI.numeric		Hayır	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?

Name	Türü	Description	Zorunlu	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ır
öğe şeması	Obje	Veri kaynağındaki her satır için json şeması.	Yes
type	enum	Veri kaynağının türü. Her zaman custom. Olası değerler: custom	Yes

OpenAI.CreateEvalJsonlRunDataSource

Değerlendirmeyle eşleşen JSONL dosyasını belirten bir JsonlRunDataSource nesnesi

Name	Türü	Description	Zorunlu	Varsayılan
kaynak	OpenAI.EvalJsonlFileContentSource veya OpenAI.EvalJsonlFileIdSource	Veri kaynağındaki ad alanını item neyin doldurdığını belirler.	Yes
type	enum	Veri kaynağının türü. Her zaman jsonl. Olası değerler: jsonl	Yes

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.

Name	Türü	Description	Zorunlu	Varsayılan
metadata	Obje	Log veri kaynağı için meta veri filtreleri.	Hayır
type	enum	Veri kaynağının türü. Her zaman logs. Olası değerler: logs	Yes

OpenAI.CreateEvalResponsesRunDataSource

Model örnekleme yapılandırmasını açıklayan Bir ResponsesRunDataSource nesnesi.

Name	Türü	Description	Zorunlu	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ır
model	Dize	Tamamlanmaları oluşturmak için kullanılacak modelin adı (örneğin, "o3-mini").	Hayır
Örnekleme_Parametreleri	OpenAI.CreateEvalResponsesRunDataSourceSamplingParams		Hayır
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.	Yes
type	enum	Çalıştırma veri kaynağının türü. Her zaman responses. Olası değerler: responses	Yes

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference

Name	Türü	Description	Zorunlu	Varsayılan
item_reference	Dize		Yes
type	enum	Olası değerler: item_reference	Yes

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate

Name	Türü	Description	Zorunlu	Varsayılan
template	object dizisi veya OpenAI.EvalItem		Yes
type	enum	Olası değerler: template	Yes

OpenAI.CreateEvalResponsesRunDataSourceSamplingParams

Name	Türü	Description	Zorunlu	Varsayılan
max_completion_tokens	OpenAI.integer		Hayır
akıl yürütme çabası	OpenAI.ReasoningEffort	Akıl yürütmeye yönelik çabayı kısıtlar mantık 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ır
seed	OpenAI.integer		Hayır	42
sıcaklık	OpenAI.numeric		Hayır	1
text	OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText		Hayır
tools	OpenAI.Tool dizisi		Hayır
top_p	OpenAI.numeric		Hayır	1

OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText

Name	Türü	Description	Zorunlu	Varsayılan
format	OpenAI.TextResponseFormatConfiguration	Modelin çıkış yapması gereken biçimi belirten bir nesne. { "type": "json_schema" }'yi yapılandırmak, Yapılandırılmış Çıkışları etkinleştirir. modelin sağlanan JSON şemanızla eşleşmesini sağlar. Daha fazla bilgi için burayı ziyaret edin 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ır

OpenAI.CreateEvalStoredCompletionsDataSourceConfig

LogsDataSourceConfig lehine kullanım dışı ilan edildi.

Name	Türü	Description	Zorunlu	Varsayılan
metadata	Obje	Depolanan tamamlamalar veri kaynağı için meta veri filtreleri.	Hayır
type	enum	Veri kaynağının türü. Her zaman stored_completions. Olası değerler: stored_completions	Yes

OpenAI.CreateFineTuningJobRequest

Geçerli modeller:

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

Name	Türü	Description	Zorunlu	Varsayılan
hiper parametreler	OpenAI.CreateFineTuningJobRequestHyperparameters		Hayır
└─ yığın boyutu	dize veya OpenAI.integer		Hayır	otomatik
└─ öğrenme oranı çarpanı	dize veya OpenAI.numeric		Hayır
└─ n_epochs	dize veya OpenAI.integer		Hayır	otomatik
Entegrasyonlar	OpenAI.CreateFineTuningJobRequestIntegrations dizisi	İnce ayar işiniz için etkinleştirilecek entegrasyonların listesi.	Hayır
metadata	OpenAI.Metadata (null atanabilir)	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu olabilir 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ır
method	OpenAI.FineTuneMethod	İnce ayar için kullanılan yöntem.	Hayır
model	dize (aşağıdaki geçerli modellere bakın)	İnce ayar yapılacak modelin adı. Aşağıdakilerden birini seçebilirsiniz: desteklenen modeller.	Yes
seed	OpenAI.integer (null atanabilir)		Hayır
suffix	dize (null atanabilir)	İnce ayarlı model adınıza eklenecek en fazla 64 karakterlik bir dize. Örneğin, "özel model-adı" olan bir suffix, ft:gpt-4o-mini:openai:custom-model-name:7p4lURel gibi bir model adı üretir. Kısıtlamalar: minLength: 1, maxLength: 64	Hayır
eğitim_dosyası	Dize	Eğitim verilerini içeren karşıya yüklenen bir dosyanın kimliği. Dosya yükle için dosya yükleme konusunda bkz. Veri kümeniz JSONL dosyası olarak biçimlendirilmelidir. Ayrıca, dosyanızı fine-tune amacıyla 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 ayrıntı için ince ayar kılavuzuna bakın.	Yes
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 ince ayarlama sırasında metrikleri düzenli aralıklarla değerlendirin. Bu ölçümler, ... içinde görüntülenebilir. Ince ayar sonucu 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ı fine-tune amacıyla yüklemeniz gerekir. Daha fazla ayrıntı için ince ayar kılavuzuna bakın.	Hayır

OpenAI.CreateFineTuningJobRequestHyperparameters

Name	Türü	Description	Zorunlu	Varsayılan
küme_boyutu	dize veya OpenAI.integer		Hayır
öğrenme oranı çarpanı	dize veya OpenAI.numeric		Hayır
n_devir	dize veya OpenAI.integer		Hayır

OpenAI.CreateFineTuningJobRequestIntegrations

Name	Türü	Description	Zorunlu	Varsayılan
type	enum	Olası değerler: wandb	Yes
wandb	OpenAI.CreateFineTuningJobRequestIntegrationsWandb		Yes

OpenAI.CreateFineTuningJobRequestIntegrationsWandb

Name	Türü	Description	Zorunlu	Varsayılan
varlık	dize (null atanabilir)		Hayır
name	dize (null atanabilir)		Hayır
project	Dize		Yes
tags	dize dizisi		Hayır

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.

Name	Türü	Description	Zorunlu	Varsayılan
tanım	Dize	Dilbilgisi tanımı.	Yes
syntax	OpenAI.GrammarSyntax1		Yes
type	enum	Dilbilgisi formatı. Her zaman grammar. Olası değerler: grammar	Yes

OpenAI.CustomTextFormatParam

Sınırsız serbest biçimli metin.

Name	Türü	Description	Zorunlu	Varsayılan
type	enum	Sınırsız metin formatı. Her zaman text. Olası değerler: text	Yes

OpenAI.CustomToolParam

Belirli bir formatla girdiyi işleyen özel bir araç. özel araçlar

Name	Türü	Description	Zorunlu	Varsayılan
Açıklama	Dize	Daha fazla bağlam sağlamak için kullanılan özel aracın isteğe bağlı açıklaması.	Hayır
format	OpenAI.CustomToolParamFormat	Özel araç için giriş formatı. Varsayılan metin sınırsız olur.	Hayır
└─ türü	OpenAI.CustomToolParamFormatType		Yes
name	Dize	Özel aracın adı, aracı çağırmalarda tanımlamak için kullanılır.	Yes
type	enum	Özel aracın türü. Her zaman custom. Olası değerler: custom	Yes

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	Schema
text	OpenAI.CustomTextFormatParam
grammar	OpenAI.CustomGrammarFormatParam

Name	Türü	Description	Zorunlu	Varsayılan
type	OpenAI.CustomToolParamFormatType		Yes

OpenAI.CustomToolParamFormatType

Property	Değer
Türü	Dize
Değerler	text grammar

OpenAI.DeletedConversationResource

Name	Türü	Description	Zorunlu	Varsayılan
silindi	boolean		Yes
kimlik	Dize		Yes
Obje	enum	Olası değerler: conversation.deleted	Yes

OpenAI.DetailEnum

Property	Değer
Türü	Dize
Değerler	low high auto

OpenAI.DoubleClickAction

Çift tıklama eylemi.

Name	Türü	Description	Zorunlu	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	Yes
x	OpenAI.integer		Yes
y	OpenAI.integer		Yes

OpenAI.Drag

Sürükleme eylemi.

Name	Türü	Description	Zorunlu	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>	Yes
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	Yes

OpenAI.DragPoint

X/y koordinat çifti, örneğin. { x: 100, y: 200 }

Name	Türü	Description	Zorunlu	Varsayılan
x	OpenAI.integer		Yes
y	OpenAI.integer		Yes

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.

Name	Türü	Description	Zorunlu	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.	Yes
role	enum	İleti girişinin rolü. user, assistant, system'den biri developer. Olası değerler: user, assistant, system, developer	Yes
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ır
type	enum	İleti girişinin türü. Her zaman message. Olası değerler: message	Yes

OpenAI.Error

Name	Türü	Description	Zorunlu	Varsayılan
ek bilgi	Obje		Hayır
code	dize (null atanabilir)		Yes
debugInfo	Obje		Hayır
details	OpenAI.Error dizisi		Hayır
message	Dize		Yes
param	dize (null atanabilir)		Hayır
type	Dize		Hayır

OpenAI.EvalApiError

Değerlendirme API'sinden bir hata yanıtını temsil eden nesne.

Name	Türü	Description	Zorunlu	Varsayılan
code	Dize	Hata kodu.	Yes
message	Dize	Hata iletisi.	Yes

OpenAI.EvalGraderLabelModel

Name	Türü	Description	Zorunlu	Varsayılan
input	OpenAI.EvalItem dizisi		Yes
labels	dize dizisi	Değerlendirmedeki her öğeye atanacak etiketler.	Yes
model	Dize	Değerlendirme için kullanılacak model. Yapılandırılmış çıktıları destekleme zorunluluğu vardır.	Yes
name	Dize	Değerlendiricinin adı.	Yes
geçen etiketler	dize dizisi	Geçen sonucu belirten etiketler. Etiketlerin bir alt kümesi olmalıdır.	Yes
type	enum	Her zaman label_modelolan nesne türü. Olası değerler: label_model	Yes

OpenAI.EvalGraderPython

Name	Türü	Description	Zorunlu	Varsayılan
image_tag	Dize	Python betiği için kullanılacak görüntü etiketi.	Hayır
name	Dize	Değerlendiricinin adı.	Yes
eşik_geçiş	OpenAI.numeric		Hayır
kaynak	Dize	Python betiğinin kaynak kodu.	Yes
type	enum	Her zaman pythonolan nesne türü. Olası değerler: python	Yes

OpenAI.EvalGraderScoreModel

Name	Türü	Description	Zorunlu	Varsayılan
input	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.	Yes
model	Dize	Değerlendirme için kullanılacak model.	Yes
name	Dize	Değerlendiricinin adı.	Yes
eşik_geçiş	OpenAI.numeric		Hayır
menzil	OpenAI.numeric dizisi	Puan aralığı. Varsayılan değer [0, 1]’dır.	Hayır
Örnekleme_Parametreleri	OpenAI.EvalGraderScoreModelSamplingParams		Hayır
└─ max_completions_tokens	OpenAI.integer (null atanabilir)		Hayır
└─ akıl yürütme çabası	OpenAI.ReasoningEffort	Akıl yürütmeye yönelik çabayı kısıtlar mantık 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ır
└─ tohum	OpenAI.integer (null atanabilir)		Hayır
└─ sıcaklık	OpenAI.numeric (null atanabilir)		Hayır
└─ top_p	OpenAI.numeric (null atanabilir)		Hayır	1
type	enum	Her zaman score_modelolan nesne türü. Olası değerler: score_model	Yes

OpenAI.EvalGraderScoreModelSamplingParams

Name	Türü	Description	Zorunlu	Varsayılan
max_completions_tokens	OpenAI.integer (null atanabilir)		Hayır
akıl yürütme çabası	OpenAI.ReasoningEffort	Akıl yürütmeye yönelik çabayı kısıtlar mantık 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ır
seed	OpenAI.integer (null atanabilir)		Hayır
sıcaklık	OpenAI.numeric (null atanabilir)		Hayır
top_p	OpenAI.numeric (null atanabilir)		Hayır	1

OpenAI.EvalGraderStringCheck

Name	Türü	Description	Zorunlu	Varsayılan
input	Dize	Giriş metni. Bu, şablon dizelerini içerebilir.	Yes
name	Dize	Değerlendiricinin adı.	Yes
Operasyon	enum	Gerçekleştirilecek dize denetimi işlemi. Biri eq, ne, like veya ilike. Olası değerler: eq, ne, like, ilike	Yes
referans	Dize	Başvuru metni. Bu, şablon dizelerini içerebilir.	Yes
type	enum	Her zaman string_checkolan nesne türü. Olası değerler: string_check	Yes

OpenAI.EvalGraderTextSimilarity

Name	Türü	Description	Zorunlu	Varsayılan
değerlendirme ölçütü	enum	Kullanılacak değerlendirme ölçümü. cosine'den biri, 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	Yes
input	Dize	Notlanan metin.	Yes
name	Dize	Değerlendiricinin adı.	Yes
eşik_geçiş	OpenAI.numeric		Yes
referans	Dize	Değerlendirmenin yapıldığı metin.	Yes
type	enum	Not verenin türü. Olası değerler: text_similarity	Yes

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.

Name	Türü	Description	Zorunlu	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.	Yes
role	enum	İleti girişinin rolü. user, assistant, system'den biri developer. Olası değerler: user, assistant, system, developer	Yes
type	enum	İleti girişinin türü. Her zaman message. Olası değerler: message	Hayır

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	Schema
output_text	OpenAI.EvalItemContentOutputText
input_image	OpenAI.EvalItemInputImage
input_audio	OpenAI.InputAudio
input_text	OpenAI.EvalItemContentItemObjectInputTextContent

Name	Türü	Description	Zorunlu	Varsayılan
type	OpenAI.EvalItemContentItemObjectType		Yes

OpenAI.EvalItemContentItemObjectInputTextContent

Modele metin girişi.

Name	Türü	Description	Zorunlu	Varsayılan
text	Dize	Modele metin girişi.	Yes
type	enum	Giriş öğesinin türü. Her zaman input_text. Olası değerler: input_text	Yes

OpenAI.EvalItemContentItemObjectType

Property	Değer
Türü	Dize
Değerler	input_text output_text input_image input_audio

OpenAI.EvalItemContentOutputText

Modelden bir metin çıktısı.

Name	Türü	Description	Zorunlu	Varsayılan
text	Dize	Modelden metin çıkışı.	Yes
type	enum	Çıkış metninin türü. Her zaman output_text. Olası değerler: output_text	Yes

OpenAI.EvalItemContentText

Modele metin girişi.

Tür: dize

OpenAI.EvalItemInputImage

EvalItem içerik dizilerinde kullanılan bir görüntü giriş bloğu.

Name	Türü	Description	Zorunlu	Varsayılan
detail	Dize	Modele gönderilecek görüntünün ayrıntı düzeyi. high, lowveya auto. Varsayılan değer auto’dır.	Hayır
image_url	Dize	Görüntü girişinin URL'si.	Yes
type	enum	Görüntü girişinin türü. Her zaman input_image. Olası değerler: input_image	Yes

OpenAI.EvalJsonlFileContentSource

Name	Türü	Description	Zorunlu	Varsayılan
içerik	OpenAI.EvalJsonlFileContentSourceContent dizisi	jsonl dosyasının içeriği.	Yes
type	enum	Jsonl kaynağının türü. Her zaman file_content. Olası değerler: file_content	Yes

OpenAI.EvalJsonlFileContentSourceContent

Name	Türü	Description	Zorunlu	Varsayılan
öğe	Obje		Yes
örnek	Obje		Hayır

OpenAI.EvalJsonlFileIdSource

Name	Türü	Description	Zorunlu	Varsayılan
kimlik	Dize	Dosyanın tanımlayıcısı.	Yes
type	enum	Jsonl kaynağının türü. Her zaman file_id. Olası değerler: file_id	Yes

OpenAI.EvalResponsesSource

Çalıştırma veri kaynağı yapılandırmasını açıklayan bir EvalResponsesSource nesnesi.

Name	Türü	Description	Zorunlu	Varsayılan
oluşturulma_tarihi_sonrası	OpenAI.integer (null atanabilir)		Hayır
önceden oluşturulmuş	OpenAI.integer (null atanabilir)		Hayır
talimatlar_arama	dize (null atanabilir)		Hayır
metadata	object (null atanabilir)		Hayır
model	dize (null atanabilir)		Hayır
akıl yürütme çabası	OpenAI.ReasoningEffort (null atanabilir)	Akıl yürütmeye yönelik çabayı kısıtlar mantık 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ır
sıcaklık	OpenAI.numeric (null atanabilir)		Hayır
tools	dize dizisi		Hayır
top_p	OpenAI.numeric (null atanabilir)		Hayır
type	enum	Çalıştırma veri kaynağının türü. Her zaman responses. Olası değerler: responses	Yes
users	dize dizisi		Hayır

OpenAI.EvalRunOutputItemSample

Name	Türü	Description	Zorunlu	Varsayılan
hata	OpenAI.EvalApiError	Değerlendirme API'sinden bir hata yanıtını temsil eden nesne.	Yes
bitiş_nedeni	Dize		Yes
input	EvalRunOutputItemSampleInput dizisi		Yes
max_completion_tokens	OpenAI.integer		Yes
model	Dize		Yes
output	EvalRunOutputItemSampleOutput dizisi		Yes
seed	OpenAI.integer		Yes
sıcaklık	OpenAI.numeric		Yes
top_p	OpenAI.numeric		Yes
usage	OpenAI.EvalRunOutputItemSampleUsage		Yes

OpenAI.EvalRunOutputItemSampleUsage

Name	Türü	Description	Zorunlu	Varsayılan
cached_tokens	OpenAI.integer		Yes
completion_tokens	OpenAI.integer		Yes
prompt_tokens	OpenAI.integer		Yes
total_tokens	OpenAI.integer		Yes

OpenAI.EvalRunPerModelUsage

Name	Türü	Description	Zorunlu	Varsayılan
cached_tokens	OpenAI.integer		Yes
completion_tokens	OpenAI.integer		Yes
invocation_count	OpenAI.integer		Yes
model_name	Dize		Yes
prompt_tokens	OpenAI.integer		Yes
total_tokens	OpenAI.integer		Yes

OpenAI.EvalRunPerTestingCriteriaResults

Name	Türü	Description	Zorunlu	Varsayılan
başarısız	OpenAI.integer		Yes
Geçirilen	OpenAI.integer		Yes
test kriterleri	Dize		Yes

OpenAI.EvalRunResultCounts

Name	Türü	Description	Zorunlu	Varsayılan
hata oluştu	OpenAI.integer		Yes
başarısız	OpenAI.integer		Yes
Geçirilen	OpenAI.integer		Yes
toplam	OpenAI.integer		Yes

OpenAI.EvalStoredCompletionsSource

Bir filtre kümesini açıklayan StoredCompletionsRunDataSource yapılandırması

Name	Türü	Description	Zorunlu	Varsayılan
oluşturulma_tarihi_sonrası	OpenAI.integer (null atanabilir)		Hayır
önceden oluşturulmuş	OpenAI.integer (null atanabilir)		Hayır
limit	OpenAI.integer (null atanabilir)		Hayır
metadata	OpenAI.Metadata (null atanabilir)	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu olabilir 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ır
model	dize (null atanabilir)		Hayır
type	enum	Kaynak türü. Her zaman stored_completions. Olası değerler: stored_completions	Yes

OpenAI.FileCitationBody

Bir dosyaya referans.

Name	Türü	Description	Zorunlu	Varsayılan
dosya_kimlik	Dize	Dosyanın kimliği.	Yes
filename	Dize	Belirtilen dosyanın dosya adı.	Yes
indeks	OpenAI.integer		Yes
type	enum	Dosya alıntısının türü. Her zaman file_citation. Olası değerler: file_citation	Yes

OpenAI.FilePath

Bir dosyaya giden yol.

Name	Türü	Description	Zorunlu	Varsayılan
dosya_kimlik	Dize	Dosyanın kimliği.	Yes
indeks	OpenAI.integer		Yes
type	enum	Dosya yolunun türü. Her zaman file_path. Olası değerler: file_path	Yes

OpenAI.FileSearchTool

Yüklenen dosyalardan ilgili içeriği arayan bir araç.

Name	Türü	Description	Zorunlu	Varsayılan
filters	OpenAI.Filters (null atanabilir)		Hayır
maks_sonuç_sayısı	OpenAI.integer		Hayır
Sıralama_seçenekleri	OpenAI.RankingOptions		Hayır
└─ 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ır
└─ sıralama yapıcı	OpenAI.RankerVersionType	Dosya araması için kullanılacak dereceleyici.	Hayır
└─ 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ır
type	enum	Dosya arama aracının türü. Her zaman file_search. Olası değerler: file_search	Yes
vector_store_ids	dize dizisi	Aranacak vektör depolarının kimlikleri.	Yes

OpenAI.FileSearchToolCallResults

Name	Türü	Description	Zorunlu	Varsayılan
attributes	OpenAI.VectorStoreFileAttributes (null atanabilir)	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu olabilir 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 fazla karakter sayısına sahip dizelerdir. 512 karakter uzunluğu, booleanlar veya sayılar.	Hayır
dosya_kimlik	Dize		Hayır
filename	Dize		Hayır
Skor	number		Hayır
text	Dize		Hayır

OpenAI.Filters

Tür: OpenAI.ComparisonFilter veya OpenAI.CompoundFilter

OpenAI.FineTuneDPOHyperparameters

DPO ince ayar işi için kullanılan hiperparametreler.

Name	Türü	Description	Zorunlu	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ır
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ır
öğ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ır
n_devir	dize veya OpenAI.integer	Modeli eğitmek için gereken epok sayısı. Dönem, eğitim veri kümesindeki bir tam döngüyü ifade eder.	Hayır

OpenAI.FineTuneDPOMethod

DPO ince ayarlama yöntemi için konfigürasyon.

Name	Türü	Description	Zorunlu	Varsayılan
hiper parametreler	OpenAI.FineTuneDPOHyperparameters	DPO ince ayar işi için kullanılan hiperparametreler.	Hayır

OpenAI.FineTuneMethod

İnce ayar için kullanılan yöntem.

Name	Türü	Description	Zorunlu	Varsayılan
dpo	OpenAI.FineTuneDPOMethod	DPO ince ayarlama yöntemi için konfigürasyon.	Hayır
Takviye	OpenAI.FineTuneReinforcementMethod	Pekiştirici ince ayar yöntemi için yapılandırma.	Hayır
Denetimli	OpenAI.FineTuneSupervisedMethod	Denetimli ince ayar yöntemi için yapılandırma.	Hayır
type	enum	Yöntemin türü. supervised, dpoveya reinforcementşeklindedir. Olası değerler: supervised, dpo, reinforcement	Yes

OpenAI.FineTuneReinforcementHyperparameters

Pekiştirici ince ayarlama işi için kullanılan hiper parametreler.

Name	Türü	Description	Zorunlu	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ır
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ır
değerlendirme_aralığı	dize veya OpenAI.integer	Değerlendirme çalışmaları arasındaki eğitim adımı sayısı.	Hayır
değerlendirme_örnekleri	dize veya OpenAI.integer	Eğitim adımı başına oluşturulacak değerlendirme örneklerinin sayısı.	Hayır
öğ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ır
n_devir	dize veya OpenAI.integer	Modeli eğitmek için gereken epok sayısı. Dönem, eğitim veri kümesindeki bir tam döngüyü ifade eder.	Hayır
akıl yürütme çabası	enum	Akıl yürütme çabası düzeyi. Olası değerler: default, low, medium, high	Hayır

OpenAI.FineTuneReinforcementMethod

Pekiştirici ince ayar yöntemi için yapılandırma.

Name	Türü	Description	Zorunlu	Varsayılan
Yol tesviye makinesi	OpenAI.GraderStringCheck veya OpenAI.GraderTextSimilarity veya OpenAI.GraderPython veya OpenAI.GraderScoreModel veya OpenAI.GraderMulti	İnce ayar işi için kullanılan not veren.	Yes
hiper parametreler	OpenAI.FineTuneReinforcementHyperparameters	Pekiştirici ince ayarlama işi için kullanılan hiper parametreler.	Hayır

OpenAI.FineTuneSupervisedHyperparameters

İnce ayar işi için kullanılan hiper parametreler.

Name	Türü	Description	Zorunlu	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ır
öğ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ır
n_devir	dize veya OpenAI.integer	Modeli eğitmek için gereken epok sayısı. Dönem, eğitim veri kümesindeki bir tam döngüyü ifade eder.	Hayır

OpenAI.FineTuneSupervisedMethod

Denetimli ince ayar yöntemi için yapılandırma.

Name	Türü	Description	Zorunlu	Varsayılan
hiper parametreler	OpenAI.FineTuneSupervisedHyperparameters	İnce ayar işi için kullanılan hiper parametreler.	Hayır

OpenAI.FineTuningIntegration (OpenAI İnce Ayar Entegrasyonu)

Name	Türü	Description	Zorunlu	Varsayılan
type	enum	İnce ayar işi için etkinleştirilen entegrasyon türü Olası değerler: wandb	Yes
wandb	OpenAI.FineTuningIntegrationWandb		Yes
└─ varlık	dize (null atanabilir)		Hayır
└─ ad	dize (null atanabilir)		Hayır
└─ proje	Dize		Yes
└─ etiketleri	dize dizisi		Hayır

OpenAI.FineTuningIntegrationWandb

Name	Türü	Description	Zorunlu	Varsayılan
varlık	dize (null atanabilir)		Hayır
name	dize (null atanabilir)		Hayır
project	Dize		Yes
tags	dize dizisi		Hayır

OpenAI.FineTuningJob

nesnesi, fine_tuning.job API aracılığıyla oluşturulmuş bir ince ayar işini temsil eder.

Name	Türü	Description	Zorunlu	Varsayılan
oluşturulma_tarihi	integer	Unix zaman damgası (saniye olarak), hassas ayarlama işinin oluşturulduğu zamanı belirtir.	Yes
hata	OpenAI.FineTuningJobError (null atanabilir)		Yes
└─ kod	Dize		Yes
└─ ileti	Dize		Yes
└─ parametre	dize (null atanabilir)		Yes
tahmini_bitiş	integer		Hayır
fine_tuned_model	dize (null atanabilir)		Yes
tamamlandı	integer		Yes
hiper parametreler	OpenAI.FineTuningJobHyperparameters		Yes
└─ yığın boyutu	dize veya OpenAI.integer		Hayır	otomatik
└─ öğrenme oranı çarpanı	dize veya OpenAI.numeric		Hayır
└─ n_epochs	dize veya OpenAI.integer		Hayır	otomatik
kimlik	Dize	API uç noktalarına başvurulabilen nesne tanımlayıcısı.	Yes
Entegrasyonlar	OpenAI.FineTuningIntegration dizisi		Hayır
metadata	OpenAI.Metadata (null atanabilir)	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu olabilir 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ır
method	OpenAI.FineTuneMethod	İnce ayar için kullanılan yöntem.	Hayır
model	Dize	İnce ayar yapılan temel model.	Yes
Obje	enum	Her zaman "fine_tuning.job" olan nesne türü. Olası değerler: fine_tuning.job	Yes
organizasyon_id	Dize	İnce ayar işinin sahibi olan kuruluş.	Yes
sonuç_dosyaları	dize dizisi	İnce ayar işi için derlenmiş sonuç dosyası kimliği/belgeleri. Sonuçları Dosyalar API'siyle alabilirsiniz.	Yes
seed	OpenAI.integer		Yes
durum	enum	İnce ayarlama işinin mevcut durumu, validating_files, queued, running, succeeded, failed veya cancelled olabilir. Olası değerler: validating_files, queued, running, succeeded, , failed, cancelled	Yes
eğitilmiş_jetonlar	OpenAI.integer (null atanabilir)		Yes
eğitim_dosyası	Dize	Eğitim için kullanılan dosya kimliği. Eğitim verilerini Dosyalar API'siyle alabilirsiniz.	Yes
doğrulama_dosyası	dize (null atanabilir)		Yes

OpenAI.FineTuningJobCheckpoint

fine_tuning.job.checkpoint nesnesi, kullanıma hazır bir ince ayar işi için model denetim noktasını temsil eder.

Name	Türü	Description	Zorunlu	Varsayılan
oluşturulma_tarihi	integer	Denetim noktasının oluşturulduğu zaman için Unix zaman damgası (saniye olarak).	Yes
ince_ayarlı_model_kontrol_noktası	Dize	Oluşturulan ince ayarlı denetim noktası modelinin adı.	Yes
ince_ayarlama_iş_id	Dize	Bu denetim noktasının oluşturulduğu ince ayar işinin adı.	Yes
kimlik	Dize	API uç noktalarında başvurulabilen denetim noktası tanımlayıcısı.	Yes
metrics	OpenAI.FineTuningJobCheckpointMetrics		Yes
tam doğrulama kaybı (full_valid_loss)	OpenAI.numeric		Hayır
└─ tam_geçerli_ortalama_token_doğruluğu	OpenAI.numeric		Hayır
└─ adım	OpenAI.numeric		Hayır
└─ eğitim kaybı	OpenAI.numeric		Hayır
└─ eğitim_ortalama_token_dogrulugu	OpenAI.numeric		Hayır
└─ doğrulama_kaybı	OpenAI.numeric		Hayır
└─ geçerli_ortalama_öğe_doğruluğu	OpenAI.numeric		Hayır
Obje	enum	Her zaman "fine_tuning.job.checkpoint" olan nesne türü. Olası değerler: fine_tuning.job.checkpoint	Yes
adım_numarası	OpenAI.integer		Yes

OpenAI.FineTuningJobCheckpointMetrics

Name	Türü	Description	Zorunlu	Varsayılan
full_valid_loss	OpenAI.numeric		Hayır
full_valid_mean_token_accuracy	OpenAI.numeric		Hayır
adım	OpenAI.numeric		Hayır
train_loss	OpenAI.numeric		Hayır
train_mean_token_accuracy	OpenAI.numeric		Hayır
valid_loss	OpenAI.numeric		Hayır
valid_mean_token_accuracy	OpenAI.numeric		Hayır

OpenAI.FineTuningJobError

Name	Türü	Description	Zorunlu	Varsayılan
code	Dize		Yes
message	Dize		Yes
param	dize (null atanabilir)		Yes

OpenAI.FineTuningJobEvent

Görev olayı nesnesine ince ayar yapma

Name	Türü	Description	Zorunlu	Varsayılan
oluşturulma_tarihi	integer	Unix zaman damgası (saniye olarak), hassas ayarlama işinin oluşturulduğu zamanı belirtir.	Yes
data	OpenAI.FineTuningJobEventData		Hayır
kimlik	Dize	Nesne tanımlayıcısı.	Yes
level	enum	Olayın kayıt düzeyi. Olası değerler: info, warn, error	Yes
message	Dize	Etkinliğin mesajı.	Yes
Obje	enum	Nesne türü, her zaman "fine_tuning.job.event" şeklindedir. Olası değerler: fine_tuning.job.event	Yes
type	enum	Olayın türü. Olası değerler: message, metrics	Hayır

OpenAI.FineTuningJobEventData

Tür: nesne

OpenAI.FineTuningJobHyperparameters

Name	Türü	Description	Zorunlu	Varsayılan
küme_boyutu	dize veya OpenAI.integer		Hayır
öğrenme oranı çarpanı	dize veya OpenAI.numeric		Hayır
n_devir	dize veya OpenAI.integer		Hayır

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	Schema
input_text	OpenAI.FunctionAndCustomToolCallOutputInputTextContent
input_image	OpenAI.FunctionAndCustomToolCallOutputInputImageContent
input_file	OpenAI.FunctionAndCustomToolCallOutputInputFileContent

Name	Türü	Description	Zorunlu	Varsayılan
type	OpenAI.FunctionAndCustomToolCallOutputType		Yes

OpenAI.FunctionAndCustomToolCallOutputInputFileContent

Modele bir dosya girişi.

Name	Türü	Description	Zorunlu	Varsayılan
file_data	Dize	Modele gönderilecek dosyanın içeriği.	Hayır
dosya_kimlik	dize (null atanabilir)		Hayır
file_url	Dize	Modele gönderilecek dosyanın URL'si.	Hayır
filename	Dize	Modele gönderilecek dosyanın adı.	Hayır
type	enum	Giriş öğesinin türü. Her zaman input_file. Olası değerler: input_file	Yes

OpenAI.FunctionAndCustomToolCallOutputInputImageContent

Modele bir görüntü girişi. image girişleri hakkında bilgi edinin.

Name	Türü	Description	Zorunlu	Varsayılan
detail	OpenAI.ImageDetail		Yes
dosya_kimlik	dize (null atanabilir)		Hayır
image_url	Dize		Hayır
type	enum	Giriş öğesinin türü. Her zaman input_image. Olası değerler: input_image	Yes

OpenAI.FunctionAndCustomToolCallOutputInputTextContent

Modele metin girişi.

Name	Türü	Description	Zorunlu	Varsayılan
text	Dize	Modele metin girişi.	Yes
type	enum	Giriş öğesinin türü. Her zaman input_text. Olası değerler: input_text	Yes

OpenAI.FunctionAndCustomToolCallOutputType

Property	Değer
Türü	Dize
Değerler	input_text input_image input_file

OpenAI.FunctionCallItemStatus

Property	Değer
Türü	Dize
Değerler	in_progress completed incomplete

OpenAI.FunctionObject

Name	Türü	Description	Zorunlu	Varsayılan
Açıklama	Dize	İş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ır
name	Dize	Çağrılacak işlevin adı. En fazla 64 karakter uzunluğunda olmalı; a-z, A-Z, 0-9 içerebilir ya da alt çizgi ve kısa çizgilerle yazılabilir.	Yes
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. parameters'yi dışarıda bırakmak, boş parametre listesi olan bir işlevi tanımlar.	Hayır
Kesin	boole değeri (null atanabilir)		Hayır

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. parameters'yi dışarıda bırakmak, boş parametre listesi olan bir işlevi tanımlar.

Tür: nesne

OpenAI.FunctionShellAction

Bir kabuk komutu yürütür.

Name	Türü	Description	Zorunlu	Varsayılan
commands	dize dizisi		Yes
max_output_length	OpenAI.integer (null atanabilir)		Yes
zaman_aşımı_ms	OpenAI.integer (null atanabilir)		Yes

OpenAI.FunctionShellActionParam

Kabuk aracı çağrısını çalıştırmayı açıklayan komutlar ve sınırlar.

Name	Türü	Description	Zorunlu	Varsayılan
commands	dize dizisi	Yürütme ortamının çalışması için sıralı kabuk komutları.	Yes
max_output_length	OpenAI.integer (null atanabilir)		Hayır
zaman_aşımı_ms	OpenAI.integer (null atanabilir)		Hayır

OpenAI.FunctionShellCallItemStatus

Kabuk aracı çağrıları için bildirilen durum değerleri.

Property	Değer
Türü	Dize
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.

Name	Türü	Description	Zorunlu	Varsayılan
Oluşturan	Dize	Öğeyi oluşturan aktörün tanımlayıcısı.	Hayır
sonuç	OpenAI.FunctionShellCallOutputOutcome	Bir çıkış sonucunu (çıkış koduyla) veya kabuk çağrısı çıkış öbekleri için zaman aşımı sonucunu temsil eder.	Yes
└─ türü	OpenAI.FunctionShellCallOutputOutcomeType		Yes
Stderr	Dize	Yakalanan standart hata çıkışı.	Yes
stdout	Dize	Yakalanan standart çıkış.	Yes

OpenAI.FunctionShellCallOutputContentParam

Kabuk aracı çağrı çıkışının bir bölümü için yakalanan stdout ve stderr.

Name	Türü	Description	Zorunlu	Varsayılan
sonuç	OpenAI.FunctionShellCallOutputOutcomeParam	Bu kabuk çağrısıyla ilişkili çıkış veya zaman aşımı sonucu.	Yes
└─ türü	OpenAI.FunctionShellCallOutputOutcomeParamType		Yes
Stderr	Dize	Kabuk çağrısı için yakalanan stderr çıkışı. Kısıtlamalar: maxLength: 10485760	Yes
stdout	Dize	Kabuk çağrısı için yakalanan stdout çıkışı. Kısıtlamalar: maxLength: 10485760	Yes

OpenAI.FunctionShellCallOutputExitOutcome

Shell komutlarının tamamlandığını ve çıkış kodunu döndürdüğünü gösterir.

Name	Türü	Description	Zorunlu	Varsayılan
exit_code	OpenAI.integer		Yes
type	enum	Sonuç türü. Her zaman exit. Olası değerler: exit	Yes

OpenAI.FunctionShellCallOutputExitOutcomeParam

Shell komutlarının tamamlandığını ve çıkış kodunu döndürdüğünü gösterir.

Name	Türü	Description	Zorunlu	Varsayılan
exit_code	OpenAI.integer		Yes
type	enum	Sonuç türü. Her zaman exit. Olası değerler: exit	Yes

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	Schema
timeout	OpenAI.FunctionShellCallOutputTimeoutOutcome
exit	OpenAI.FunctionShellCallOutputExitOutcome

Name	Türü	Description	Zorunlu	Varsayılan
type	OpenAI.FunctionShellCallOutputOutcomeType		Yes

OpenAI.FunctionShellCallOutputOutcomeParam

Bu kabuk ç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	Schema
timeout	OpenAI.FunctionShellCallOutputTimeoutOutcomeParam
exit	OpenAI.FunctionShellCallOutputExitOutcomeParam

Name	Türü	Description	Zorunlu	Varsayılan
type	OpenAI.FunctionShellCallOutputOutcomeParamType		Yes

OpenAI.FunctionShellCallOutputOutcomeParamType

Property	Değer
Türü	Dize
Değerler	timeout exit

OpenAI.FunctionShellCallOutputOutcomeType

Property	Değer
Türü	Dize
Değerler	timeout exit

OpenAI.FunctionShellCallOutputTimeoutOutcome

Shell çağrısının ayarlanmış zaman sınırını aştığını gösterir.

Name	Türü	Description	Zorunlu	Varsayılan
type	enum	Sonuç türü. Her zaman timeout. Olası değerler: timeout	Yes

OpenAI.FunctionShellCallOutputTimeoutOutcomeParam

Shell çağrısının ayarlanmış zaman sınırını aştığını gösterir.

Name	Türü	Description	Zorunlu	Varsayılan
type	enum	Sonuç türü. Her zaman timeout. Olası değerler: timeout	Yes

OpenAI.FunctionShellToolParam

Modelin shell komutlarını çalıştırmasına olanak tanıyan bir araç.

Name	Türü	Description	Zorunlu	Varsayılan
type	enum	Kabuk aracının türü. Her zaman shell. Olası değerler: shell	Yes

OpenAI.FunctionTool

Modelin çağırmayı seçebileceği kendi kodunuzda bir işlev tanımlar.

Name	Türü	Description	Zorunlu	Varsayılan
Açıklama	dize (null atanabilir)		Hayır
name	Dize	Çağrılacak işlevin adı.	Yes
parameters	object (null atanabilir)		Yes
Kesin	boole değeri (null atanabilir)		Yes
type	enum	İşlev aracının türü. Her zaman function. Olası değerler: function	Yes

OpenAI.GraderLabelModel

Değerlendirmedeki her öğeye etiket atamak için model kullanan bir LabelModelGrader nesnesi.

Name	Türü	Description	Zorunlu	Varsayılan
input	OpenAI.EvalItem dizisi		Yes
labels	dize dizisi	Değerlendirmedeki her öğeye atanacak etiketler.	Yes
model	Dize	Değerlendirme için kullanılacak model. Yapılandırılmış çıktıları destekleme zorunluluğu vardır.	Yes
name	Dize	Değerlendiricinin adı.	Yes
geçen etiketler	dize dizisi	Geçen sonucu belirten etiketler. Etiketlerin bir alt kümesi olmalıdır.	Yes
type	enum	Her zaman label_modelolan nesne türü. Olası değerler: label_model	Yes

OpenAI.GraderMulti

MultiGrader nesnesi, tek bir puan oluşturmak için birden çok not verenin çıkışını birleştirir.

Name	Türü	Description	Zorunlu	Varsayılan
çıktıyı_hesapla	Dize	Derecelendirici sonuçlarına göre çıkışı hesaplamak için bir formül.	Yes
Öğrenciler	OpenAI.GraderStringCheck veya OpenAI.GraderTextSimilarity veya OpenAI.GraderPython veya OpenAI.GraderScoreModel veya OpenAI.GraderLabelModel		Yes
name	Dize	Değerlendiricinin adı.	Yes
type	enum	Her zaman multiolan nesne türü. Olası değerler: multi	Yes

OpenAI.GraderPython

Girişte python betiği çalıştıran bir PythonGrader nesnesi.

Name	Türü	Description	Zorunlu	Varsayılan
image_tag	Dize	Python betiği için kullanılacak görüntü etiketi.	Hayır
name	Dize	Değerlendiricinin adı.	Yes
kaynak	Dize	Python betiğinin kaynak kodu.	Yes
type	enum	Her zaman pythonolan nesne türü. Olası değerler: python	Yes

OpenAI.GraderScoreModel

Girişe puan atamak için model kullanan scoreModelGrader nesnesi.

Name	Türü	Description	Zorunlu	Varsayılan
input	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.	Yes
model	Dize	Değerlendirme için kullanılacak model.	Yes
name	Dize	Değerlendiricinin adı.	Yes
menzil	OpenAI.numeric dizisi	Puan aralığı. Varsayılan değer [0, 1]’dır.	Hayır
Örnekleme_Parametreleri	OpenAI.EvalGraderScoreModelSamplingParams		Hayır
└─ max_completions_tokens	OpenAI.integer (null atanabilir)		Hayır
└─ akıl yürütme çabası	OpenAI.ReasoningEffort	Akıl yürütmeye yönelik çabayı kısıtlar mantık 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ır
└─ tohum	OpenAI.integer (null atanabilir)		Hayır
└─ sıcaklık	OpenAI.numeric (null atanabilir)		Hayır
└─ top_p	OpenAI.numeric (null atanabilir)		Hayır	1
type	enum	Her zaman score_modelolan nesne türü. Olası değerler: score_model	Yes

OpenAI.GraderStringCheck

Belirtilen işlemi kullanarak giriş ve başvuru arasında dize karşılaştırması gerçekleştiren bir StringCheckGrader nesnesi.

Name	Türü	Description	Zorunlu	Varsayılan
input	Dize	Giriş metni. Bu, şablon dizelerini içerebilir.	Yes
name	Dize	Değerlendiricinin adı.	Yes
Operasyon	enum	Gerçekleştirilecek dize denetimi işlemi. Biri eq, ne, like veya ilike. Olası değerler: eq, ne, like, ilike	Yes
referans	Dize	Başvuru metni. Bu, şablon dizelerini içerebilir.	Yes
type	enum	Her zaman string_checkolan nesne türü. Olası değerler: string_check	Yes

OpenAI.GraderTextSimilarity

Metinleri benzerlik ölçümlerine göre notlayan textSimilarityGrader nesnesi.

Name	Türü	Description	Zorunlu	Varsayılan
değerlendirme ölçütü	enum	Kullanılacak değerlendirme ölçümü. cosine'den biri, 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	Yes
input	Dize	Notlanan metin.	Yes
name	Dize	Değerlendiricinin adı.	Yes
referans	Dize	Değerlendirmenin yapıldığı metin.	Yes
type	enum	Not verenin türü. Olası değerler: text_similarity	Yes

OpenAI.GrammarSyntax1

Property	Değer
Türü	Dize
Değerler	lark regex

OpenAI.HybridSearchOptions

Name	Türü	Description	Zorunlu	Varsayılan
embedding_weight	OpenAI.numeric		Yes
text_weight	OpenAI.numeric		Yes

OpenAI.ImageDetail

Property	Değer
Türü	Dize
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

Name	Türü	Description	Zorunlu	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ır
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 değer low’dır.	Hayır
girdi_görüntü_maskesi	OpenAI.ImageGenToolInputImageMask		Hayır
└─ dosya_kimliği	Dize		Hayır
└─ image_url (görsel URL'si)	Dize		Hayır
model	dize (aşağıdaki geçerli modellere bakın)		Hayır
moderation	enum	Oluşturulan görüntü için denetim düzeyi. Varsayılan: auto. Olası değerler: auto, low	Hayır
çıktı sıkıştırma	OpenAI.integer		Hayır	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ır
kısmi_görüntüler	OpenAI.integer		Hayır
nitelik	enum	Oluşturulan görüntünün kalitesi. low'den biri, medium, high, veya auto. Varsayılan: auto. Olası değerler: low, medium, high, auto	Hayır
size	enum	Oluşturulan görüntünün boyutu. 1024x1024'lerden biri, 1024x1536 1536x1024veya auto. Varsayılan: auto. Olası değerler: 1024x1024, 1024x1536, 1536x1024, auto	Hayır
type	enum	Görüntü oluşturma aracının türü. Her zaman image_generation. Olası değerler: image_generation	Yes

OpenAI.ImageGenToolInputImageMask

Name	Türü	Description	Zorunlu	Varsayılan
dosya_kimlik	Dize		Hayır
image_url	Dize		Hayır

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ı mesajlara 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.

Property	Değer
Tanım	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ı mesajlara 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.

Name	Türü	Description	Zorunlu	Varsayılan
input_audio	OpenAI.InputAudioInputAudio		Yes
type	enum	Giriş öğesinin türü. Her zaman input_audio. Olası değerler: input_audio	Yes

OpenAI.InputAudioInputAudio

Name	Türü	Description	Zorunlu	Varsayılan
data	Dize		Yes
format	enum	Olası değerler: mp3, wav	Yes

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	Schema
input_text	OpenAI.InputContentInputTextContent
input_image	OpenAI.InputContentInputImageContent
input_file	OpenAI.InputContentInputFileContent

Name	Türü	Description	Zorunlu	Varsayılan
type	OpenAI.InputContentType		Yes

OpenAI.InputContentInputFileContent

Modele bir dosya girişi.

Name	Türü	Description	Zorunlu	Varsayılan
file_data	Dize	Modele gönderilecek dosyanın içeriği.	Hayır
dosya_kimlik	dize (null atanabilir)		Hayır
file_url	Dize	Modele gönderilecek dosyanın URL'si.	Hayır
filename	Dize	Modele gönderilecek dosyanın adı.	Hayır
type	enum	Giriş öğesinin türü. Her zaman input_file. Olası değerler: input_file	Yes

OpenAI.InputContentInputImageContent

Modele bir görüntü girişi. image girişleri hakkında bilgi edinin.

Name	Türü	Description	Zorunlu	Varsayılan
detail	OpenAI.ImageDetail		Yes
dosya_kimlik	dize (null atanabilir)		Hayır
image_url	Dize		Hayır
type	enum	Giriş öğesinin türü. Her zaman input_image. Olası değerler: input_image	Yes

OpenAI.InputContentInputTextContent

Modele metin girişi.

Name	Türü	Description	Zorunlu	Varsayılan
text	Dize	Modele metin girişi.	Yes
type	enum	Giriş öğesinin türü. Her zaman input_text. Olası değerler: input_text	Yes

OpenAI.InputContentType

Property	Değer
Türü	Dize
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 değer low’dır.

Property	Değer
Türü	Dize
Değerler	high low

OpenAI.InputFileContent

Modele bir dosya girişi.

Name	Türü	Description	Zorunlu	Varsayılan
file_data	Dize	Modele gönderilecek dosyanın içeriği.	Hayır
dosya_kimlik	dize (null atanabilir)		Hayır
file_url	Dize	Modele gönderilecek dosyanın URL'si.	Hayır
filename	Dize	Modele gönderilecek dosyanın adı.	Hayır
type	enum	Giriş öğesinin türü. Her zaman input_file. Olası değerler: input_file	Yes

OpenAI.InputFileContentParam

Modele bir dosya girişi.

Name	Türü	Description	Zorunlu	Varsayılan
file_data	dize (null atanabilir)		Hayır
dosya_kimlik	dize (null atanabilir)		Hayır
file_url	Dize		Hayır
filename	dize (null atanabilir)		Hayır
type	enum	Giriş öğesinin türü. Her zaman input_file. Olası değerler: input_file	Yes

OpenAI.InputImageContent

Modele bir görüntü girişi. image girişleri hakkında bilgi edinin.

Name	Türü	Description	Zorunlu	Varsayılan
detail	OpenAI.ImageDetail		Yes
dosya_kimlik	dize (null atanabilir)		Hayır
image_url	Dize		Hayır
type	enum	Giriş öğesinin türü. Her zaman input_image. Olası değerler: input_image	Yes

OpenAI.InputImageContentParamAutoParam

Modele bir görüntü girişi. Görüntü girişleri hakkında bilgi edinin

Name	Türü	Description	Zorunlu	Varsayılan
detail	OpenAI.DetailEnum (null atanabilir)		Hayır
dosya_kimlik	dize (null atanabilir)		Hayır
image_url	Dize		Hayır
type	enum	Giriş öğesinin türü. Her zaman input_image. Olası değerler: input_image	Yes

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	Schema
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

Name	Türü	Description	Zorunlu	Varsayılan
type	OpenAI.InputItemType		Yes

OpenAI.InputItemApplyPatchToolCallItemParam

Fark düzeltme eklerini kullanarak dosya oluşturma, silme veya güncelleştirme isteğini temsil eden bir araç çağrısı.

Name	Türü	Description	Zorunlu	Varsayılan
call_id	Dize	Model tarafından oluşturulan uygulama yama aracı çağrısının benzersiz kimliği. Kısıtlamalar: minLength: 1, maxLength: 64	Yes
kimlik	dize (null atanabilir)		Hayır
Operasyon	OpenAI.ApplyPatchOperationParam	apply_patch aracına sağlanan create_file, delete_file veya update_file işlemlerinden biri.	Yes
└─ türü	OpenAI.ApplyPatchOperationParamType		Yes
durum	OpenAI.ApplyPatchCallStatusParam	apply_patch araç çağrıları için bildirilen durum değerleri.	Yes
type	enum	Öğenin türü. Her zaman apply_patch_call. Olası değerler: apply_patch_call	Yes

OpenAI.InputItemApplyPatchToolCallOutputItemParam

Bir düzeltme eki uygulama aracı çağrısı tarafından yayılan akış çıktısı.

Name	Türü	Description	Zorunlu	Varsayılan
call_id	Dize	Model tarafından oluşturulan uygulama yama aracı çağrısının benzersiz kimliği. Kısıtlamalar: minLength: 1, maxLength: 64	Yes
kimlik	dize (null atanabilir)		Hayır
output	dize (null atanabilir)		Hayır
durum	OpenAI.ApplyPatchCallOutputStatusParam	apply_patch araç çağrısı çıkışları için bildirilen sonuç değerleri.	Yes
type	enum	Öğenin türü. Her zaman apply_patch_call_output. Olası değerler: apply_patch_call_output	Yes

OpenAI.InputItemCodeInterpreterToolCall

Kodu çalıştırmak için bir araç çağrısı.

Name	Türü	Description	Zorunlu	Varsayılan
code	dize (null atanabilir)		Yes
container_id	Dize	Kodu çalıştırmak için kullanılan kapsayıcının kimliği.	Yes
kimlik	Dize	Kod yorumlayıcısı araç çağrısının benzersiz kimliği.	Yes
outputs	OpenAI.CodeInterpreterOutputLogs veya OpenAI.CodeInterpreterOutputImage dizisi		Yes
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	Yes
type	enum	Kod yorumlayıcı aracı çağrısının türü. Her zaman code_interpreter_call. Olası değerler: code_interpreter_call	Yes

OpenAI.InputItemCompactionSummaryItemParam

API tarafından v1/responses/compactoluşturulan bir sıkıştırma öğesi.

Name	Türü	Description	Zorunlu	Varsayılan
encrypted_content	Dize	Sıkıştırma özetinin şifrelenmiş içeriği. Kısıtlamalar: maxLength: 10485760	Yes
kimlik	dize (null atanabilir)		Hayır
type	enum	Öğenin türü. Her zaman compaction. Olası değerler: compaction	Yes

OpenAI.InputItemComputerCallOutputItemParam

Bir bilgisayar aracı çağrısının çıktısı.

Name	Türü	Description	Zorunlu	Varsayılan
acknowledged_safety_checks	OpenAI.ComputerCallSafetyCheckParam dizisi		Hayır
call_id	Dize	Çıktı üreten bilgisayar aracı çağrısının kimliği. Kısıtlamalar: minLength: 1, maxLength: 64	Yes
kimlik	dize (null atanabilir)		Hayır
output	OpenAI.ComputerScreenshotImage	Bilgisayar kullanım aracıyla kullanılan bir bilgisayar ekran görüntüsü.	Yes
durum	OpenAI.FunctionCallItemStatus (null atanabilir)		Hayır
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	Yes

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.

Name	Türü	Description	Zorunlu	Varsayılan
action	OpenAI.ComputerAction		Yes
call_id	Dize	Çıkış verisi ile araç çağrısına yanıt verirken kullanılan tanımlayıcı.	Yes
kimlik	Dize	Bilgisayar çağrısının benzersiz tanımlayıcısı.	Yes
pending_safety_checks	OpenAI.ComputerCallSafetyCheckParam dizisi	Bilgisayar çağrısı için bekleyen güvenlik denetimleri.	Yes
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	Yes
type	enum	Bilgisayar çağrısının türü. Her zaman computer_call. Olası değerler: computer_call	Yes

OpenAI.InputItemCustomToolCall

Model tarafından oluşturulan özel bir araca çağrı.

Name	Türü	Description	Zorunlu	Varsayılan
call_id	Dize	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ı.	Yes
kimlik	Dize	OpenAI platformundaki özel araç çağrısının benzersiz kimliği.	Hayır
input	Dize	Model tarafından oluşturulan özel araç çağrısı için girdi.	Yes
name	Dize	Çağrılan özel aracın adı.	Yes
type	enum	Özel araç çağrısının türü. Her zaman custom_tool_call. Olası değerler: custom_tool_call	Yes

OpenAI.InputItemCustomToolCallOutput

Kodunuzdan özel bir araç çağrısının çıktısı, modele geri gönderiliyor.

Name	Türü	Description	Zorunlu	Varsayılan
call_id	Dize	Ç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.	Yes
kimlik	Dize	OpenAI platformunda çıkan özel araç çağrısının benzersiz kimliği.	Hayır
output	OpenAI.FunctionAndCustomToolCallOutput dizesi veya dizisi	Kodunuz tarafından oluşturulan özel araç çağrısından çıkan çıktı. Bir dize veya çıkış içeriği listesi olabilir.	Yes
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	Yes

OpenAI.InputItemFileSearchToolCall

Dosya arama aracı çağrısının sonuçları. Daha fazla bilgi için dosya arama rehberi adresine bakınız.

Name	Türü	Description	Zorunlu	Varsayılan
kimlik	Dize	Dosya arama aracı çağrısının benzersiz kimliği.	Yes
queries	dize dizisi	Dosyaları aramak için kullanılan sorgular.	Yes
results	OpenAI.FileSearchToolCallResults dizisi		Hayır
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	Yes
type	enum	Dosya arama aracı çağrısının türü. Her zaman file_search_call. Olası değerler: file_search_call	Yes

OpenAI.InputItemFunctionCallOutputItemParam

İşlev aracı çağrısının çıktısı.

Name	Türü	Description	Zorunlu	Varsayılan
call_id	Dize	Model tarafından oluşturulan işlev aracı çağrısının benzersiz kimliği. Kısıtlamalar: minLength: 1, maxLength: 64	Yes
kimlik	dize (null atanabilir)		Hayır
output	OpenAI.InputTextContentParam veya OpenAI.InputImageContentParamAutoParam veya OpenAI.InputFileContentParam dizesi veya dizisi	İşlev aracı çağrısının metin, görüntü veya dosya çıkışı.	Yes
durum	OpenAI.FunctionCallItemStatus (null atanabilir)		Hayır
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	Yes

OpenAI.InputItemFunctionShellCallItemParam

Bir veya daha fazla kabuk komutu yürütme isteğini temsil eden bir araç.

Name	Türü	Description	Zorunlu	Varsayılan
action	OpenAI.FunctionShellActionParam	Kabuk aracı çağrısını çalıştırmayı açıklayan komutlar ve sınırlar.	Yes
└─ komutları	dize dizisi	Yürütme ortamının çalışması için sıralı kabuk komutları.	Yes
└─ max_output_length	OpenAI.integer (null atanabilir)		Hayır
└─ timeout_ms	OpenAI.integer (null atanabilir)		Hayır
call_id	Dize	Model tarafından oluşturulan shell araç çağrısının benzersiz kimliği. Kısıtlamalar: minLength: 1, maxLength: 64	Yes
kimlik	dize (null atanabilir)		Hayır
durum	OpenAI.FunctionShellCallItemStatus (null atanabilir)	Kabuk aracı çağrıları için bildirilen durum değerleri.	Hayır
type	enum	Öğenin türü. Her zaman shell_call. Olası değerler: shell_call	Yes

OpenAI.InputItemFunctionShellCallOutputItemParam

Bir kabuk aracı çağrısı tarafından yayılan akışlı çıkış öğeleri.

Name	Türü	Description	Zorunlu	Varsayılan
call_id	Dize	Model tarafından oluşturulan shell araç çağrısının benzersiz kimliği. Kısıtlamalar: minLength: 1, maxLength: 64	Yes
kimlik	dize (null atanabilir)		Hayır
max_output_length	OpenAI.integer (null atanabilir)		Hayır
output	OpenAI.FunctionShellCallOutputContentParam dizisi	Stdout ve stderr çıkışının yakalanan öbekleri ve bunların ilişkili sonuçları.	Yes
type	enum	Öğenin türü. Her zaman shell_call_output. Olası değerler: shell_call_output	Yes

OpenAI.InputItemFunctionToolCall

Bir fonksiyonu çalıştırmak için bir araç çağrısı. Daha fazla bilgi için işlev çağırma kılavuzuna bakın.

Name	Türü	Description	Zorunlu	Varsayılan
arguments	Dize	İşleve geçirecek bağımsız değişkenlerin JSON dizesi.	Yes
call_id	Dize	Model tarafından oluşturulan işlev aracı çağrısının benzersiz kimliği.	Yes
kimlik	Dize	İşlev aracı çağrısının benzersiz kimliği.	Hayır
name	Dize	Çalıştırılacak işlevin adı.	Yes
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ır
type	enum	İşlev aracı çağrısının türü. Her zaman function_call. Olası değerler: function_call	Yes

OpenAI.InputItemImageGenToolCall

Model tarafından yapılan bir görüntü oluşturma isteği.

Name	Türü	Description	Zorunlu	Varsayılan
kimlik	Dize	Görüntü oluşturma çağrısının benzersiz kimliği.	Yes
result	dize (null atanabilir)		Yes
durum	enum	Görüntü oluşturma çağrısının durumu. Olası değerler: in_progress, completed, generating, failed	Yes
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	Yes

OpenAI.InputItemLocalShellToolCall

Yerel kabukta komut çalıştırmak için bir araç çağrısı.

Name	Türü	Description	Zorunlu	Varsayılan
action	OpenAI.LocalShellExecAction	Sunucuda bir shell komutu çalıştırın.	Yes
call_id	Dize	Model tarafından oluşturulan yerel kabuk aracı çağrısının benzersiz kimliği.	Yes
kimlik	Dize	Yerel shell çağrısının benzersiz kimliği.	Yes
durum	enum	Yerel shell çağrısının durumu. Olası değerler: in_progress, completed, incomplete	Yes
type	enum	Yerel shell call'ın türü. Her zaman local_shell_call. Olası değerler: local_shell_call	Yes

OpenAI.InputItemLocalShellToolCallOutput

Yerel kabuk aracı çağrısının çıktısı.

Name	Türü	Description	Zorunlu	Varsayılan
kimlik	Dize	Model tarafından oluşturulan yerel kabuk aracı çağrısının benzersiz kimliği.	Yes
output	Dize	Yerel shell aracı çağrısının çıktısının JSON dizesi.	Yes
durum	enum	Olası değerler: in_progress, completed, incomplete	Hayır
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	Yes

OpenAI.InputItemMcpApprovalRequest

Bir araç çağrısı işlemi için insan onayı isteği.

Name	Türü	Description	Zorunlu	Varsayılan
arguments	Dize	Araç için bir JSON bağımsız değişken dizesi.	Yes
kimlik	Dize	Onay talebinin benzersiz kimliği.	Yes
name	Dize	Çalıştırılacak aracın adı.	Yes
sunucu etiketi	Dize	İsteği yapan MCP sunucusunun etiketi.	Yes
type	enum	Öğenin türü. Her zaman mcp_approval_request. Olası değerler: mcp_approval_request	Yes

OpenAI.InputItemMcpApprovalResponse

MCP onay isteğine yanıt.

Name	Türü	Description	Zorunlu	Varsayılan
approval_request_id	Dize	Yanıtlanan onay isteğinin ID'si.	Yes
approve	boolean	İsteğin onaylanıp onaylanmadı.	Yes
kimlik	dize (null atanabilir)		Hayır
neden	dize (null atanabilir)		Hayır
type	enum	Öğenin türü. Her zaman mcp_approval_response. Olası değerler: mcp_approval_response	Yes

OpenAI.InputItemMcpListTools

MCP sunucusunda kullanılabilen araçların listesi.

Name	Türü	Description	Zorunlu	Varsayılan
hata	dize (null atanabilir)		Hayır
kimlik	Dize	Listenin benzersiz kimliği.	Yes
sunucu etiketi	Dize	MCP sunucusunun etiketi.	Yes
tools	OpenAI.MCPListToolsTool dizisi	Sunucuda bulunan araçlar.	Yes
type	enum	Öğenin türü. Her zaman mcp_list_tools. Olası değerler: mcp_list_tools	Yes

OpenAI.InputItemMcpToolCall

MCP sunucusundaki bir aracın çağrılması.

Name	Türü	Description	Zorunlu	Varsayılan
approval_request_id	dize (null atanabilir)		Hayır
arguments	Dize	Araca geçirilen bağımsız değişkenlerin JSON dizesi.	Yes
hata	dize (null atanabilir)		Hayır
kimlik	Dize	Araç çağrısının benzersiz kimliği.	Yes
name	Dize	Çalıştırılan aracın adı.	Yes
output	dize (null atanabilir)		Hayır
sunucu etiketi	Dize	Aracı çalıştıran MCP sunucusunun etiketi.	Yes
durum	OpenAI.MCPToolCallStatus		Hayır
type	enum	Öğenin türü. Her zaman mcp_call. Olası değerler: mcp_call	Yes

OpenAI.InputItemOutputMessage

Modelden bir çıkış iletisi.

Name	Türü	Description	Zorunlu	Varsayılan
içerik	OpenAI.OutputMessageContent dizisi	Çıkış iletisinin içeriği.	Yes
kimlik	Dize	Çıkış iletisinin benzersiz kimliği.	Yes
role	enum	Çıkış iletisinin rolü. Her zaman assistant. Olası değerler: assistant	Yes
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	Yes
type	enum	Çıkış iletisinin türü. Her zaman message. Olası değerler: output_message	Yes

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 input ile manuel olarak konuşuyorsanız, Responses API'ye hesabınıza dahil edin.

Name	Türü	Description	Zorunlu	Varsayılan
içerik	OpenAI.ReasoningTextContent dizisi	Metin içeriğini akıl yürütme.	Hayır
encrypted_content	dize (null atanabilir)		Hayır
kimlik	Dize	Akıl yürütme içeriğinin benzersiz tanımlayıcısı.	Yes
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ır
summary	OpenAI.Summary dizisi	Akıl yürütme özeti içeriği.	Yes
type	enum	Nesnenin türü. Her zaman reasoning. Olası değerler: reasoning	Yes

OpenAI.InputItemType

Property	Değer
Türü	Dize
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.

Name	Türü	Description	Zorunlu	Varsayılan
action	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).	Yes
kimlik	Dize	Web arama aracının benzersiz kimliği çağrı.	Yes
durum	enum	Web arama aracı çağrısının durumu. Olası değerler: in_progress, searching, completed, failed	Yes
type	enum	Web arama aracının türü. Her zaman web_search_call. Olası değerler: web_search_call	Yes

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.

Name	Türü	Description	Zorunlu	Varsayılan
içerik	OpenAI.InputMessageContentList	Modelde farklı içerik içeren bir veya birden çok giriş öğesinin listesi types.	Yes
role	enum	İleti girişinin rolü. user, systemveya developer. Olası değerler: user, system, developer	Yes
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ır
type	enum	İleti girişinin türü. Her zaman messageolarak ayarlayın. Olası değerler: message	Yes

OpenAI.InputMessageContentList

Modelde farklı içerik türleri içeren bir veya birden çok giriş öğesinin listesi.

Dizisi: OpenAI.InputContent

OpenAI.InputMessageResource

Name	Türü	Description	Zorunlu	Varsayılan
içerik	OpenAI.InputMessageContentList	Modelde farklı içerik içeren bir veya birden çok giriş öğesinin listesi types.	Yes
kimlik	Dize	İleti girişinin benzersiz kimliği.	Yes
role	enum	İleti girişinin rolü. user, systemveya developer. Olası değerler: user, system, developer	Yes
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ır
type	enum	İleti girişinin türü. Her zaman messageolarak ayarlayın. Olası değerler: message	Yes

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
• İşlev çağırma

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
• İşlev çağırma

OpenAI.InputTextContent

Modele metin girişi.

Name	Türü	Description	Zorunlu	Varsayılan
text	Dize	Modele metin girişi.	Yes
type	enum	Giriş öğesinin türü. Her zaman input_text. Olası değerler: input_text	Yes

OpenAI.InputTextContentParam

Modele metin girişi.

Name	Türü	Description	Zorunlu	Varsayılan
text	Dize	Modele metin girişi. Kısıtlamalar: maxLength: 10485760	Yes
type	enum	Giriş öğesinin türü. Her zaman input_text. Olası değerler: input_text	Yes

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	Schema
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

Name	Türü	Description	Zorunlu	Varsayılan
type	OpenAI.ItemType		Yes

OpenAI.ItemApplyPatchToolCallItemParam

Fark düzeltme eklerini kullanarak dosya oluşturma, silme veya güncelleştirme isteğini temsil eden bir araç çağrısı.

Name	Türü	Description	Zorunlu	Varsayılan
call_id	Dize	Model tarafından oluşturulan uygulama yama aracı çağrısının benzersiz kimliği. Kısıtlamalar: minLength: 1, maxLength: 64	Yes
kimlik	dize (null atanabilir)		Hayır
Operasyon	OpenAI.ApplyPatchOperationParam	apply_patch aracına sağlanan create_file, delete_file veya update_file işlemlerinden biri.	Yes
└─ türü	OpenAI.ApplyPatchOperationParamType		Yes
durum	OpenAI.ApplyPatchCallStatusParam	apply_patch araç çağrıları için bildirilen durum değerleri.	Yes
type	enum	Öğenin türü. Her zaman apply_patch_call. Olası değerler: apply_patch_call	Yes

OpenAI.ItemApplyPatchToolCallOutputItemParam

Bir düzeltme eki uygulama aracı çağrısı tarafından yayılan akış çıktısı.

Name	Türü	Description	Zorunlu	Varsayılan
call_id	Dize	Model tarafından oluşturulan uygulama yama aracı çağrısının benzersiz kimliği. Kısıtlamalar: minLength: 1, maxLength: 64	Yes
kimlik	dize (null atanabilir)		Hayır
output	dize (null atanabilir)		Hayır
durum	OpenAI.ApplyPatchCallOutputStatusParam	apply_patch araç çağrısı çıkışları için bildirilen sonuç değerleri.	Yes
type	enum	Öğenin türü. Her zaman apply_patch_call_output. Olası değerler: apply_patch_call_output	Yes

OpenAI.ItemCodeInterpreterToolCall

Kodu çalıştırmak için bir araç çağrısı.

Name	Türü	Description	Zorunlu	Varsayılan
code	dize (null atanabilir)		Yes
container_id	Dize	Kodu çalıştırmak için kullanılan kapsayıcının kimliği.	Yes
kimlik	Dize	Kod yorumlayıcısı araç çağrısının benzersiz kimliği.	Yes
outputs	OpenAI.CodeInterpreterOutputLogs veya OpenAI.CodeInterpreterOutputImage dizisi		Yes
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	Yes
type	enum	Kod yorumlayıcı aracı çağrısının türü. Her zaman code_interpreter_call. Olası değerler: code_interpreter_call	Yes

OpenAI.ItemCompactionSummaryItemParam

API tarafından v1/responses/compactoluşturulan bir sıkıştırma öğesi.

Name	Türü	Description	Zorunlu	Varsayılan
encrypted_content	Dize	Sıkıştırma özetinin şifrelenmiş içeriği. Kısıtlamalar: maxLength: 10485760	Yes
kimlik	dize (null atanabilir)		Hayır
type	enum	Öğenin türü. Her zaman compaction. Olası değerler: compaction	Yes

OpenAI.ItemComputerCallOutputItemParam

Bir bilgisayar aracı çağrısının çıktısı.

Name	Türü	Description	Zorunlu	Varsayılan
acknowledged_safety_checks	OpenAI.ComputerCallSafetyCheckParam dizisi		Hayır
call_id	Dize	Çıktı üreten bilgisayar aracı çağrısının kimliği. Kısıtlamalar: minLength: 1, maxLength: 64	Yes
kimlik	dize (null atanabilir)		Hayır
output	OpenAI.ComputerScreenshotImage	Bilgisayar kullanım aracıyla kullanılan bir bilgisayar ekran görüntüsü.	Yes
durum	OpenAI.FunctionCallItemStatus (null atanabilir)		Hayır
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	Yes

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.

Name	Türü	Description	Zorunlu	Varsayılan
action	OpenAI.ComputerAction		Yes
call_id	Dize	Çıkış verisi ile araç çağrısına yanıt verirken kullanılan tanımlayıcı.	Yes
kimlik	Dize	Bilgisayar çağrısının benzersiz tanımlayıcısı.	Yes
pending_safety_checks	OpenAI.ComputerCallSafetyCheckParam dizisi	Bilgisayar çağrısı için bekleyen güvenlik denetimleri.	Yes
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	Yes
type	enum	Bilgisayar çağrısının türü. Her zaman computer_call. Olası değerler: computer_call	Yes

OpenAI.ItemCustomToolCall

Model tarafından oluşturulan özel bir araca çağrı.

Name	Türü	Description	Zorunlu	Varsayılan
call_id	Dize	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ı.	Yes
kimlik	Dize	OpenAI platformundaki özel araç çağrısının benzersiz kimliği.	Hayır
input	Dize	Model tarafından oluşturulan özel araç çağrısı için girdi.	Yes
name	Dize	Çağrılan özel aracın adı.	Yes
type	enum	Özel araç çağrısının türü. Her zaman custom_tool_call. Olası değerler: custom_tool_call	Yes

OpenAI.ItemCustomToolCallOutput

Kodunuzdan özel bir araç çağrısının çıktısı, modele geri gönderiliyor.

Name	Türü	Description	Zorunlu	Varsayılan
call_id	Dize	Ç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.	Yes
kimlik	Dize	OpenAI platformunda çıkan özel araç çağrısının benzersiz kimliği.	Hayır
output	OpenAI.FunctionAndCustomToolCallOutput dizesi veya dizisi	Kodunuz tarafından oluşturulan özel araç çağrısından çıkan çıktı. Bir dize veya çıkış içeriği listesi olabilir.	Yes
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	Yes

OpenAI.ItemFileSearchToolCall

Dosya arama aracı çağrısının sonuçları. Daha fazla bilgi için dosya arama rehberi adresine bakınız.

Name	Türü	Description	Zorunlu	Varsayılan
kimlik	Dize	Dosya arama aracı çağrısının benzersiz kimliği.	Yes
queries	dize dizisi	Dosyaları aramak için kullanılan sorgular.	Yes
results	OpenAI.FileSearchToolCallResults dizisi		Hayır
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	Yes
type	enum	Dosya arama aracı çağrısının türü. Her zaman file_search_call. Olası değerler: file_search_call	Yes

OpenAI.ItemFunctionCallOutputItemParam

İşlev aracı çağrısının çıktısı.

Name	Türü	Description	Zorunlu	Varsayılan
call_id	Dize	Model tarafından oluşturulan işlev aracı çağrısının benzersiz kimliği. Kısıtlamalar: minLength: 1, maxLength: 64	Yes
kimlik	dize (null atanabilir)		Hayır
output	OpenAI.InputTextContentParam veya OpenAI.InputImageContentParamAutoParam veya OpenAI.InputFileContentParam dizesi veya dizisi	İşlev aracı çağrısının metin, görüntü veya dosya çıkışı.	Yes
durum	OpenAI.FunctionCallItemStatus (null atanabilir)		Hayır
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	Yes

OpenAI.ItemFunctionShellCallItemParam

Bir veya daha fazla kabuk komutu yürütme isteğini temsil eden bir araç.

Name	Türü	Description	Zorunlu	Varsayılan
action	OpenAI.FunctionShellActionParam	Kabuk aracı çağrısını çalıştırmayı açıklayan komutlar ve sınırlar.	Yes
└─ komutları	dize dizisi	Yürütme ortamının çalışması için sıralı kabuk komutları.	Yes
└─ max_output_length	OpenAI.integer (null atanabilir)		Hayır
└─ timeout_ms	OpenAI.integer (null atanabilir)		Hayır
call_id	Dize	Model tarafından oluşturulan shell araç çağrısının benzersiz kimliği. Kısıtlamalar: minLength: 1, maxLength: 64	Yes
kimlik	dize (null atanabilir)		Hayır
durum	OpenAI.FunctionShellCallItemStatus (null atanabilir)	Kabuk aracı çağrıları için bildirilen durum değerleri.	Hayır
type	enum	Öğenin türü. Her zaman shell_call. Olası değerler: shell_call	Yes

OpenAI.ItemFunctionShellCallOutputItemParam

Bir kabuk aracı çağrısı tarafından yayılan akışlı çıkış öğeleri.

Name	Türü	Description	Zorunlu	Varsayılan
call_id	Dize	Model tarafından oluşturulan shell araç çağrısının benzersiz kimliği. Kısıtlamalar: minLength: 1, maxLength: 64	Yes
kimlik	dize (null atanabilir)		Hayır
max_output_length	OpenAI.integer (null atanabilir)		Hayır
output	OpenAI.FunctionShellCallOutputContentParam dizisi	Stdout ve stderr çıkışının yakalanan öbekleri ve bunların ilişkili sonuçları.	Yes
type	enum	Öğenin türü. Her zaman shell_call_output. Olası değerler: shell_call_output	Yes

OpenAI.ItemFunctionToolCall

Bir fonksiyonu çalıştırmak için bir araç çağrısı. Daha fazla bilgi için işlev çağırma kılavuzuna bakın.

Name	Türü	Description	Zorunlu	Varsayılan
arguments	Dize	İşleve geçirecek bağımsız değişkenlerin JSON dizesi.	Yes
call_id	Dize	Model tarafından oluşturulan işlev aracı çağrısının benzersiz kimliği.	Yes
kimlik	Dize	İşlev aracı çağrısının benzersiz kimliği.	Hayır
name	Dize	Çalıştırılacak işlevin adı.	Yes
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ır
type	enum	İşlev aracı çağrısının türü. Her zaman function_call. Olası değerler: function_call	Yes

OpenAI.ItemImageGenToolCall

Model tarafından yapılan bir görüntü oluşturma isteği.

Name	Türü	Description	Zorunlu	Varsayılan
kimlik	Dize	Görüntü oluşturma çağrısının benzersiz kimliği.	Yes
result	dize (null atanabilir)		Yes
durum	enum	Görüntü oluşturma çağrısının durumu. Olası değerler: in_progress, completed, generating, failed	Yes
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	Yes

OpenAI.ItemLocalShellToolCall

Yerel kabukta komut çalıştırmak için bir araç çağrısı.

Name	Türü	Description	Zorunlu	Varsayılan
action	OpenAI.LocalShellExecAction	Sunucuda bir shell komutu çalıştırın.	Yes
call_id	Dize	Model tarafından oluşturulan yerel kabuk aracı çağrısının benzersiz kimliği.	Yes
kimlik	Dize	Yerel shell çağrısının benzersiz kimliği.	Yes
durum	enum	Yerel shell çağrısının durumu. Olası değerler: in_progress, completed, incomplete	Yes
type	enum	Yerel shell call'ın türü. Her zaman local_shell_call. Olası değerler: local_shell_call	Yes

OpenAI.ItemLocalShellToolCallOutput

Yerel kabuk aracı çağrısının çıktısı.

Name	Türü	Description	Zorunlu	Varsayılan
kimlik	Dize	Model tarafından oluşturulan yerel kabuk aracı çağrısının benzersiz kimliği.	Yes
output	Dize	Yerel shell aracı çağrısının çıktısının JSON dizesi.	Yes
durum	enum	Olası değerler: in_progress, completed, incomplete	Hayır
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	Yes

OpenAI.ItemMcpApprovalRequest

Bir araç çağrısı işlemi için insan onayı isteği.

Name	Türü	Description	Zorunlu	Varsayılan
arguments	Dize	Araç için bir JSON bağımsız değişken dizesi.	Yes
kimlik	Dize	Onay talebinin benzersiz kimliği.	Yes
name	Dize	Çalıştırılacak aracın adı.	Yes
sunucu etiketi	Dize	İsteği yapan MCP sunucusunun etiketi.	Yes
type	enum	Öğenin türü. Her zaman mcp_approval_request. Olası değerler: mcp_approval_request	Yes

OpenAI.ItemMcpApprovalResponse

MCP onay isteğine yanıt.

Name	Türü	Description	Zorunlu	Varsayılan
approval_request_id	Dize	Yanıtlanan onay isteğinin ID'si.	Yes
approve	boolean	İsteğin onaylanıp onaylanmadı.	Yes
kimlik	dize (null atanabilir)		Hayır
neden	dize (null atanabilir)		Hayır
type	enum	Öğenin türü. Her zaman mcp_approval_response. Olası değerler: mcp_approval_response	Yes

OpenAI.ItemMcpListTools

MCP sunucusunda kullanılabilen araçların listesi.

Name	Türü	Description	Zorunlu	Varsayılan
hata	dize (null atanabilir)		Hayır
kimlik	Dize	Listenin benzersiz kimliği.	Yes
sunucu etiketi	Dize	MCP sunucusunun etiketi.	Yes
tools	OpenAI.MCPListToolsTool dizisi	Sunucuda bulunan araçlar.	Yes
type	enum	Öğenin türü. Her zaman mcp_list_tools. Olası değerler: mcp_list_tools	Yes

OpenAI.ItemMcpToolCall

MCP sunucusundaki bir aracın çağrılması.

Name	Türü	Description	Zorunlu	Varsayılan
approval_request_id	dize (null atanabilir)		Hayır
arguments	Dize	Araca geçirilen bağımsız değişkenlerin JSON dizesi.	Yes
hata	dize (null atanabilir)		Hayır
kimlik	Dize	Araç çağrısının benzersiz kimliği.	Yes
name	Dize	Çalıştırılan aracın adı.	Yes
output	dize (null atanabilir)		Hayır
sunucu etiketi	Dize	Aracı çalıştıran MCP sunucusunun etiketi.	Yes
durum	OpenAI.MCPToolCallStatus		Hayır
type	enum	Öğenin türü. Her zaman mcp_call. Olası değerler: mcp_call	Yes

OpenAI.ItemOutputMessage

Modelden bir çıkış iletisi.

Name	Türü	Description	Zorunlu	Varsayılan
içerik	OpenAI.OutputMessageContent dizisi	Çıkış iletisinin içeriği.	Yes
kimlik	Dize	Çıkış iletisinin benzersiz kimliği.	Yes
role	enum	Çıkış iletisinin rolü. Her zaman assistant. Olası değerler: assistant	Yes
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	Yes
type	enum	Çıkış iletisinin türü. Her zaman message. Olası değerler: output_message	Yes

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 input ile manuel olarak konuşuyorsanız, Responses API'ye hesabınıza dahil edin.

Name	Türü	Description	Zorunlu	Varsayılan
içerik	OpenAI.ReasoningTextContent dizisi	Metin içeriğini akıl yürütme.	Hayır
encrypted_content	dize (null atanabilir)		Hayır
kimlik	Dize	Akıl yürütme içeriğinin benzersiz tanımlayıcısı.	Yes
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ır
summary	OpenAI.Summary dizisi	Akıl yürütme özeti içeriği.	Yes
type	enum	Nesnenin türü. Her zaman reasoning. Olası değerler: reasoning	Yes

OpenAI.ItemReferenceParam

Başvurulacak bir öğenin iç tanımlayıcısı.

Name	Türü	Description	Zorunlu	Varsayılan
kimlik	Dize	Başvurulacak öğenin kimliği.	Yes
type	enum	Başvurulacak öğenin türü. Her zaman item_reference. Olası değerler: item_reference	Yes

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	Schema
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

Name	Türü	Description	Zorunlu	Varsayılan
type	OpenAI.ItemResourceType		Yes

OpenAI.ItemResourceApplyPatchToolCall

Dosya oluşturarak, silerek veya güncelleştirerek dosya farklarını uygulayan bir araç çağrısı.

Name	Türü	Description	Zorunlu	Varsayılan
call_id	Dize	Model tarafından oluşturulan uygulama yama aracı çağrısının benzersiz kimliği.	Yes
Oluşturan	Dize	Bu araç çağrısını oluşturan varlığın kimliği.	Hayır
kimlik	Dize	Düzeltme eki uygulama aracı çağrısının benzersiz kimliği. Bu öğe, API aracılığıyla iade edildiğinde doldurulur.	Yes
Operasyon	OpenAI.ApplyPatchFileOperation	apply_patch aracılığıyla uygulanan create_file, delete_file veya update_file işlemlerinden biri.	Yes
└─ türü	OpenAI.ApplyPatchFileOperationType		Yes
durum	OpenAI.ApplyPatchCallStatus		Yes
type	enum	Öğenin türü. Her zaman apply_patch_call. Olası değerler: apply_patch_call	Yes

OpenAI.ItemResourceApplyPatchToolCallOutput

Bir düzeltme eki uygulama aracı çağrısı tarafından yayılan çıkış.

Name	Türü	Description	Zorunlu	Varsayılan
call_id	Dize	Model tarafından oluşturulan uygulama yama aracı çağrısının benzersiz kimliği.	Yes
Oluşturan	Dize	Bu aracı oluşturan varlığın kimliği çağrı çıktısı.	Hayır
kimlik	Dize	Düzeltme eki uygulama aracı çağrı çıkışının benzersiz kimliği. Bu öğe, API aracılığıyla iade edildiğinde doldurulur.	Yes
output	dize (null atanabilir)		Hayır
durum	OpenAI.ApplyPatchCallOutputStatus		Yes
type	enum	Öğenin türü. Her zaman apply_patch_call_output. Olası değerler: apply_patch_call_output	Yes

OpenAI.ItemResourceCodeInterpreterToolCall

Kodu çalıştırmak için bir araç çağrısı.

Name	Türü	Description	Zorunlu	Varsayılan
code	dize (null atanabilir)		Yes
container_id	Dize	Kodu çalıştırmak için kullanılan kapsayıcının kimliği.	Yes
kimlik	Dize	Kod yorumlayıcısı araç çağrısının benzersiz kimliği.	Yes
outputs	OpenAI.CodeInterpreterOutputLogs veya OpenAI.CodeInterpreterOutputImage dizisi		Yes
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	Yes
type	enum	Kod yorumlayıcı aracı çağrısının türü. Her zaman code_interpreter_call. Olası değerler: code_interpreter_call	Yes

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.

Name	Türü	Description	Zorunlu	Varsayılan
action	OpenAI.ComputerAction		Yes
call_id	Dize	Çıkış verisi ile araç çağrısına yanıt verirken kullanılan tanımlayıcı.	Yes
kimlik	Dize	Bilgisayar çağrısının benzersiz tanımlayıcısı.	Yes
pending_safety_checks	OpenAI.ComputerCallSafetyCheckParam dizisi	Bilgisayar çağrısı için bekleyen güvenlik denetimleri.	Yes
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	Yes
type	enum	Bilgisayar çağrısının türü. Her zaman computer_call. Olası değerler: computer_call	Yes

OpenAI.ItemResourceComputerToolCallOutputResource

Name	Türü	Description	Zorunlu	Varsayılan
acknowledged_safety_checks	OpenAI.ComputerCallSafetyCheckParam dizisi	API tarafından bildirilen ve kabul edilen güvenlik kontrolleri geliştirici.	Hayır
call_id	Dize	Çıktı üreten bilgisayar aracı çağrısının kimliği.	Yes
kimlik	Dize	Bilgisayar aracı çağrısı çıkış kimliği.	Hayır
output	OpenAI.ComputerScreenshotImage	Bilgisayar kullanım aracıyla kullanılan bir bilgisayar ekran görüntüsü.	Yes
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ır
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	Yes

OpenAI.ItemResourceFileSearchToolCall

Dosya arama aracı çağrısının sonuçları. Daha fazla bilgi için dosya arama rehberi adresine bakınız.

Name	Türü	Description	Zorunlu	Varsayılan
kimlik	Dize	Dosya arama aracı çağrısının benzersiz kimliği.	Yes
queries	dize dizisi	Dosyaları aramak için kullanılan sorgular.	Yes
results	OpenAI.FileSearchToolCallResults dizisi		Hayır
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	Yes
type	enum	Dosya arama aracı çağrısının türü. Her zaman file_search_call. Olası değerler: file_search_call	Yes

OpenAI.ItemResourceFunctionShellCall

Yönetilen bir ortamda bir veya daha fazla kabuk komutu yürüten bir araç çağrısı.

Name	Türü	Description	Zorunlu	Varsayılan
action	OpenAI.FunctionShellAction	Bir kabuk komutu yürütür.	Yes
└─ komutları	dize dizisi		Yes
└─ max_output_length	OpenAI.integer (null atanabilir)		Yes
└─ timeout_ms	OpenAI.integer (null atanabilir)		Yes
call_id	Dize	Model tarafından oluşturulan shell araç çağrısının benzersiz kimliği.	Yes
Oluşturan	Dize	Bu araç çağrısını oluşturan varlığın kimliği.	Hayır
kimlik	Dize	Kabuk aracı çağrısının benzersiz kimliği. Bu öğe, API aracılığıyla iade edildiğinde doldurulur.	Yes
durum	OpenAI.LocalShellCallStatus		Yes
type	enum	Öğenin türü. Her zaman shell_call. Olası değerler: shell_call	Yes

OpenAI.ItemResourceFunctionShellCallOutput

Yayılan bir kabuk aracı çağrısının çıktısı.

Name	Türü	Description	Zorunlu	Varsayılan
call_id	Dize	Model tarafından oluşturulan shell araç çağrısının benzersiz kimliği.	Yes
Oluşturan	Dize	Öğeyi oluşturan aktörün tanımlayıcısı.	Hayır
kimlik	Dize	Kabuk çağrısı çıkışının benzersiz kimliği. Bu öğe, API aracılığıyla iade edildiğinde doldurulur.	Yes
max_output_length	OpenAI.integer (null atanabilir)		Yes
output	OpenAI.FunctionShellCallOutputContent dizisi	Kabuk çağrısı çıkış içeriği dizisi	Yes
type	enum	Kabuk çağrısı çıkışının türü. Her zaman shell_call_output. Olası değerler: shell_call_output	Yes

OpenAI.ItemResourceFunctionToolCallOutputResource

Name	Türü	Description	Zorunlu	Varsayılan
call_id	Dize	Model tarafından oluşturulan işlev aracı çağrısının benzersiz kimliği.	Yes
kimlik	Dize	İş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ır
output	OpenAI.FunctionAndCustomToolCallOutput dizesi veya dizisi	Kodunuz tarafından oluşturulan işlev çağrısının çıktısı. Bir dize veya çıkış içeriği listesi olabilir.	Yes
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ır
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	Yes

OpenAI.ItemResourceFunctionToolCallResource

Name	Türü	Description	Zorunlu	Varsayılan
arguments	Dize	İşleve geçirecek bağımsız değişkenlerin JSON dizesi.	Yes
call_id	Dize	Model tarafından oluşturulan işlev aracı çağrısının benzersiz kimliği.	Yes
kimlik	Dize	İşlev aracı çağrısının benzersiz kimliği.	Hayır
name	Dize	Çalıştırılacak işlevin adı.	Yes
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ır
type	enum	İşlev aracı çağrısının türü. Her zaman function_call. Olası değerler: function_call	Yes

OpenAI.ItemResourceImageGenToolCall

Model tarafından yapılan bir görüntü oluşturma isteği.

Name	Türü	Description	Zorunlu	Varsayılan
kimlik	Dize	Görüntü oluşturma çağrısının benzersiz kimliği.	Yes
result	dize (null atanabilir)		Yes
durum	enum	Görüntü oluşturma çağrısının durumu. Olası değerler: in_progress, completed, generating, failed	Yes
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	Yes

OpenAI.ItemResourceLocalShellToolCall

Yerel kabukta komut çalıştırmak için bir araç çağrısı.

Name	Türü	Description	Zorunlu	Varsayılan
action	OpenAI.LocalShellExecAction	Sunucuda bir shell komutu çalıştırın.	Yes
call_id	Dize	Model tarafından oluşturulan yerel kabuk aracı çağrısının benzersiz kimliği.	Yes
kimlik	Dize	Yerel shell çağrısının benzersiz kimliği.	Yes
durum	enum	Yerel shell çağrısının durumu. Olası değerler: in_progress, completed, incomplete	Yes
type	enum	Yerel shell call'ın türü. Her zaman local_shell_call. Olası değerler: local_shell_call	Yes

OpenAI.ItemResourceLocalShellToolCallOutput

Yerel kabuk aracı çağrısının çıktısı.

Name	Türü	Description	Zorunlu	Varsayılan
kimlik	Dize	Model tarafından oluşturulan yerel kabuk aracı çağrısının benzersiz kimliği.	Yes
output	Dize	Yerel shell aracı çağrısının çıktısının JSON dizesi.	Yes
durum	enum	Olası değerler: in_progress, completed, incomplete	Hayır
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	Yes

OpenAI.ItemResourceMcpApprovalRequest

Bir araç çağrısı işlemi için insan onayı isteği.

Name	Türü	Description	Zorunlu	Varsayılan
arguments	Dize	Araç için bir JSON bağımsız değişken dizesi.	Yes
kimlik	Dize	Onay talebinin benzersiz kimliği.	Yes
name	Dize	Çalıştırılacak aracın adı.	Yes
sunucu etiketi	Dize	İsteği yapan MCP sunucusunun etiketi.	Yes
type	enum	Öğenin türü. Her zaman mcp_approval_request. Olası değerler: mcp_approval_request	Yes

OpenAI.ItemResourceMcpApprovalResponseResource

MCP onay isteğine yanıt.

Name	Türü	Description	Zorunlu	Varsayılan
approval_request_id	Dize	Yanıtlanan onay isteğinin ID'si.	Yes
approve	boolean	İsteğin onaylanıp onaylanmadı.	Yes
kimlik	Dize	Onay yanıtının benzersiz kimliği	Yes
neden	dize (null atanabilir)		Hayır
type	enum	Öğenin türü. Her zaman mcp_approval_response. Olası değerler: mcp_approval_response	Yes

OpenAI.ItemResourceMcpListTools

MCP sunucusunda kullanılabilen araçların listesi.

Name	Türü	Description	Zorunlu	Varsayılan
hata	dize (null atanabilir)		Hayır
kimlik	Dize	Listenin benzersiz kimliği.	Yes
sunucu etiketi	Dize	MCP sunucusunun etiketi.	Yes
tools	OpenAI.MCPListToolsTool dizisi	Sunucuda bulunan araçlar.	Yes
type	enum	Öğenin türü. Her zaman mcp_list_tools. Olası değerler: mcp_list_tools	Yes

OpenAI.ItemResourceMcpToolCall

MCP sunucusundaki bir aracın çağrılması.

Name	Türü	Description	Zorunlu	Varsayılan
approval_request_id	dize (null atanabilir)		Hayır
arguments	Dize	Araca geçirilen bağımsız değişkenlerin JSON dizesi.	Yes
hata	dize (null atanabilir)		Hayır
kimlik	Dize	Araç çağrısının benzersiz kimliği.	Yes
name	Dize	Çalıştırılan aracın adı.	Yes
output	dize (null atanabilir)		Hayır
sunucu etiketi	Dize	Aracı çalıştıran MCP sunucusunun etiketi.	Yes
durum	OpenAI.MCPToolCallStatus		Hayır
type	enum	Öğenin türü. Her zaman mcp_call. Olası değerler: mcp_call	Yes

OpenAI.ItemResourceOutputMessage

Modelden bir çıkış iletisi.

Name	Türü	Description	Zorunlu	Varsayılan
içerik	OpenAI.OutputMessageContent dizisi	Çıkış iletisinin içeriği.	Yes
kimlik	Dize	Çıkış iletisinin benzersiz kimliği.	Yes
role	enum	Çıkış iletisinin rolü. Her zaman assistant. Olası değerler: assistant	Yes
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	Yes
type	enum	Çıkış iletisinin türü. Her zaman message. Olası değerler: output_message	Yes

OpenAI.ItemResourceType

Property	Değer
Türü	Dize
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.

Name	Türü	Description	Zorunlu	Varsayılan
action	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).	Yes
kimlik	Dize	Web arama aracının benzersiz kimliği çağrı.	Yes
durum	enum	Web arama aracı çağrısının durumu. Olası değerler: in_progress, searching, completed, failed	Yes
type	enum	Web arama aracının türü. Her zaman web_search_call. Olası değerler: web_search_call	Yes

OpenAI.ItemType

Property	Değer
Türü	Dize
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.

Name	Türü	Description	Zorunlu	Varsayılan
action	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).	Yes
kimlik	Dize	Web arama aracının benzersiz kimliği çağrı.	Yes
durum	enum	Web arama aracı çağrısının durumu. Olası değerler: in_progress, searching, completed, failed	Yes
type	enum	Web arama aracının türü. Her zaman web_search_call. Olası değerler: web_search_call	Yes

OpenAI.KeyPressAction

Modelin gerçekleştirmek istediği tuş baskıları koleksiyonu.

Name	Türü	Description	Zorunlu	Varsayılan
keys	dize dizisi	Modelin basılmasını istediği tuş kombinasyonu. Bu, her biri bir anahtarı temsil eden bir dize dizisidir.	Yes
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	Yes

OpenAI.ListFineTuningJobCheckpointsResponse

Name	Türü	Description	Zorunlu	Varsayılan
data	OpenAI.FineTuningJobCheckpoint dizisi		Yes
ilk_kimlik	dize (null atanabilir)		Hayır
daha_fazla	boolean		Yes
son_kimlik	dize (null atanabilir)		Hayır
Obje	enum	Olası değerler: list	Yes

OpenAI.ListFineTuningJobEventsResponse

Name	Türü	Description	Zorunlu	Varsayılan
data	OpenAI.FineTuningJobEvent dizisi		Yes
daha_fazla	boolean		Yes
Obje	enum	Olası değerler: list	Yes

OpenAI.ListPaginatedFineTuningJobsResponse

Name	Türü	Description	Zorunlu	Varsayılan
data	OpenAI.FineTuningJob dizisi		Yes
daha_fazla	boolean		Yes
Obje	enum	Olası değerler: list	Yes

OpenAI.LocalShellCallStatus

Property	Değer
Türü	Dize
Değerler	in_progress completed incomplete

OpenAI.LocalShellExecAction

Sunucuda bir shell komutu çalıştırın.

Name	Türü	Description	Zorunlu	Varsayılan
komut	dize dizisi	Çalıştırılacak komut.	Yes
env	Obje	Komutu için ayarlanacağı ortam değişkenleri.	Yes
zaman_aşımı_ms	OpenAI.integer (null atanabilir)		Hayır
type	enum	Yerel kabuk eyleminin türü. Her zaman exec. Olası değerler: exec	Yes
user	dize (null atanabilir)		Hayır
çalışma_dizini	dize (null atanabilir)		Hayır

OpenAI.LocalShellToolParam

Modelin yerel bir ortamda kabuk komutlarını yürütmesine izin veren bir araç.

Name	Türü	Description	Zorunlu	Varsayılan
type	enum	Yerel kabuk aracının türü. Her zaman local_shell. Olası değerler: local_shell	Yes

OpenAI.LogProb

Belirtecin logaritmik olasılığı.

Name	Türü	Description	Zorunlu	Varsayılan
bytes	OpenAI.integer dizisi		Yes
logprob	OpenAI.numeric		Yes
token	Dize		Yes
top_logprobs	OpenAI.TopLogProb dizisi		Yes

OpenAI.MCPListToolsTool

MCP sunucusunda kullanılabilen bir araç.

Name	Türü	Description	Zorunlu	Varsayılan
annotations	OpenAI.MCPListToolsToolAnnotations (null atanabilir)		Hayır
Açıklama	dize (null atanabilir)		Hayır
input_schema	OpenAI.MCPListToolsToolInputSchema		Yes
name	Dize	Araç adı.	Yes

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 erişim verin. MCP.

Name	Türü	Description	Zorunlu	Varsayılan
izin verilen araçlar	dize dizisi veya OpenAI.MCPToolFilter		Hayır
authorization	Dize	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ır
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ır
headers	object (null atanabilir)		Hayır
project_connection_id	Dize	MCP sunucusunun project 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ır
onay_gerektir	object (aşağıdaki geçerli modellere bakın)		Hayır
server_description	Dize	MCP sunucusunun isteğe bağlı açıklaması, daha fazla bağlam sağlamak için kullanılır.	Hayır
sunucu etiketi	Dize	Bu MCP sunucusu için araç çağrılarında tanımlamak için kullanılan bir etiket.	Yes
sunucu_url	Dize	MCP sunucusunun URL'si. server_url Bunlardan biri veya connector_id olması gerekir Sağlanan.	Hayır
type	enum	MCP aracının türü. Her zaman mcp. Olası değerler: mcp	Yes

OpenAI.MCPToolCallStatus

Property	Değer
Türü	Dize
Değerler	in_progress completed incomplete calling failed

OpenAI.MCPToolFilter

Hangi araçların izin verildiğini belirtmek için bir filtre nesnesi.

Name	Türü	Description	Zorunlu	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ır
tool_names	dize dizisi	İzin verilen araç adlarının listesi.	Hayır

OpenAI.MCPToolRequireApproval

Name	Türü	Description	Zorunlu	Varsayılan
always	OpenAI.MCPToolFilter	Hangi araçların izin verildiğini belirtmek için bir filtre nesnesi.	Hayır
hiç	OpenAI.MCPToolFilter	Hangi araçların izin verildiğini belirtmek için bir filtre nesnesi.	Hayır

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	Schema
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

Name	Türü	Description	Zorunlu	Varsayılan
type	OpenAI.MessageContentType		Yes

OpenAI.MessageContentInputFileContent

Modele bir dosya girişi.

Name	Türü	Description	Zorunlu	Varsayılan
file_data	Dize	Modele gönderilecek dosyanın içeriği.	Hayır
dosya_kimlik	dize (null atanabilir)		Hayır
file_url	Dize	Modele gönderilecek dosyanın URL'si.	Hayır
filename	Dize	Modele gönderilecek dosyanın adı.	Hayır
type	enum	Giriş öğesinin türü. Her zaman input_file. Olası değerler: input_file	Yes

OpenAI.MessageContentInputImageContent

Modele bir görüntü girişi. image girişleri hakkında bilgi edinin.

Name	Türü	Description	Zorunlu	Varsayılan
detail	OpenAI.ImageDetail		Yes
dosya_kimlik	dize (null atanabilir)		Hayır
image_url	Dize		Hayır
type	enum	Giriş öğesinin türü. Her zaman input_image. Olası değerler: input_image	Yes

OpenAI.MessageContentInputTextContent

Modele metin girişi.

Name	Türü	Description	Zorunlu	Varsayılan
text	Dize	Modele metin girişi.	Yes
type	enum	Giriş öğesinin türü. Her zaman input_text. Olası değerler: input_text	Yes

OpenAI.MessageContentOutputTextContent

Modelden bir metin çıktısı.

Name	Türü	Description	Zorunlu	Varsayılan
annotations	OpenAI.Annotation dizisi	Metin çıkışının ek açıklamaları.	Yes
logprobs	OpenAI.LogProb dizisi		Hayır
text	Dize	Modelden metin çıkışı.	Yes
type	enum	Çıkış metninin türü. Her zaman output_text. Olası değerler: output_text	Yes

OpenAI.MessageContentReasoningTextContent

Modelden mantık metni.

Name	Türü	Description	Zorunlu	Varsayılan
text	Dize	Modelden gelen mantık metni.	Yes
type	enum	Akıl yürütme metninin türü. Her zaman reasoning_text. Olası değerler: reasoning_text	Yes

OpenAI.MessageContentRefusalContent

Model tarafından reddedilme.

Name	Türü	Description	Zorunlu	Varsayılan
Ret	Dize	Modelin sunduğu reddetme gerekçesi.	Yes
type	enum	Reddetmenin türü. Her zaman refusal. Olası değerler: refusal	Yes

OpenAI.MessageContentType

Property	Değer
Türü	Dize
Değerler	input_text output_text text summary_text reasoning_text refusal input_image computer_screenshot input_file

OpenAI.MessageRole

Property	Değer
Türü	Dize
Değerler	unknown user assistant system critic discriminator developer tool

OpenAI.MessageStatus

Property	Değer
Türü	Dize
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

Property	Değer
Türü	Dize
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.

Name	Türü	Description	Zorunlu	Varsayılan
type	enum	Olay türünü belirtir. Taşıma eylemi için bu özelliği kullanıyor. her zaman move olarak ayarlanır. Olası değerler: move	Yes
x	OpenAI.integer		Yes
y	OpenAI.integer		Yes

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	Schema
output_text	OpenAI.OutputContentOutputTextContent
refusal	OpenAI.OutputContentRefusalContent
reasoning_text	OpenAI.OutputContentReasoningTextContent

Name	Türü	Description	Zorunlu	Varsayılan
type	OpenAI.OutputContentType		Yes

OpenAI.OutputContentOutputTextContent

Modelden bir metin çıktısı.

Name	Türü	Description	Zorunlu	Varsayılan
annotations	OpenAI.Annotation dizisi	Metin çıkışının ek açıklamaları.	Yes
logprobs	OpenAI.LogProb dizisi		Hayır
text	Dize	Modelden metin çıkışı.	Yes
type	enum	Çıkış metninin türü. Her zaman output_text. Olası değerler: output_text	Yes

OpenAI.OutputContentReasoningTextContent

Modelden mantık metni.

Name	Türü	Description	Zorunlu	Varsayılan
text	Dize	Modelden gelen mantık metni.	Yes
type	enum	Akıl yürütme metninin türü. Her zaman reasoning_text. Olası değerler: reasoning_text	Yes

OpenAI.OutputContentRefusalContent

Model tarafından reddedilme.

Name	Türü	Description	Zorunlu	Varsayılan
Ret	Dize	Modelin sunduğu reddetme gerekçesi.	Yes
type	enum	Reddetmenin türü. Her zaman refusal. Olası değerler: refusal	Yes

OpenAI.OutputContentType

Property	Değer
Türü	Dize
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	Schema
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

Name	Türü	Description	Zorunlu	Varsayılan
agent_reference	AgentReference		Hayır
└─ ad	Dize	Aracının adı. Kısıtlamalar: maxLength: 256	Yes
└─ türü	enum	Olası değerler: agent_reference	Yes
└─ sürümü	Dize	Aracının sürüm tanımlayıcısı.	Hayır
response_id	Dize	Öğenin oluşturulduğu yanıt.	Hayır
type	OpenAI.OutputItemType		Yes

OpenAI.OutputItemApplyPatchToolCall

Dosya oluşturarak, silerek veya güncelleştirerek dosya farklarını uygulayan bir araç çağrısı.

Name	Türü	Description	Zorunlu	Varsayılan
agent_reference	AgentReference		Hayır
└─ ad	Dize	Aracının adı. Kısıtlamalar: maxLength: 256	Yes
└─ türü	enum	Olası değerler: agent_reference	Yes
└─ sürümü	Dize	Aracının sürüm tanımlayıcısı.	Hayır
call_id	Dize	Model tarafından oluşturulan uygulama yama aracı çağrısının benzersiz kimliği.	Yes
Oluşturan	Dize	Bu araç çağrısını oluşturan varlığın kimliği.	Hayır
kimlik	Dize	Düzeltme eki uygulama aracı çağrısının benzersiz kimliği. Bu öğe, API aracılığıyla iade edildiğinde doldurulur.	Yes
Operasyon	OpenAI.ApplyPatchFileOperation	apply_patch aracılığıyla uygulanan create_file, delete_file veya update_file işlemlerinden biri.	Yes
└─ türü	OpenAI.ApplyPatchFileOperationType		Yes
response_id	Dize	Öğenin oluşturulduğu yanıt.	Hayır
durum	OpenAI.ApplyPatchCallStatus		Yes
type	enum	Öğenin türü. Her zaman apply_patch_call. Olası değerler: apply_patch_call	Yes

OpenAI.OutputItemApplyPatchToolCallOutput

Bir düzeltme eki uygulama aracı çağrısı tarafından yayılan çıkış.

Name	Türü	Description	Zorunlu	Varsayılan
agent_reference	AgentReference		Hayır
└─ ad	Dize	Aracının adı. Kısıtlamalar: maxLength: 256	Yes
└─ türü	enum	Olası değerler: agent_reference	Yes
└─ sürümü	Dize	Aracının sürüm tanımlayıcısı.	Hayır
call_id	Dize	Model tarafından oluşturulan uygulama yama aracı çağrısının benzersiz kimliği.	Yes
Oluşturan	Dize	Bu aracı oluşturan varlığın kimliği çağrı çıktısı.	Hayır
kimlik	Dize	Düzeltme eki uygulama aracı çağrı çıkışının benzersiz kimliği. Bu öğe, API aracılığıyla iade edildiğinde doldurulur.	Yes
output	dize (null atanabilir)		Hayır
response_id	Dize	Öğenin oluşturulduğu yanıt.	Hayır
durum	OpenAI.ApplyPatchCallOutputStatus		Yes
type	enum	Öğenin türü. Her zaman apply_patch_call_output. Olası değerler: apply_patch_call_output	Yes

OpenAI.OutputItemCodeInterpreterToolCall

Kodu çalıştırmak için bir araç çağrısı.

Name	Türü	Description	Zorunlu	Varsayılan
agent_reference	AgentReference		Hayır
└─ ad	Dize	Aracının adı. Kısıtlamalar: maxLength: 256	Yes
└─ türü	enum	Olası değerler: agent_reference	Yes
└─ sürümü	Dize	Aracının sürüm tanımlayıcısı.	Hayır
code	dize (null atanabilir)		Yes
container_id	Dize	Kodu çalıştırmak için kullanılan kapsayıcının kimliği.	Yes
kimlik	Dize	Kod yorumlayıcısı araç çağrısının benzersiz kimliği.	Yes
outputs	OpenAI.CodeInterpreterOutputLogs veya OpenAI.CodeInterpreterOutputImage dizisi		Yes
response_id	Dize	Öğenin oluşturulduğu yanıt.	Hayır
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	Yes
type	enum	Kod yorumlayıcı aracı çağrısının türü. Her zaman code_interpreter_call. Olası değerler: code_interpreter_call	Yes

OpenAI.OutputItemCompactionBody

API tarafından v1/responses/compactoluşturulan bir sıkıştırma öğesi.

Name	Türü	Description	Zorunlu	Varsayılan
agent_reference	AgentReference		Hayır
└─ ad	Dize	Aracının adı. Kısıtlamalar: maxLength: 256	Yes
└─ türü	enum	Olası değerler: agent_reference	Yes
└─ sürümü	Dize	Aracının sürüm tanımlayıcısı.	Hayır
Oluşturan	Dize	Öğeyi oluşturan aktörün tanımlayıcısı.	Hayır
encrypted_content	Dize	Sıkıştırma tarafından oluşturulan şifrelenmiş içerik.	Yes
kimlik	Dize	Sıkıştırma öğesinin benzersiz kimliği.	Yes
response_id	Dize	Öğenin oluşturulduğu yanıt.	Hayır
type	enum	Öğenin türü. Her zaman compaction. Olası değerler: compaction	Yes

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.

Name	Türü	Description	Zorunlu	Varsayılan
action	OpenAI.ComputerAction		Yes
agent_reference	AgentReference		Hayır
└─ ad	Dize	Aracının adı. Kısıtlamalar: maxLength: 256	Yes
└─ türü	enum	Olası değerler: agent_reference	Yes
└─ sürümü	Dize	Aracının sürüm tanımlayıcısı.	Hayır
call_id	Dize	Çıkış verisi ile araç çağrısına yanıt verirken kullanılan tanımlayıcı.	Yes
kimlik	Dize	Bilgisayar çağrısının benzersiz tanımlayıcısı.	Yes
pending_safety_checks	OpenAI.ComputerCallSafetyCheckParam dizisi	Bilgisayar çağrısı için bekleyen güvenlik denetimleri.	Yes
response_id	Dize	Öğenin oluşturulduğu yanıt.	Hayır
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	Yes
type	enum	Bilgisayar çağrısının türü. Her zaman computer_call. Olası değerler: computer_call	Yes

OpenAI.OutputItemCustomToolCall

Model tarafından oluşturulan özel bir araca çağrı.

Name	Türü	Description	Zorunlu	Varsayılan
agent_reference	AgentReference		Hayır
└─ ad	Dize	Aracının adı. Kısıtlamalar: maxLength: 256	Yes
└─ türü	enum	Olası değerler: agent_reference	Yes
└─ sürümü	Dize	Aracının sürüm tanımlayıcısı.	Hayır
call_id	Dize	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ı.	Yes
kimlik	Dize	OpenAI platformundaki özel araç çağrısının benzersiz kimliği.	Hayır
input	Dize	Model tarafından oluşturulan özel araç çağrısı için girdi.	Yes
name	Dize	Çağrılan özel aracın adı.	Yes
response_id	Dize	Öğenin oluşturulduğu yanıt.	Hayır
type	enum	Özel araç çağrısının türü. Her zaman custom_tool_call. Olası değerler: custom_tool_call	Yes

OpenAI.OutputItemFileSearchToolCall

Dosya arama aracı çağrısının sonuçları. Daha fazla bilgi için dosya arama rehberi adresine bakınız.

Name	Türü	Description	Zorunlu	Varsayılan
agent_reference	AgentReference		Hayır
└─ ad	Dize	Aracının adı. Kısıtlamalar: maxLength: 256	Yes
└─ türü	enum	Olası değerler: agent_reference	Yes
└─ sürümü	Dize	Aracının sürüm tanımlayıcısı.	Hayır
kimlik	Dize	Dosya arama aracı çağrısının benzersiz kimliği.	Yes
queries	dize dizisi	Dosyaları aramak için kullanılan sorgular.	Yes
response_id	Dize	Öğenin oluşturulduğu yanıt.	Hayır
results	OpenAI.FileSearchToolCallResults dizisi		Hayır
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	Yes
type	enum	Dosya arama aracı çağrısının türü. Her zaman file_search_call. Olası değerler: file_search_call	Yes

OpenAI.OutputItemFunctionShellCall

Yönetilen bir ortamda bir veya daha fazla kabuk komutu yürüten bir araç çağrısı.

Name	Türü	Description	Zorunlu	Varsayılan
action	OpenAI.FunctionShellAction	Bir kabuk komutu yürütür.	Yes
└─ komutları	dize dizisi		Yes
└─ max_output_length	OpenAI.integer (null atanabilir)		Yes
└─ timeout_ms	OpenAI.integer (null atanabilir)		Yes
agent_reference	AgentReference		Hayır
└─ ad	Dize	Aracının adı. Kısıtlamalar: maxLength: 256	Yes
└─ türü	enum	Olası değerler: agent_reference	Yes
└─ sürümü	Dize	Aracının sürüm tanımlayıcısı.	Hayır
call_id	Dize	Model tarafından oluşturulan shell araç çağrısının benzersiz kimliği.	Yes
Oluşturan	Dize	Bu araç çağrısını oluşturan varlığın kimliği.	Hayır
kimlik	Dize	Kabuk aracı çağrısının benzersiz kimliği. Bu öğe, API aracılığıyla iade edildiğinde doldurulur.	Yes
response_id	Dize	Öğenin oluşturulduğu yanıt.	Hayır
durum	OpenAI.LocalShellCallStatus		Yes
type	enum	Öğenin türü. Her zaman shell_call. Olası değerler: shell_call	Yes

OpenAI.OutputItemFunctionShellCallOutput

Yayılan bir kabuk aracı çağrısının çıktısı.

Name	Türü	Description	Zorunlu	Varsayılan
agent_reference	AgentReference		Hayır
└─ ad	Dize	Aracının adı. Kısıtlamalar: maxLength: 256	Yes
└─ türü	enum	Olası değerler: agent_reference	Yes
└─ sürümü	Dize	Aracının sürüm tanımlayıcısı.	Hayır
call_id	Dize	Model tarafından oluşturulan shell araç çağrısının benzersiz kimliği.	Yes
Oluşturan	Dize	Öğeyi oluşturan aktörün tanımlayıcısı.	Hayır
kimlik	Dize	Kabuk çağrısı çıkışının benzersiz kimliği. Bu öğe, API aracılığıyla iade edildiğinde doldurulur.	Yes
max_output_length	OpenAI.integer (null atanabilir)		Yes
output	OpenAI.FunctionShellCallOutputContent dizisi	Kabuk çağrısı çıkış içeriği dizisi	Yes
response_id	Dize	Öğenin oluşturulduğu yanıt.	Hayır
type	enum	Kabuk çağrısı çıkışının türü. Her zaman shell_call_output. Olası değerler: shell_call_output	Yes

OpenAI.OutputItemFunctionToolCall

Bir fonksiyonu çalıştırmak için bir araç çağrısı. Daha fazla bilgi için işlev çağırma kılavuzuna bakın.

Name	Türü	Description	Zorunlu	Varsayılan
agent_reference	AgentReference		Hayır
└─ ad	Dize	Aracının adı. Kısıtlamalar: maxLength: 256	Yes
└─ türü	enum	Olası değerler: agent_reference	Yes
└─ sürümü	Dize	Aracının sürüm tanımlayıcısı.	Hayır
arguments	Dize	İşleve geçirecek bağımsız değişkenlerin JSON dizesi.	Yes
call_id	Dize	Model tarafından oluşturulan işlev aracı çağrısının benzersiz kimliği.	Yes
kimlik	Dize	İşlev aracı çağrısının benzersiz kimliği.	Hayır
name	Dize	Çalıştırılacak işlevin adı.	Yes
response_id	Dize	Öğenin oluşturulduğu yanıt.	Hayır
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ır
type	enum	İşlev aracı çağrısının türü. Her zaman function_call. Olası değerler: function_call	Yes

OpenAI.OutputItemImageGenToolCall

Model tarafından yapılan bir görüntü oluşturma isteği.

Name	Türü	Description	Zorunlu	Varsayılan
agent_reference	AgentReference		Hayır
└─ ad	Dize	Aracının adı. Kısıtlamalar: maxLength: 256	Yes
└─ türü	enum	Olası değerler: agent_reference	Yes
└─ sürümü	Dize	Aracının sürüm tanımlayıcısı.	Hayır
kimlik	Dize	Görüntü oluşturma çağrısının benzersiz kimliği.	Yes
response_id	Dize	Öğenin oluşturulduğu yanıt.	Hayır
result	dize (null atanabilir)		Yes
durum	enum	Görüntü oluşturma çağrısının durumu. Olası değerler: in_progress, completed, generating, failed	Yes
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	Yes

OpenAI.OutputItemLocalShellToolCall

Yerel kabukta komut çalıştırmak için bir araç çağrısı.

Name	Türü	Description	Zorunlu	Varsayılan
action	OpenAI.LocalShellExecAction	Sunucuda bir shell komutu çalıştırın.	Yes
agent_reference	AgentReference		Hayır
└─ ad	Dize	Aracının adı. Kısıtlamalar: maxLength: 256	Yes
└─ türü	enum	Olası değerler: agent_reference	Yes
└─ sürümü	Dize	Aracının sürüm tanımlayıcısı.	Hayır
call_id	Dize	Model tarafından oluşturulan yerel kabuk aracı çağrısının benzersiz kimliği.	Yes
kimlik	Dize	Yerel shell çağrısının benzersiz kimliği.	Yes
response_id	Dize	Öğenin oluşturulduğu yanıt.	Hayır
durum	enum	Yerel shell çağrısının durumu. Olası değerler: in_progress, completed, incomplete	Yes
type	enum	Yerel shell call'ın türü. Her zaman local_shell_call. Olası değerler: local_shell_call	Yes

OpenAI.OutputItemMcpApprovalRequest

Bir araç çağrısı işlemi için insan onayı isteği.

Name	Türü	Description	Zorunlu	Varsayılan
agent_reference	AgentReference		Hayır
└─ ad	Dize	Aracının adı. Kısıtlamalar: maxLength: 256	Yes
└─ türü	enum	Olası değerler: agent_reference	Yes
└─ sürümü	Dize	Aracının sürüm tanımlayıcısı.	Hayır
arguments	Dize	Araç için bir JSON bağımsız değişken dizesi.	Yes
kimlik	Dize	Onay talebinin benzersiz kimliği.	Yes
name	Dize	Çalıştırılacak aracın adı.	Yes
response_id	Dize	Öğenin oluşturulduğu yanıt.	Hayır
sunucu etiketi	Dize	İsteği yapan MCP sunucusunun etiketi.	Yes
type	enum	Öğenin türü. Her zaman mcp_approval_request. Olası değerler: mcp_approval_request	Yes

OpenAI.OutputItemMcpListTools

MCP sunucusunda kullanılabilen araçların listesi.

Name	Türü	Description	Zorunlu	Varsayılan
agent_reference	AgentReference		Hayır
└─ ad	Dize	Aracının adı. Kısıtlamalar: maxLength: 256	Yes
└─ türü	enum	Olası değerler: agent_reference	Yes
└─ sürümü	Dize	Aracının sürüm tanımlayıcısı.	Hayır
hata	dize (null atanabilir)		Hayır
kimlik	Dize	Listenin benzersiz kimliği.	Yes
response_id	Dize	Öğenin oluşturulduğu yanıt.	Hayır
sunucu etiketi	Dize	MCP sunucusunun etiketi.	Yes
tools	OpenAI.MCPListToolsTool dizisi	Sunucuda bulunan araçlar.	Yes
type	enum	Öğenin türü. Her zaman mcp_list_tools. Olası değerler: mcp_list_tools	Yes

OpenAI.OutputItemMcpToolCall

MCP sunucusundaki bir aracın çağrılması.

Name	Türü	Description	Zorunlu	Varsayılan
agent_reference	AgentReference		Hayır
└─ ad	Dize	Aracının adı. Kısıtlamalar: maxLength: 256	Yes
└─ türü	enum	Olası değerler: agent_reference	Yes
└─ sürümü	Dize	Aracının sürüm tanımlayıcısı.	Hayır
approval_request_id	dize (null atanabilir)		Hayır
arguments	Dize	Araca geçirilen bağımsız değişkenlerin JSON dizesi.	Yes
hata	dize (null atanabilir)		Hayır
kimlik	Dize	Araç çağrısının benzersiz kimliği.	Yes
name	Dize	Çalıştırılan aracın adı.	Yes
output	dize (null atanabilir)		Hayır
response_id	Dize	Öğenin oluşturulduğu yanıt.	Hayır
sunucu etiketi	Dize	Aracı çalıştıran MCP sunucusunun etiketi.	Yes
durum	OpenAI.MCPToolCallStatus		Hayır
type	enum	Öğenin türü. Her zaman mcp_call. Olası değerler: mcp_call	Yes

OpenAI.OutputItemOutputMessage

Modelden bir çıkış iletisi.

Name	Türü	Description	Zorunlu	Varsayılan
agent_reference	AgentReference		Hayır
└─ ad	Dize	Aracının adı. Kısıtlamalar: maxLength: 256	Yes
└─ türü	enum	Olası değerler: agent_reference	Yes
└─ sürümü	Dize	Aracının sürüm tanımlayıcısı.	Hayır
içerik	OpenAI.OutputMessageContent dizisi	Çıkış iletisinin içeriği.	Yes
kimlik	Dize	Çıkış iletisinin benzersiz kimliği.	Yes
response_id	Dize	Öğenin oluşturulduğu yanıt.	Hayır
role	enum	Çıkış iletisinin rolü. Her zaman assistant. Olası değerler: assistant	Yes
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	Yes
type	enum	Çıkış iletisinin türü. Her zaman message. Olası değerler: output_message	Yes

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 input ile manuel olarak konuşuyorsanız, Responses API'ye hesabınıza dahil edin.

Name	Türü	Description	Zorunlu	Varsayılan
agent_reference	AgentReference		Hayır
└─ ad	Dize	Aracının adı. Kısıtlamalar: maxLength: 256	Yes
└─ türü	enum	Olası değerler: agent_reference	Yes
└─ sürümü	Dize	Aracının sürüm tanımlayıcısı.	Hayır
içerik	OpenAI.ReasoningTextContent dizisi	Metin içeriğini akıl yürütme.	Hayır
encrypted_content	dize (null atanabilir)		Hayır
kimlik	Dize	Akıl yürütme içeriğinin benzersiz tanımlayıcısı.	Yes
response_id	Dize	Öğenin oluşturulduğu yanıt.	Hayır
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ır
summary	OpenAI.Summary dizisi	Akıl yürütme özeti içeriği.	Yes
type	enum	Nesnenin türü. Her zaman reasoning. Olası değerler: reasoning	Yes

OpenAI.OutputItemType

Property	Değer
Türü	Dize
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.

Name	Türü	Description	Zorunlu	Varsayılan
action	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).	Yes
agent_reference	AgentReference		Hayır
└─ ad	Dize	Aracının adı. Kısıtlamalar: maxLength: 256	Yes
└─ türü	enum	Olası değerler: agent_reference	Yes
└─ sürümü	Dize	Aracının sürüm tanımlayıcısı.	Hayır
kimlik	Dize	Web arama aracının benzersiz kimliği çağrı.	Yes
response_id	Dize	Öğenin oluşturulduğu yanıt.	Hayır
durum	enum	Web arama aracı çağrısının durumu. Olası değerler: in_progress, searching, completed, failed	Yes
type	enum	Web arama aracının türü. Her zaman web_search_call. Olası değerler: web_search_call	Yes

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	Schema
output_text	OpenAI.OutputMessageContentOutputTextContent
refusal	OpenAI.OutputMessageContentRefusalContent

Name	Türü	Description	Zorunlu	Varsayılan
type	OpenAI.OutputMessageContentType		Yes

OpenAI.OutputMessageContentOutputTextContent

Modelden bir metin çıktısı.

Name	Türü	Description	Zorunlu	Varsayılan
annotations	OpenAI.Annotation dizisi	Metin çıkışının ek açıklamaları.	Yes
logprobs	OpenAI.LogProb dizisi		Hayır
text	Dize	Modelden metin çıkışı.	Yes
type	enum	Çıkış metninin türü. Her zaman output_text. Olası değerler: output_text	Yes

OpenAI.OutputMessageContentRefusalContent

Model tarafından reddedilme.

Name	Türü	Description	Zorunlu	Varsayılan
Ret	Dize	Modelin sunduğu reddetme gerekçesi.	Yes
type	enum	Reddetmenin türü. Her zaman refusal. Olası değerler: refusal	Yes

OpenAI.OutputMessageContentType

Property	Değer
Türü	Dize
Değerler	output_text refusal

OpenAI.Prompt

Bir komut şablonuna ve değişkenlerine referans. Daha fazla bilgi edinin.

Name	Türü	Description	Zorunlu	Varsayılan
kimlik	Dize	Kullanılacak istem şablonunun benzersiz tanımlayıcısı.	Yes
değişkenler	OpenAI.ResponsePromptVariables (null atanabilir)	Değişkenlerin yerine kullanılmak üzere isteğe bağlı bir değerler haritası Komut 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ır
version	dize (null atanabilir)		Hayır

OpenAI.RankerVersionType

Property	Değer
Türü	Dize
Değerler	auto default-2024-11-15

OpenAI.RankingOptions

Name	Türü	Description	Zorunlu	Varsayılan
hybrid_search	OpenAI.HybridSearchOptions		Hayır
└─ embedding_weight	OpenAI.numeric	Karşılıklı sıralama füzyonundaki gömülen ağırlığı.	Yes
└─ text_weight	OpenAI.numeric	Karşılıklı sıralama birleşimindeki metnin ağırlığı.	Yes
sıralayıcı	OpenAI.RankerVersionType		Hayır
puan_eşik_değeri	OpenAI.numeric		Hayır

OpenAI.Reasoning

Sadece GPT-5 ve O-serisi modelleri Akıl yürütme modelleri için yapılandırma seçenekleri.

Name	Türü	Description	Zorunlu	Varsayılan
effort	OpenAI.ReasoningEffort	Akıl yürütmeye yönelik çabayı kısıtlar mantık 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ır
generate_summary	enum	Olası değerler: auto, concise, detailed	Hayır
summary	enum	Olası değerler: auto, concise, detailed	Hayır

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.

Property	Değer
Türü	Dize
Nullable	Yes
Değerler	none minimal low medium high xhigh

OpenAI.ReasoningTextContent

Modelden mantık metni.

Name	Türü	Description	Zorunlu	Varsayılan
text	Dize	Modelden gelen mantık metni.	Yes
type	enum	Akıl yürütme metninin türü. Her zaman reasoning_text. Olası değerler: reasoning_text	Yes

OpenAI.Response

Name	Türü	Description	Zorunlu	Varsayılan
agent_reference	AgentReference (null atanabilir)		Yes
└─ ad	Dize	Aracının adı. Kısıtlamalar: maxLength: 256	Yes
└─ türü	enum	Olası değerler: agent_reference	Yes
└─ sürümü	Dize	Aracının sürüm tanımlayıcısı.	Hayır
arka plan	boole değeri (null atanabilir)		Hayır
tamamlanma_tarihi	integer		Hayır
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ır
└─ kimlik	Dize	Bu yanıtın ilişkilendirildiği konuşmanın benzersiz kimliği.	Yes
oluşturulma_tarihi	integer	Bu Yanıtın oluşturulduğu unix zaman damgası (saniye).	Yes
hata	OpenAI.ResponseError (null atanabilir)	Model yanıt oluşturamadığında döndürülen bir hata nesnesi.	Yes
└─ kod	OpenAI.ResponseErrorCode	Yanıtın hata kodu.	Yes
└─ ileti	Dize	Hatanın insan tarafından okunabilen açıklaması.	Yes
kimlik	Dize	Bu Yanıt için benzersiz tanımlayıcı.	Yes
incomplete_details	OpenAI.ResponseIncompleteDetails (null atanabilir)		Yes
└─ neden	enum	Olası değerler: max_output_tokens, content_filter	Hayır
instructions	OpenAI.InputItem dizesi veya dizisi		Yes
max_output_tokens	OpenAI.integer (null atanabilir)		Hayır
max_tool_calls	OpenAI.integer (null atanabilir)		Hayır
metadata	OpenAI.Metadata (null atanabilir)	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu olabilir 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ır
model	Dize	Bu yanıtın oluşturulması için kullanılacak model dağıtımı.	Hayır
Obje	enum	Bu kaynağın nesne türü - her zaman response olarak ayarlanır. Olası değerler: response	Yes
output	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.	Yes
output_text	dize (null atanabilir)		Hayır
paralel araç çağrıları	boolean	Modelin araç çağrılarını paralel olarak çalıştırmasına izin verilip verilmeyeceği.	Yes	True
previous_response_id	dize (null atanabilir)		Hayır
prompt	OpenAI.Prompt	Bir komut şablonuna ve değişkenlerine referans. Daha fazla bilgi edinin.	Hayır
prompt_cache_key	Dize	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ır
prompt_cache_retention	enum	Olası değerler: in-memory, 24h	Hayır
reasoning	OpenAI.Reasoning (null atanabilir)	yalnızca gpt-5 ve o serisi modeller İçin yapılandırma seçenekleri mantık modelleri.	Hayır
└─ çaba	OpenAI.ReasoningEffort	Akıl yürütmeye yönelik çabayı kısıtlar mantık 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ır
└─ özet oluştur	enum	Olası değerler: auto, concise, detailed	Hayır
└─ özeti	enum	Olası değerler: auto, concise, detailed	Hayır
safety_identifier	Dize	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ır
hizmet seviyesi	OpenAI.ServiceTier	İsteğin sunulması için kullanılan işleme türünü belirtir. - 'otomatik' olarak ayarlanırsa istek, Project ayarlarında yapılandırılan hizmet katmanıyla işlenir. Aksi yapılandırılmadığı sürece, Project 'default' kullanır. - 'varsayılan' olarak ayarlanırsa, istek seçilen model için standart fiyatlandırma ve performansla işlenir. - 'esnek' veya 'öncelik' olarak ayarlanırsa istek ilgili hizmet katmanıyla işlenir. - 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ır
durum	enum	Yanıt oluşturma durumu. completed'lerden biri, failed in_progress, cancelled, queued veya incomplete. Olası değerler: completed, failed, in_progress, cancelled, , queued, incomplete	Hayır
sıcaklık	OpenAI.numeric (null atanabilir)		Hayır	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ır
tool_choice	OpenAI.ToolChoiceOptions veya OpenAI.ToolChoiceParam		Hayır
tools	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ır
top_logprobs	OpenAI.integer (null atanabilir)		Hayır
top_p	OpenAI.numeric (null atanabilir)		Hayır	1
truncation	enum	Olası değerler: auto, disabled	Hayır
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ır
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ır

OpenAI.ResponseAudioDeltaEvent

Kısmi bir ses yanıtı olduğunda yayılır.

Name	Türü	Description	Zorunlu	Varsayılan
delta	Dize	Base64 kodlanmış yanıt ses baytlarının bir öbeği.	Yes
sequence_number	OpenAI.integer		Yes
type	enum	Olayın türü. Her zaman response.audio.delta. Olası değerler: response.audio.delta	Yes

OpenAI.ResponseAudioDoneEvent

Ses yanıtı tamamlandığında gönderilir.

Name	Türü	Description	Zorunlu	Varsayılan
sequence_number	OpenAI.integer		Yes
type	enum	Olayın türü. Her zaman response.audio.done. Olası değerler: response.audio.done	Yes

OpenAI.ResponseAudioTranscriptDeltaEvent

Sesin kısmi bir transkripti olduğunda yayılır.

Name	Türü	Description	Zorunlu	Varsayılan
delta	Dize	Ses yanıtının kısmi transkripti.	Yes
sequence_number	OpenAI.integer		Yes
type	enum	Olayın türü. Her zaman response.audio.transcript.delta. Olası değerler: response.audio.transcript.delta	Yes

OpenAI.ResponseAudioTranscriptDoneEvent

Tam ses transkripti tamamlandığında gönderilir.

Name	Türü	Description	Zorunlu	Varsayılan
sequence_number	OpenAI.integer		Yes
type	enum	Olayın türü. Her zaman response.audio.transcript.done. Olası değerler: response.audio.transcript.done	Yes

OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent

Kısmi kod parçacığı, kod yorumlayıcı tarafından aktarıldığında yayımlanır.

Name	Türü	Description	Zorunlu	Varsayılan
delta	Dize	Kod yorumlayıcısı tarafından aktarılan kısmi kod parçacığı.	Yes
item_id	Dize	Kod yorumlayıcı aracı çağrı öğesinin benzersiz tanımlayıcısı.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Olayın türü. Her zaman response.code_interpreter_call_code.delta. Olası değerler: response.code_interpreter_call_code.delta	Yes

OpenAI.ResponseCodeInterpreterCallCodeDoneEvent

Kod parçacığı kod yorumlayıcı tarafından sonlandırıldığında tetiklenir.

Name	Türü	Description	Zorunlu	Varsayılan
code	Dize	Kod yorumlayıcısı tarafından son kod parçacığı çıkışı.	Yes
item_id	Dize	Kod yorumlayıcı aracı çağrı öğesinin benzersiz tanımlayıcısı.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Olayın türü. Her zaman response.code_interpreter_call_code.done. Olası değerler: response.code_interpreter_call_code.done	Yes

OpenAI.ResponseCodeInterpreterCallCompletedEvent

Kod yorumlayıcı çağrısı tamamlandığında gönderilir.

Name	Türü	Description	Zorunlu	Varsayılan
item_id	Dize	Kod yorumlayıcı aracı çağrı öğesinin benzersiz tanımlayıcısı.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Olayın türü. Her zaman response.code_interpreter_call.completed. Olası değerler: response.code_interpreter_call.completed	Yes

OpenAI.ResponseCodeInterpreterCallInProgressEvent

Bir kod yorumlayıcı çağrısı sırasında tetiklenir.

Name	Türü	Description	Zorunlu	Varsayılan
item_id	Dize	Kod yorumlayıcı aracı çağrı öğesinin benzersiz tanımlayıcısı.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Olayın türü. Her zaman response.code_interpreter_call.in_progress. Olası değerler: response.code_interpreter_call.in_progress	Yes

OpenAI.ResponseCodeInterpreterCallInterpretingEvent

Kod yorumlayıcısı kod parçacığını etkin bir şekilde yorumladığında yayılır.

Name	Türü	Description	Zorunlu	Varsayılan
item_id	Dize	Kod yorumlayıcı aracı çağrı öğesinin benzersiz tanımlayıcısı.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Olayın türü. Her zaman response.code_interpreter_call.interpreting. Olası değerler: response.code_interpreter_call.interpreting	Yes

OpenAI.ResponseCompletedEvent

Model yanıtı tamamlandığında gönderilir.

Name	Türü	Description	Zorunlu	Varsayılan
response	OpenAI.Response		Yes
└─ agent_reference	AgentReference (null atanabilir)	Bu yanıt için kullanılan aracı	Yes
└─ arka plan	boole değeri (null atanabilir)		Hayır
└─ completed_at	integer (null atanabilir)		Hayır
└─ 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ır
└─ oluşturulma_tarihi	integer	Bu Yanıtın oluşturulduğu unix zaman damgası (saniye).	Yes
└─ hata	OpenAI.ResponseError (null atanabilir)	Model yanıt oluşturamadığında döndürülen bir hata nesnesi.	Yes
└─ kimlik	Dize	Bu Yanıt için benzersiz tanımlayıcı.	Yes
└─ eksik_bilgiler	OpenAI.ResponseIncompleteDetails (null atanabilir)		Yes
└─ yönerge	OpenAI.InputItem dizesi veya dizisi (null atanabilir)		Yes
└─ maksimum_çıkış_jetonları	OpenAI.integer (null atanabilir)		Hayır
└─ maksimum araç çağrıları	OpenAI.integer (null atanabilir)		Hayır
└─ meta veriler	OpenAI.Metadata (null atanabilir)	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu olabilir 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ır
└─ modeli	Dize	Bu yanıtın oluşturulması için kullanılacak model dağıtımı.	Hayır
└─ nesne	enum	Bu kaynağın nesne türü - her zaman response olarak ayarlanır. Olası değerler: response	Yes
└─ çı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.	Yes
└─ çıktı_metin	dize (null atanabilir)		Hayır
└─ paralel_arac_cagrilari	boolean	Modelin araç çağrılarını paralel olarak çalıştırmasına izin verilip verilmeyeceği.	Yes	True
└─ önceki_cevap_id	dize (null atanabilir)		Hayır
└─ istemi	OpenAI.Prompt	Bir komut şablonuna ve değişkenlerine referans. Daha fazla bilgi edinin.	Hayır
└─ prompt_cache_key	Dize	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ır
└─ prompt_cache_retention	enum	Olası değerler: in-memory, 24h	Hayır
└─ akıl yürütme	OpenAI.Reasoning (null atanabilir)	yalnızca gpt-5 ve o serisi modeller İçin yapılandırma seçenekleri mantık modelleri.	Hayır
└─ safety_identifier	Dize	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ır
└─ service_tier	OpenAI.ServiceTier	İsteğin sunulması için kullanılan işleme türünü belirtir. - 'otomatik' olarak ayarlanırsa istek, Project ayarlarında yapılandırılan hizmet katmanıyla işlenir. Aksi yapılandırılmadığı sürece, Project 'default' kullanır. - 'varsayılan' olarak ayarlanırsa, istek seçilen model için standart fiyatlandırma ve performansla işlenir. - 'esnek' veya 'öncelik' olarak ayarlanırsa istek ilgili hizmet katmanıyla işlenir. - 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ır
└─ durumu	enum	Yanıt oluşturma durumu. completed'lerden biri, failed in_progress, cancelled, queued veya incomplete. Olası değerler: completed, failed, in_progress, cancelled, , queued, incomplete	Hayır
└─ sıcaklık	OpenAI.numeric (null atanabilir)		Hayır	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ır
└─ araç seçimi	OpenAI.ToolChoiceOptions veya OpenAI.ToolChoiceParam		Hayır
└─ 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ır
└─ top_logprobs	OpenAI.integer (null atanabilir)		Hayır
└─ top_p	OpenAI.numeric (null atanabilir)		Hayır	1
└─ kısaltma	enum	Olası değerler: auto, disabled	Hayır
└─ 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ır
└─ 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ır
sequence_number	OpenAI.integer		Yes
type	enum	Olayın türü. Her zaman response.completed. Olası değerler: response.completed	Yes

OpenAI.ResponseContentPartAddedEvent

Yeni bir içerik bölümü eklendiğinde gönderilir.

Name	Türü	Description	Zorunlu	Varsayılan
content_index	OpenAI.integer		Yes
item_id	Dize	İçerik bölümünün eklendiği çıkış öğesinin kimliği.	Yes
output_index	OpenAI.integer		Yes
parça	OpenAI.OutputContent		Yes
└─ türü	OpenAI.OutputContentType		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Olayın türü. Her zaman response.content_part.added. Olası değerler: response.content_part.added	Yes

OpenAI.ResponseContentPartDoneEvent

İçerik bölümü tamamlandığında gönderilir.

Name	Türü	Description	Zorunlu	Varsayılan
content_index	OpenAI.integer		Yes
item_id	Dize	İçerik bölümünün eklendiği çıkış öğesinin kimliği.	Yes
output_index	OpenAI.integer		Yes
parça	OpenAI.OutputContent		Yes
└─ türü	OpenAI.OutputContentType		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Olayın türü. Her zaman response.content_part.done. Olası değerler: response.content_part.done	Yes

OpenAI.ResponseCreatedEvent

Bir yanıt oluşturulduğunda yayılan bir olay.

Name	Türü	Description	Zorunlu	Varsayılan
response	OpenAI.Response		Yes
└─ agent_reference	AgentReference (null atanabilir)	Bu yanıt için kullanılan aracı	Yes
└─ arka plan	boole değeri (null atanabilir)		Hayır
└─ completed_at	integer (null atanabilir)		Hayır
└─ 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ır
└─ oluşturulma_tarihi	integer	Bu Yanıtın oluşturulduğu unix zaman damgası (saniye).	Yes
└─ hata	OpenAI.ResponseError (null atanabilir)	Model yanıt oluşturamadığında döndürülen bir hata nesnesi.	Yes
└─ kimlik	Dize	Bu Yanıt için benzersiz tanımlayıcı.	Yes
└─ eksik_bilgiler	OpenAI.ResponseIncompleteDetails (null atanabilir)		Yes
└─ yönerge	OpenAI.InputItem dizesi veya dizisi (null atanabilir)		Yes
└─ maksimum_çıkış_jetonları	OpenAI.integer (null atanabilir)		Hayır
└─ maksimum araç çağrıları	OpenAI.integer (null atanabilir)		Hayır
└─ meta veriler	OpenAI.Metadata (null atanabilir)	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu olabilir 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ır
└─ modeli	Dize	Bu yanıtın oluşturulması için kullanılacak model dağıtımı.	Hayır
└─ nesne	enum	Bu kaynağın nesne türü - her zaman response olarak ayarlanır. Olası değerler: response	Yes
└─ çı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.	Yes
└─ çıktı_metin	dize (null atanabilir)		Hayır
└─ paralel_arac_cagrilari	boolean	Modelin araç çağrılarını paralel olarak çalıştırmasına izin verilip verilmeyeceği.	Yes	True
└─ önceki_cevap_id	dize (null atanabilir)		Hayır
└─ istemi	OpenAI.Prompt	Bir komut şablonuna ve değişkenlerine referans. Daha fazla bilgi edinin.	Hayır
└─ prompt_cache_key	Dize	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ır
└─ prompt_cache_retention	enum	Olası değerler: in-memory, 24h	Hayır
└─ akıl yürütme	OpenAI.Reasoning (null atanabilir)	yalnızca gpt-5 ve o serisi modeller İçin yapılandırma seçenekleri mantık modelleri.	Hayır
└─ safety_identifier	Dize	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ır
└─ service_tier	OpenAI.ServiceTier	İsteğin sunulması için kullanılan işleme türünü belirtir. - 'otomatik' olarak ayarlanırsa istek, Project ayarlarında yapılandırılan hizmet katmanıyla işlenir. Aksi yapılandırılmadığı sürece, Project 'default' kullanır. - 'varsayılan' olarak ayarlanırsa, istek seçilen model için standart fiyatlandırma ve performansla işlenir. - 'esnek' veya 'öncelik' olarak ayarlanırsa istek ilgili hizmet katmanıyla işlenir. - 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ır
└─ durumu	enum	Yanıt oluşturma durumu. completed'lerden biri, failed in_progress, cancelled, queued veya incomplete. Olası değerler: completed, failed, in_progress, cancelled, , queued, incomplete	Hayır
└─ sıcaklık	OpenAI.numeric (null atanabilir)		Hayır	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ır
└─ araç seçimi	OpenAI.ToolChoiceOptions veya OpenAI.ToolChoiceParam		Hayır
└─ 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ır
└─ top_logprobs	OpenAI.integer (null atanabilir)		Hayır
└─ top_p	OpenAI.numeric (null atanabilir)		Hayır	1
└─ kısaltma	enum	Olası değerler: auto, disabled	Hayır
└─ 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ır
└─ 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ır
sequence_number	OpenAI.integer		Yes
type	enum	Olayın türü. Her zaman response.created. Olası değerler: response.created	Yes

OpenAI.ResponseCustomToolCallInputDeltaEvent

Özel bir araç çağrısının girişine delta (kısmi güncelleştirme) temsil eden olay.

Name	Türü	Description	Zorunlu	Varsayılan
delta	Dize	Özel araç çağrısı için artımlı giriş verileri (delta).	Yes
item_id	Dize	Bu olayla ilişkili API öğesinin benzersiz tanımlayıcısı.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Olay türü tanımlayıcısı. Olası değerler: response.custom_tool_call_input.delta	Yes

OpenAI.ResponseCustomToolCallInputDoneEvent

Özel bir araç çağrısı için girişin tamamlandığını belirten olay.

Name	Türü	Description	Zorunlu	Varsayılan
input	Dize	Özel araç çağrısı için tam giriş verileri.	Yes
item_id	Dize	Bu olayla ilişkili API öğesinin benzersiz tanımlayıcısı.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Olay türü tanımlayıcısı. Olası değerler: response.custom_tool_call_input.done	Yes

OpenAI.ResponseError

Model yanıt oluşturamadığında döndürülen bir hata nesnesi.

Name	Türü	Description	Zorunlu	Varsayılan
code	OpenAI.ResponseErrorCode	Yanıtın hata kodu.	Yes
message	Dize	Hatanın insan tarafından okunabilen açıklaması.	Yes

OpenAI.ResponseErrorCode

Yanıtın hata kodu.

Property	Değer
Türü	Dize
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.

Name	Türü	Description	Zorunlu	Varsayılan
code	dize (null atanabilir)		Yes
message	Dize	Hata iletisi.	Yes
param	dize (null atanabilir)		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Olayın türü. Her zaman error. Olası değerler: error	Yes

OpenAI.ResponseFailedEvent

Yanıt başarısız olduğunda yayılan bir olay.

Name	Türü	Description	Zorunlu	Varsayılan
response	OpenAI.Response		Yes
└─ agent_reference	AgentReference (null atanabilir)	Bu yanıt için kullanılan aracı	Yes
└─ arka plan	boole değeri (null atanabilir)		Hayır
└─ completed_at	integer (null atanabilir)		Hayır
└─ 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ır
└─ oluşturulma_tarihi	integer	Bu Yanıtın oluşturulduğu unix zaman damgası (saniye).	Yes
└─ hata	OpenAI.ResponseError (null atanabilir)	Model yanıt oluşturamadığında döndürülen bir hata nesnesi.	Yes
└─ kimlik	Dize	Bu Yanıt için benzersiz tanımlayıcı.	Yes
└─ eksik_bilgiler	OpenAI.ResponseIncompleteDetails (null atanabilir)		Yes
└─ yönerge	OpenAI.InputItem dizesi veya dizisi (null atanabilir)		Yes
└─ maksimum_çıkış_jetonları	OpenAI.integer (null atanabilir)		Hayır
└─ maksimum araç çağrıları	OpenAI.integer (null atanabilir)		Hayır
└─ meta veriler	OpenAI.Metadata (null atanabilir)	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu olabilir 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ır
└─ modeli	Dize	Bu yanıtın oluşturulması için kullanılacak model dağıtımı.	Hayır
└─ nesne	enum	Bu kaynağın nesne türü - her zaman response olarak ayarlanır. Olası değerler: response	Yes
└─ çı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.	Yes
└─ çıktı_metin	dize (null atanabilir)		Hayır
└─ paralel_arac_cagrilari	boolean	Modelin araç çağrılarını paralel olarak çalıştırmasına izin verilip verilmeyeceği.	Yes	True
└─ önceki_cevap_id	dize (null atanabilir)		Hayır
└─ istemi	OpenAI.Prompt	Bir komut şablonuna ve değişkenlerine referans. Daha fazla bilgi edinin.	Hayır
└─ prompt_cache_key	Dize	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ır
└─ prompt_cache_retention	enum	Olası değerler: in-memory, 24h	Hayır
└─ akıl yürütme	OpenAI.Reasoning (null atanabilir)	yalnızca gpt-5 ve o serisi modeller İçin yapılandırma seçenekleri mantık modelleri.	Hayır
└─ safety_identifier	Dize	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ır
└─ service_tier	OpenAI.ServiceTier	İsteğin sunulması için kullanılan işleme türünü belirtir. - 'otomatik' olarak ayarlanırsa istek, Project ayarlarında yapılandırılan hizmet katmanıyla işlenir. Aksi yapılandırılmadığı sürece, Project 'default' kullanır. - 'varsayılan' olarak ayarlanırsa, istek seçilen model için standart fiyatlandırma ve performansla işlenir. - 'esnek' veya 'öncelik' olarak ayarlanırsa istek ilgili hizmet katmanıyla işlenir. - 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ır
└─ durumu	enum	Yanıt oluşturma durumu. completed'lerden biri, failed in_progress, cancelled, queued veya incomplete. Olası değerler: completed, failed, in_progress, cancelled, , queued, incomplete	Hayır
└─ sıcaklık	OpenAI.numeric (null atanabilir)		Hayır	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ır
└─ araç seçimi	OpenAI.ToolChoiceOptions veya OpenAI.ToolChoiceParam		Hayır
└─ 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ır
└─ top_logprobs	OpenAI.integer (null atanabilir)		Hayır
└─ top_p	OpenAI.numeric (null atanabilir)		Hayır	1
└─ kısaltma	enum	Olası değerler: auto, disabled	Hayır
└─ 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ır
└─ 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ır
sequence_number	OpenAI.integer		Yes
type	enum	Olayın türü. Her zaman response.failed. Olası değerler: response.failed	Yes

OpenAI.ResponseFileSearchCallCompletedEvent

Bir dosya arama çağrısı tamamlandığında (sonuçlar bulundu) yayılır.

Name	Türü	Description	Zorunlu	Varsayılan
item_id	Dize	Dosya arama çağrısının başlatıldığı çıkış öğesinin kimliği.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Olayın türü. Her zaman response.file_search_call.completed. Olası değerler: response.file_search_call.completed	Yes

OpenAI.ResponseFileSearchCallInProgressEvent

Bir dosya arama çağrısı başlatıldığında gönderilir.

Name	Türü	Description	Zorunlu	Varsayılan
item_id	Dize	Dosya arama çağrısının başlatıldığı çıkış öğesinin kimliği.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Olayın türü. Her zaman response.file_search_call.in_progress. Olası değerler: response.file_search_call.in_progress	Yes

OpenAI.ResponseFileSearchCallSearchingEvent

Bir dosya araması sırasında arama yapıldığında tetiklenir.

Name	Türü	Description	Zorunlu	Varsayılan
item_id	Dize	Dosya arama çağrısının başlatıldığı çıkış öğesinin kimliği.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Olayın türü. Her zaman response.file_search_call.searching. Olası değerler: response.file_search_call.searching	Yes

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ı iletisi olmadan JSON oluşturmayacağını unutmayın.

Name	Türü	Description	Zorunlu	Varsayılan
type	enum	Tanımlanan yanıt biçiminin türü. Her zaman json_object. Olası değerler: json_object	Yes

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.

Name	Türü	Description	Zorunlu	Varsayılan
json şeması	OpenAI.ResponseFormatJsonSchemaJsonSchema		Yes
└─ açıklama	Dize		Hayır
└─ ad	Dize		Yes
└─ ş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ır
└─ katı	boole değeri (null atanabilir)		Hayır
type	enum	Tanımlanan yanıt biçiminin türü. Her zaman json_schema. Olası değerler: json_schema	Yes

OpenAI.ResponseFormatJsonSchemaJsonSchema

Name	Türü	Description	Zorunlu	Varsayılan
Açıklama	Dize		Hayır
name	Dize		Yes
schema	OpenAI.YanıtFormatıJsonŞemaŞeması	JSON Şeması nesnesi olarak tanımlanan yanıt biçimi şeması. JSON şemaları oluşturmayı buradan öğrenin.	Hayır
Kesin	boole değeri (null atanabilir)		Hayır

OpenAI.YanıtFormatıJsonŞ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.

Name	Türü	Description	Zorunlu	Varsayılan
type	enum	Tanımlanan yanıt biçiminin türü. Her zaman text. Olası değerler: text	Yes

OpenAI.ResponseFunctionCallArgumentsDeltaEvent

Kısmi işlev çağrısı bağımsız değişkenleri delta olduğunda yayılır.

Name	Türü	Description	Zorunlu	Varsayılan
delta	Dize	Fonksiyon çağrısı argümanlarına eklenen delta.	Yes
item_id	Dize	delta işlev çağrısı bağımsız değişkenlerinin eklendiği çıkış öğesinin kimliği.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Olayın türü. Her zaman response.function_call_arguments.delta. Olası değerler: response.function_call_arguments.delta	Yes

OpenAI.ResponseFunctionCallArgumentsDoneEvent

İşlev çağrısı bağımsız değişkenleri sonlandırıldığında verilir.

Name	Türü	Description	Zorunlu	Varsayılan
arguments	Dize	İşlev çağrısı için argümanlar.	Yes
item_id	Dize	Öğenin kimliği.	Yes
name	Dize	Çağrılan etkinliğin adı.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Olası değerler: response.function_call_arguments.done	Yes

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.

Name	Türü	Description	Zorunlu	Varsayılan
item_id	Dize	İşlenmekte olan görüntü oluşturma öğesinin benzersiz tanımlayıcısı.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Olayın türü. Her zaman 'response.image_generation_call.completed' şeklinde. Olası değerler: response.image_generation_call.completed	Yes

OpenAI.ResponseImageGenCallGeneratingEvent

Görüntü oluşturma aracı çağrısı (ara durum) etkin bir şekilde görüntü oluştururken tetiklenir.

Name	Türü	Description	Zorunlu	Varsayılan
item_id	Dize	İşlenmekte olan görüntü oluşturma öğesinin benzersiz tanımlayıcısı.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Olayın türü. Her zaman 'response.image_generation_call.generating'. Olası değerler: response.image_generation_call.generating	Yes

OpenAI.ResponseImageGenCallInProgressEvent

Görüntü oluşturma aracı çağrısı devam ederken bir bildirim gönderilir.

Name	Türü	Description	Zorunlu	Varsayılan
item_id	Dize	İşlenmekte olan görüntü oluşturma öğesinin benzersiz tanımlayıcısı.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Olayın türü. Her zaman 'response.image_generation_call.in_progress'. Olası değerler: response.image_generation_call.in_progress	Yes

OpenAI.ResponseImageGenCallPartialImageEvent

Görüntü oluşturma akışı sırasında kısmi bir görüntü kullanılabilir olduğunda emit edilir.

Name	Türü	Description	Zorunlu	Varsayılan
item_id	Dize	İşlenmekte olan görüntü oluşturma öğesinin benzersiz tanımlayıcısı.	Yes
output_index	OpenAI.integer		Yes
partial_image_b64	Dize	Base64 ile kodlanmış kısmi görüntü verileri, görüntü olarak işleme için uygundur.	Yes
partial_image_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Olayın türü. Her zaman 'response.image_generation_call.partial_image'. Olası değerler: response.image_generation_call.partial_image	Yes

OpenAI.ResponseInProgressEvent

Yanıt devam ederken gönderilir.

Name	Türü	Description	Zorunlu	Varsayılan
response	OpenAI.Response		Yes
└─ agent_reference	AgentReference (null atanabilir)	Bu yanıt için kullanılan aracı	Yes
└─ arka plan	boole değeri (null atanabilir)		Hayır
└─ completed_at	integer (null atanabilir)		Hayır
└─ 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ır
└─ oluşturulma_tarihi	integer	Bu Yanıtın oluşturulduğu unix zaman damgası (saniye).	Yes
└─ hata	OpenAI.ResponseError (null atanabilir)	Model yanıt oluşturamadığında döndürülen bir hata nesnesi.	Yes
└─ kimlik	Dize	Bu Yanıt için benzersiz tanımlayıcı.	Yes
└─ eksik_bilgiler	OpenAI.ResponseIncompleteDetails (null atanabilir)		Yes
└─ yönerge	OpenAI.InputItem dizesi veya dizisi (null atanabilir)		Yes
└─ maksimum_çıkış_jetonları	OpenAI.integer (null atanabilir)		Hayır
└─ maksimum araç çağrıları	OpenAI.integer (null atanabilir)		Hayır
└─ meta veriler	OpenAI.Metadata (null atanabilir)	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu olabilir 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ır
└─ modeli	Dize	Bu yanıtın oluşturulması için kullanılacak model dağıtımı.	Hayır
└─ nesne	enum	Bu kaynağın nesne türü - her zaman response olarak ayarlanır. Olası değerler: response	Yes
└─ çı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.	Yes
└─ çıktı_metin	dize (null atanabilir)		Hayır
└─ paralel_arac_cagrilari	boolean	Modelin araç çağrılarını paralel olarak çalıştırmasına izin verilip verilmeyeceği.	Yes	True
└─ önceki_cevap_id	dize (null atanabilir)		Hayır
└─ istemi	OpenAI.Prompt	Bir komut şablonuna ve değişkenlerine referans. Daha fazla bilgi edinin.	Hayır
└─ prompt_cache_key	Dize	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ır
└─ prompt_cache_retention	enum	Olası değerler: in-memory, 24h	Hayır
└─ akıl yürütme	OpenAI.Reasoning (null atanabilir)	yalnızca gpt-5 ve o serisi modeller İçin yapılandırma seçenekleri mantık modelleri.	Hayır
└─ safety_identifier	Dize	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ır
└─ service_tier	OpenAI.ServiceTier	İsteğin sunulması için kullanılan işleme türünü belirtir. - 'otomatik' olarak ayarlanırsa istek, Project ayarlarında yapılandırılan hizmet katmanıyla işlenir. Aksi yapılandırılmadığı sürece, Project 'default' kullanır. - 'varsayılan' olarak ayarlanırsa, istek seçilen model için standart fiyatlandırma ve performansla işlenir. - 'esnek' veya 'öncelik' olarak ayarlanırsa istek ilgili hizmet katmanıyla işlenir. - 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ır
└─ durumu	enum	Yanıt oluşturma durumu. completed'lerden biri, failed in_progress, cancelled, queued veya incomplete. Olası değerler: completed, failed, in_progress, cancelled, , queued, incomplete	Hayır
└─ sıcaklık	OpenAI.numeric (null atanabilir)		Hayır	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ır
└─ araç seçimi	OpenAI.ToolChoiceOptions veya OpenAI.ToolChoiceParam		Hayır
└─ 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ır
└─ top_logprobs	OpenAI.integer (null atanabilir)		Hayır
└─ top_p	OpenAI.numeric (null atanabilir)		Hayır	1
└─ kısaltma	enum	Olası değerler: auto, disabled	Hayır
└─ 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ır
└─ 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ır
sequence_number	OpenAI.integer		Yes
type	enum	Olayın türü. Her zaman response.in_progress. Olası değerler: response.in_progress	Yes

OpenAI.ResponseIncompleteDetails

Name	Türü	Description	Zorunlu	Varsayılan
neden	enum	Olası değerler: max_output_tokens, content_filter	Hayır

OpenAI.ResponseIncompleteEvent

Yanıt eksik olduğunda yayılan bir olay.

Name	Türü	Description	Zorunlu	Varsayılan
response	OpenAI.Response		Yes
└─ agent_reference	AgentReference (null atanabilir)	Bu yanıt için kullanılan aracı	Yes
└─ arka plan	boole değeri (null atanabilir)		Hayır
└─ completed_at	integer (null atanabilir)		Hayır
└─ 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ır
└─ oluşturulma_tarihi	integer	Bu Yanıtın oluşturulduğu unix zaman damgası (saniye).	Yes
└─ hata	OpenAI.ResponseError (null atanabilir)	Model yanıt oluşturamadığında döndürülen bir hata nesnesi.	Yes
└─ kimlik	Dize	Bu Yanıt için benzersiz tanımlayıcı.	Yes
└─ eksik_bilgiler	OpenAI.ResponseIncompleteDetails (null atanabilir)		Yes
└─ yönerge	OpenAI.InputItem dizesi veya dizisi (null atanabilir)		Yes
└─ maksimum_çıkış_jetonları	OpenAI.integer (null atanabilir)		Hayır
└─ maksimum araç çağrıları	OpenAI.integer (null atanabilir)		Hayır
└─ meta veriler	OpenAI.Metadata (null atanabilir)	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu olabilir 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ır
└─ modeli	Dize	Bu yanıtın oluşturulması için kullanılacak model dağıtımı.	Hayır
└─ nesne	enum	Bu kaynağın nesne türü - her zaman response olarak ayarlanır. Olası değerler: response	Yes
└─ çı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.	Yes
└─ çıktı_metin	dize (null atanabilir)		Hayır
└─ paralel_arac_cagrilari	boolean	Modelin araç çağrılarını paralel olarak çalıştırmasına izin verilip verilmeyeceği.	Yes	True
└─ önceki_cevap_id	dize (null atanabilir)		Hayır
└─ istemi	OpenAI.Prompt	Bir komut şablonuna ve değişkenlerine referans. Daha fazla bilgi edinin.	Hayır
└─ prompt_cache_key	Dize	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ır
└─ prompt_cache_retention	enum	Olası değerler: in-memory, 24h	Hayır
└─ akıl yürütme	OpenAI.Reasoning (null atanabilir)	yalnızca gpt-5 ve o serisi modeller İçin yapılandırma seçenekleri mantık modelleri.	Hayır
└─ safety_identifier	Dize	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ır
└─ service_tier	OpenAI.ServiceTier	İsteğin sunulması için kullanılan işleme türünü belirtir. - 'otomatik' olarak ayarlanırsa istek, Project ayarlarında yapılandırılan hizmet katmanıyla işlenir. Aksi yapılandırılmadığı sürece, Project 'default' kullanır. - 'varsayılan' olarak ayarlanırsa, istek seçilen model için standart fiyatlandırma ve performansla işlenir. - 'esnek' veya 'öncelik' olarak ayarlanırsa istek ilgili hizmet katmanıyla işlenir. - 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ır
└─ durumu	enum	Yanıt oluşturma durumu. completed'lerden biri, failed in_progress, cancelled, queued veya incomplete. Olası değerler: completed, failed, in_progress, cancelled, , queued, incomplete	Hayır
└─ sıcaklık	OpenAI.numeric (null atanabilir)		Hayır	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ır
└─ araç seçimi	OpenAI.ToolChoiceOptions veya OpenAI.ToolChoiceParam		Hayır
└─ 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ır
└─ top_logprobs	OpenAI.integer (null atanabilir)		Hayır
└─ top_p	OpenAI.numeric (null atanabilir)		Hayır	1
└─ kısaltma	enum	Olası değerler: auto, disabled	Hayır
└─ 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ır
└─ 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ır
sequence_number	OpenAI.integer		Yes
type	enum	Olayın türü. Her zaman response.incomplete. Olası değerler: response.incomplete	Yes

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.

Name	Türü	Description	Zorunlu	Varsayılan
logprob	OpenAI.numeric		Yes
token	Dize	Olası bir metin belirteci.	Yes
top_logprobs	OpenAI.ResponseLogProbTopLogprobs dizisi	En olası 20 belirtecin günlük olasılığı.	Hayır

OpenAI.ResponseLogProbTopLogprobs

Name	Türü	Description	Zorunlu	Varsayılan
logprob	OpenAI.numeric		Hayır
token	Dize		Hayır

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.

Name	Türü	Description	Zorunlu	Varsayılan
delta	Dize	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.	Yes
item_id	Dize	İşlenen MCP aracı çağrı öğesinin benzersiz tanımlayıcısı.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Olayın türü. Her zaman 'response.mcp_call_arguments.delta'. Olası değerler: response.mcp_call_arguments.delta	Yes

OpenAI.ResponseMCPCallArgumentsDoneEvent

Bir MCP araç çağrısı için bağımsız değişkenler sonlandırıldığında oluşur.

Name	Türü	Description	Zorunlu	Varsayılan
arguments	Dize	MCP araç çağrısı için son haline getirilmiş bağımsız değişkenleri içeren bir JSON dizesi.	Yes
item_id	Dize	İşlenen MCP aracı çağrı öğesinin benzersiz tanımlayıcısı.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Olayın türü. Her zaman 'response.mcp_call_arguments.bitti'. Olası değerler: response.mcp_call_arguments.done	Yes

OpenAI.ResponseMCPCallCompletedEvent

BIR MCP araç çağrısı başarıyla tamamlandığında yayılır.

Name	Türü	Description	Zorunlu	Varsayılan
item_id	Dize	Tamamlanan MCP aracı çağrı öğesinin kimliği.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Olayın türü. Her zaman 'response.mcp_call.completed'. Olası değerler: response.mcp_call.completed	Yes

OpenAI.ResponseMCPCallFailedEvent

Bir MCP aracı çağrısının başarısız olması durumunda yayımlanır.

Name	Türü	Description	Zorunlu	Varsayılan
item_id	Dize	Başarısız olan MCP aracı çağrı öğesinin kimliği.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Olayın türü. 'sonuç her zaman 'response.mcp_call.failed' olur. Olası değerler: response.mcp_call.failed	Yes

OpenAI.ResponseMCPCallInProgressEvent

Bir MCP araç çağrısı devam ederken tetiklenir.

Name	Türü	Description	Zorunlu	Varsayılan
item_id	Dize	İşlenen MCP aracı çağrı öğesinin benzersiz tanımlayıcısı.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Olayın türü. Her zaman 'response.mcp_call.in_progress'. Olası değerler: response.mcp_call.in_progress	Yes

OpenAI.ResponseMCPListToolsCompletedEvent

Kullanılabilir MCP araçlarının listesi başarıyla alındığında tetiklenir.

Name	Türü	Description	Zorunlu	Varsayılan
item_id	Dize	Bu çıkışı oluşturan MCP aracı çağrı öğesinin kimliği.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Olayın türü. Her zaman 'response.mcp_list_tools.completed'. Olası değerler: response.mcp_list_tools.completed	Yes

OpenAI.ResponseMCPListToolsFailedEvent

Kullanılabilir MCP araçlarını listeleme girişimi başarısız olduğunda ortaya çıkar.

Name	Türü	Description	Zorunlu	Varsayılan
item_id	Dize	Başarısız olan MCP aracı çağrı öğesinin kimliği.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Olayın türü. Her zaman 'response.mcp_list_tools.başarısız'. Olası değerler: response.mcp_list_tools.failed	Yes

OpenAI.ResponseMCPListToolsInProgressEvent

Sistem, kullanılabilir MCP araçlarının listesini alırken tetiklenir.

Name	Türü	Description	Zorunlu	Varsayılan
item_id	Dize	İşlenmekte olan MCP aracı çağrı öğesinin kimliği.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Olayın türü. Her zaman 'response.mcp_list_tools.in_progress'. Olası değerler: response.mcp_list_tools.in_progress	Yes

OpenAI.ResponseOutputItemAddedEvent

Yeni bir çıkış öğesi eklendiğinde gönderilir.

Name	Türü	Description	Zorunlu	Varsayılan
öğe	OpenAI.OutputItem		Yes
└─ agent_reference	AgentReference	Öğeyi oluşturan aracı.	Hayır
└─ response_id	Dize	Öğenin oluşturulduğu yanıt.	Hayır
└─ türü	OpenAI.OutputItemType		Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Olayın türü. Her zaman response.output_item.added. Olası değerler: response.output_item.added	Yes

OpenAI.ResponseOutputItemDoneEvent

Çıktı öğesi tamamlandı olarak işaretlendiğinde yayılır.

Name	Türü	Description	Zorunlu	Varsayılan
öğe	OpenAI.OutputItem		Yes
└─ agent_reference	AgentReference	Öğeyi oluşturan aracı.	Hayır
└─ response_id	Dize	Öğenin oluşturulduğu yanıt.	Hayır
└─ türü	OpenAI.OutputItemType		Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Olayın türü. Her zaman response.output_item.done. Olası değerler: response.output_item.done	Yes

OpenAI.ResponseOutputTextAnnotationAddedEvent

Çıkış metni içeriğine ek açıklama eklendiğinde yayılır.

Name	Türü	Description	Zorunlu	Varsayılan
annotation	OpenAI.Annotation	Çıkış metninin yayılma alanına uygulanan bir ek açıklama.	Yes
└─ türü	OpenAI.AnnotationType		Yes
annotation_index	OpenAI.integer		Yes
content_index	OpenAI.integer		Yes
item_id	Dize	Ek açıklamanın eklendiği öğenin benzersiz tanımlayıcısı.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Olayın türü. Her zaman 'response.output_text.annotation.added'. Olası değerler: response.output_text.annotation.added	Yes

OpenAI.ResponsePromptVariables

İsteminizdeki değişkenlerin yerine kullanılacak isteğe bağlı değer haritası. 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.

Name	Türü	Description	Zorunlu	Varsayılan
response	OpenAI.Response		Yes
└─ agent_reference	AgentReference (null atanabilir)	Bu yanıt için kullanılan aracı	Yes
└─ arka plan	boole değeri (null atanabilir)		Hayır
└─ completed_at	integer (null atanabilir)		Hayır
└─ 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ır
└─ oluşturulma_tarihi	integer	Bu Yanıtın oluşturulduğu unix zaman damgası (saniye).	Yes
└─ hata	OpenAI.ResponseError (null atanabilir)	Model yanıt oluşturamadığında döndürülen bir hata nesnesi.	Yes
└─ kimlik	Dize	Bu Yanıt için benzersiz tanımlayıcı.	Yes
└─ eksik_bilgiler	OpenAI.ResponseIncompleteDetails (null atanabilir)		Yes
└─ yönerge	OpenAI.InputItem dizesi veya dizisi (null atanabilir)		Yes
└─ maksimum_çıkış_jetonları	OpenAI.integer (null atanabilir)		Hayır
└─ maksimum araç çağrıları	OpenAI.integer (null atanabilir)		Hayır
└─ meta veriler	OpenAI.Metadata (null atanabilir)	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu olabilir 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ır
└─ modeli	Dize	Bu yanıtın oluşturulması için kullanılacak model dağıtımı.	Hayır
└─ nesne	enum	Bu kaynağın nesne türü - her zaman response olarak ayarlanır. Olası değerler: response	Yes
└─ çı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.	Yes
└─ çıktı_metin	dize (null atanabilir)		Hayır
└─ paralel_arac_cagrilari	boolean	Modelin araç çağrılarını paralel olarak çalıştırmasına izin verilip verilmeyeceği.	Yes	True
└─ önceki_cevap_id	dize (null atanabilir)		Hayır
└─ istemi	OpenAI.Prompt	Bir komut şablonuna ve değişkenlerine referans. Daha fazla bilgi edinin.	Hayır
└─ prompt_cache_key	Dize	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ır
└─ prompt_cache_retention	enum	Olası değerler: in-memory, 24h	Hayır
└─ akıl yürütme	OpenAI.Reasoning (null atanabilir)	yalnızca gpt-5 ve o serisi modeller İçin yapılandırma seçenekleri mantık modelleri.	Hayır
└─ safety_identifier	Dize	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ır
└─ service_tier	OpenAI.ServiceTier	İsteğin sunulması için kullanılan işleme türünü belirtir. - 'otomatik' olarak ayarlanırsa istek, Project ayarlarında yapılandırılan hizmet katmanıyla işlenir. Aksi yapılandırılmadığı sürece, Project 'default' kullanır. - 'varsayılan' olarak ayarlanırsa, istek seçilen model için standart fiyatlandırma ve performansla işlenir. - 'esnek' veya 'öncelik' olarak ayarlanırsa istek ilgili hizmet katmanıyla işlenir. - 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ır
└─ durumu	enum	Yanıt oluşturma durumu. completed'lerden biri, failed in_progress, cancelled, queued veya incomplete. Olası değerler: completed, failed, in_progress, cancelled, , queued, incomplete	Hayır
└─ sıcaklık	OpenAI.numeric (null atanabilir)		Hayır	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ır
└─ araç seçimi	OpenAI.ToolChoiceOptions veya OpenAI.ToolChoiceParam		Hayır
└─ 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ır
└─ top_logprobs	OpenAI.integer (null atanabilir)		Hayır
└─ top_p	OpenAI.numeric (null atanabilir)		Hayır	1
└─ kısaltma	enum	Olası değerler: auto, disabled	Hayır
└─ 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ır
└─ 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ır
sequence_number	OpenAI.integer		Yes
type	enum	Olayın türü. Her zaman 'response.queued'. Olası değerler: response.queued	Yes

OpenAI.ResponseReasoningSummaryPartAddedEvent

Yeni bir akıl yürütme özeti bölümü eklendiğinde yayımlanır.

Name	Türü	Description	Zorunlu	Varsayılan
item_id	Dize	Bu özet bölümün ilişkili olduğu öğenin kimliği.	Yes
output_index	OpenAI.integer		Yes
parça	OpenAI.ResponseReasoningSummaryPartAddedEventPart		Yes
└─ metin	Dize		Yes
└─ türü	enum	Olası değerler: summary_text	Yes
sequence_number	OpenAI.integer		Yes
summary_index	OpenAI.integer		Yes
type	enum	Olayın türü. Her zaman response.reasoning_summary_part.added. Olası değerler: response.reasoning_summary_part.added	Yes

OpenAI.ResponseReasoningSummaryPartAddedEventPart

Name	Türü	Description	Zorunlu	Varsayılan
text	Dize		Yes
type	enum	Olası değerler: summary_text	Yes

OpenAI.ResponseReasoningSummaryPartDoneEvent

Bir akıl yürütme özeti bölümü tamamlandığında gönderilir.

Name	Türü	Description	Zorunlu	Varsayılan
item_id	Dize	Bu özet bölümün ilişkili olduğu öğenin kimliği.	Yes
output_index	OpenAI.integer		Yes
parça	OpenAI.ResponseReasoningSummaryPartDoneEventPart		Yes
└─ metin	Dize		Yes
└─ türü	enum	Olası değerler: summary_text	Yes
sequence_number	OpenAI.integer		Yes
summary_index	OpenAI.integer		Yes
type	enum	Olayın türü. Her zaman response.reasoning_summary_part.done. Olası değerler: response.reasoning_summary_part.done	Yes

OpenAI.ResponseReasoningSummaryPartDoneEventPart

Name	Türü	Description	Zorunlu	Varsayılan
text	Dize		Yes
type	enum	Olası değerler: summary_text	Yes

OpenAI.ResponseReasoningSummaryTextDeltaEvent

Bir muhakeme özeti metnine delta eklendiğinde oluşur.

Name	Türü	Description	Zorunlu	Varsayılan
delta	Dize	Özete eklenen metin deltası.	Yes
item_id	Dize	Bu özet metin deltasının ilişkili olduğu öğenin kimliği.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
summary_index	OpenAI.integer		Yes
type	enum	Olayın türü. Her zaman response.reasoning_summary_text.delta. Olası değerler: response.reasoning_summary_text.delta	Yes

OpenAI.ResponseReasoningSummaryTextDoneEvent

Bir akıl yürütme özeti metni tamamlandığında yayılır.

Name	Türü	Description	Zorunlu	Varsayılan
item_id	Dize	Bu özet metnin ilişkili olduğu öğenin kimliği.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
summary_index	OpenAI.integer		Yes
text	Dize	Tamamlanan akıl yürütme özetinin tam metni.	Yes
type	enum	Olayın türü. Her zaman response.reasoning_summary_text.done. Olası değerler: response.reasoning_summary_text.done	Yes

OpenAI.ResponseReasoningTextDeltaEvent

Bir muhakeme metnine delta eklendiğinde yayılır.

Name	Türü	Description	Zorunlu	Varsayılan
content_index	OpenAI.integer		Yes
delta	Dize	Muhakeme içeriğine eklenen metin deltası.	Yes
item_id	Dize	Bu muhakeme metni deltasının ilişkili olduğu öğenin kimliği.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Olayın türü. Her zaman response.reasoning_text.delta. Olası değerler: response.reasoning_text.delta	Yes

OpenAI.ResponseReasoningTextDoneEvent

Bir akıl yürütme metni tamamlandığında yayılır.

Name	Türü	Description	Zorunlu	Varsayılan
content_index	OpenAI.integer		Yes
item_id	Dize	Bu muhakeme metninin ilişkili olduğu öğenin kimliği.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
text	Dize	Tamamlanmış muhakeme içeriğinin tam metni.	Yes
type	enum	Olayın türü. Her zaman response.reasoning_text.done. Olası değerler: response.reasoning_text.done	Yes

OpenAI.ResponseRefusalDeltaEvent

Kısmi bir reddetme metni olduğunda yayılır.

Name	Türü	Description	Zorunlu	Varsayılan
content_index	OpenAI.integer		Yes
delta	Dize	Eklenen ret metni.	Yes
item_id	Dize	Reddetme metninin eklendiği çıkış öğesinin kimliği.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Olayın türü. Her zaman response.refusal.delta. Olası değerler: response.refusal.delta	Yes

OpenAI.ResponseRefusalDoneEvent

Reddeden metin sonlandırıldığında yayılır.

Name	Türü	Description	Zorunlu	Varsayılan
content_index	OpenAI.integer		Yes
item_id	Dize	Sonlandırılan reddetme metninin ait olduğu çıkış öğesinin kimliği.	Yes
output_index	OpenAI.integer		Yes
Ret	Dize	Kesinleştirilen reddetme metni.	Yes
sequence_number	OpenAI.integer		Yes
type	enum	Olayın türü. Her zaman response.refusal.done. Olası değerler: response.refusal.done	Yes

OpenAI.ResponseStreamOptions

Akış yanıtları için seçenekler. Bunu yalnızca stream: true ayarladığınızda yapılandırın.

Name	Türü	Description	Zorunlu	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ır

OpenAI.ResponseTextDeltaEvent

İlave bir metin deltası olduğunda oluşur.

Name	Türü	Description	Zorunlu	Varsayılan
content_index	OpenAI.integer		Yes
delta	Dize	Eklenen metin deltası.	Yes
item_id	Dize	Metin deltasının eklendiği çıkış öğesinin kimliği.	Yes
logprobs	OpenAI.ResponseLogProb dizisi	Deltadaki belirteçlerin günlük olasılıkları.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Olayın türü. Her zaman response.output_text.delta. Olası değerler: response.output_text.delta	Yes

OpenAI.ResponseTextDoneEvent

Metin içeriği sonlandırıldığında yayınlanır.

Name	Türü	Description	Zorunlu	Varsayılan
content_index	OpenAI.integer		Yes
item_id	Dize	Metin içeriğinin sonlandırıldığı çıkış öğesinin kimliği.	Yes
logprobs	OpenAI.ResponseLogProb dizisi	Deltadaki belirteçlerin günlük olasılıkları.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
text	Dize	Son haline getirilmiş metin içeriği.	Yes
type	enum	Olayın türü. Her zaman response.output_text.done. Olası değerler: response.output_text.done	Yes

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ış Çıkışlar

Name	Türü	Description	Zorunlu	Varsayılan
format	OpenAI.TextResponseFormatConfiguration	Modelin çıkış yapması gereken biçimi belirten bir nesne. { "type": "json_schema" }'yi yapılandırmak, Yapılandırılmış Çıkışları etkinleştirir. modelin sağlanan JSON şemanızla eşleşmesini sağlar. Daha fazla bilgi için burayı ziyaret edin 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ır
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ır

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.

Name	Türü	Description	Zorunlu	Varsayılan
input_tokens	OpenAI.integer		Yes
input_tokens_details	OpenAI.ResponseUsageInputTokensDetails		Yes
└─ önbelleğe alınmış jetonlar	OpenAI.integer		Yes
output_tokens	OpenAI.integer		Yes
output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails		Yes
└─ akıl yürütme_tokenlar	OpenAI.integer		Yes
total_tokens	OpenAI.integer		Yes

OpenAI.ResponseUsageInputTokensDetails

Name	Türü	Description	Zorunlu	Varsayılan
cached_tokens	OpenAI.integer		Yes

OpenAI.ResponseUsageOutputTokensDetails

Name	Türü	Description	Zorunlu	Varsayılan
akıl yürütme birimleri	OpenAI.integer		Yes

OpenAI.ResponseWebSearchCallCompletedEvent

Web araması araması tamamlandığında gönderilir.

Name	Türü	Description	Zorunlu	Varsayılan
item_id	Dize	Web arama çağrısıyla ilişkili çıkış öğesinin benzersiz kimliği.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Olayın türü. Her zaman response.web_search_call.completed. Olası değerler: response.web_search_call.completed	Yes

OpenAI.ResponseWebSearchCallInProgressEvent

Bir web arama çağrısı başlatıldığında yayılır.

Name	Türü	Description	Zorunlu	Varsayılan
item_id	Dize	Web arama çağrısıyla ilişkili çıkış öğesinin benzersiz kimliği.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Olayın türü. Her zaman response.web_search_call.in_progress. Olası değerler: response.web_search_call.in_progress	Yes

OpenAI.ResponseWebSearchCallSearchingEvent

Bir web arama çağrısı yürütülürken gönderilir.

Name	Türü	Description	Zorunlu	Varsayılan
item_id	Dize	Web arama çağrısıyla ilişkili çıkış öğesinin benzersiz kimliği.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Olayın türü. Her zaman response.web_search_call.searching. Olası değerler: response.web_search_call.searching	Yes

OpenAI.Ekran Görüntüsü

Ekran görüntüsü alma işlemi.

Name	Türü	Description	Zorunlu	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	Yes

OpenAI.Scroll

Kaydırma eylemi.

Name	Türü	Description	Zorunlu	Varsayılan
scroll_x	OpenAI.integer		Yes
scroll_y	OpenAI.integer		Yes
type	enum	Olay türünü belirtir. Kaydırma eylemi için bu özellik belirtilmiştir. her zaman scroll olarak ayarlanır. Olası değerler: scroll	Yes
x	OpenAI.integer		Yes
y	OpenAI.integer		Yes

OpenAI.SearchContextSize

Property	Değer
Türü	Dize
Değerler	low medium high

OpenAI.ServiceTier

İsteğin sunulması için kullanılan işleme türünü belirtir.

• 'otomatik' olarak ayarlanırsa istek, Project ayarlarında yapılandırılan hizmet katmanıyla işlenir. Aksi yapılandırılmadığı sürece, Project 'default' kullanır.
• 'varsayılan' olarak ayarlanırsa istek, seçilen model için standart fiyatlandırma ve performansla işlenir.
• 'Flex' veya 'priority' olarak ayarlanırsa istek ilgili hizmet katmanıyla işlenir.
• 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.

Property	Değer
Türü	Dize
Nullable	Yes
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.

Name	Türü	Description	Zorunlu	Varsayılan
type	enum	Çağrılacak araç. Her zaman apply_patch. Olası değerler: apply_patch	Yes

OpenAI.SpecificFunctionShellParam

Bir araç çağrısı gerektiğinde modeli kabuk aracını çağırmaya zorlar.

Name	Türü	Description	Zorunlu	Varsayılan
type	enum	Çağrılacak araç. Her zaman shell. Olası değerler: shell	Yes

OpenAI.Summary

Modelden özet metin.

Name	Türü	Description	Zorunlu	Varsayılan
text	Dize	Modelden şimdiye kadar elde edilen mantık çıkarlarının özeti.	Yes
type	enum	Nesnenin türü. Her zaman summary_text. Olası değerler: summary_text	Yes

OpenAI.SummaryTextContent

Modelden özet metin.

Name	Türü	Description	Zorunlu	Varsayılan
text	Dize	Modelden şimdiye kadar elde edilen mantık çıkarlarının özeti.	Yes
type	enum	Nesnenin türü. Her zaman summary_text. Olası değerler: summary_text	Yes

OpenAI.TextContent

Metin içeriği.

Name	Türü	Description	Zorunlu	Varsayılan
text	Dize		Yes
type	enum	Olası değerler: text	Yes

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 burayı ziyaret edin

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	Schema
json_schema	OpenAI.TextResponseFormatJsonSchema
text	OpenAI.TextResponseFormatConfigurationResponseFormatText
json_object	OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject

Name	Türü	Description	Zorunlu	Varsayılan
type	OpenAI.TextResponseFormatConfigurationType		Yes

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ı iletisi olmadan JSON oluşturmayacağını unutmayın.

Name	Türü	Description	Zorunlu	Varsayılan
type	enum	Tanımlanan yanıt biçiminin türü. Her zaman json_object. Olası değerler: json_object	Yes

OpenAI.TextResponseFormatConfigurationResponseFormatText

Varsayılan yanıt biçimi. Metin yanıtları oluşturmak için kullanılır.

Name	Türü	Description	Zorunlu	Varsayılan
type	enum	Tanımlanan yanıt biçiminin türü. Her zaman text. Olası değerler: text	Yes

OpenAI.TextResponseFormatConfigurationType

Property	Değer
Türü	Dize
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.

Name	Türü	Description	Zorunlu	Varsayılan
Açıklama	Dize	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ır
name	Dize	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.	Yes
schema	OpenAI.YanıtFormatıJsonŞemaŞeması	JSON Şeması nesnesi olarak tanımlanan yanıt biçimi şeması. JSON şemaları oluşturmayı buradan öğrenin.	Yes
Kesin	boole değeri (null atanabilir)		Hayır
type	enum	Tanımlanan yanıt biçiminin türü. Her zaman json_schema. Olası değerler: json_schema	Yes

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	Schema
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

Name	Türü	Description	Zorunlu	Varsayılan
type	OpenAI.ToolType		Yes

OpenAI.ToolChoiceAllowed

Modelde kullanılabilen araçları önceden tanımlanmış bir kümeyle kısıtlar.

Name	Türü	Description	Zorunlu	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 Mesaj. required modelin izin verilen araçlardan birini veya daha fazlasını çağırmasını gerektirir. Olası değerler: auto, required	Yes
tools	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>	Yes
type	enum	İzin verilen araç yapılandırma türü. Her zaman allowed_tools. Olası değerler: allowed_tools	Yes

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.

Name	Türü	Description	Zorunlu	Varsayılan
type	enum	Olası değerler: code_interpreter	Yes

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.

Name	Türü	Description	Zorunlu	Varsayılan
type	enum	Olası değerler: computer_use_preview	Yes

OpenAI.ToolChoiceCustom

Modeli belirli bir özel aracı çağırmaya zorlamak için bu seçeneği kullanın.

Name	Türü	Description	Zorunlu	Varsayılan
name	Dize	Çağrılacak özel aracın adı.	Yes
type	enum	Özel araç çağrısı için türü her zaman customşeklindedir. Olası değerler: custom	Yes

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.

Name	Türü	Description	Zorunlu	Varsayılan
type	enum	Olası değerler: file_search	Yes

OpenAI.ToolChoiceFunction

Modeli belirli bir işlevi çağırmaya zorlamak için bu seçeneği kullanın.

Name	Türü	Description	Zorunlu	Varsayılan
name	Dize	Çağrılacak işlevin adı.	Yes
type	enum	İşlev çağrısı için türü her zaman functionşeklindedir. Olası değerler: function	Yes

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.

Name	Türü	Description	Zorunlu	Varsayılan
type	enum	Olası değerler: image_generation	Yes

OpenAI.ToolChoiceMCP

Modeli uzak bir MCP sunucusunda belirli bir aracı çağırmaya zorlamak için bu seçeneği kullanın.

Name	Türü	Description	Zorunlu	Varsayılan
name	dize (null atanabilir)		Hayır
sunucu etiketi	Dize	Kullanılacak MCP sunucusunun etiketi.	Yes
type	enum	MCP araçları için türü her zaman mcpşeklindedir. Olası değerler: mcp	Yes

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.

Property	Değer
Türü	Dize
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	Schema
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

Name	Türü	Description	Zorunlu	Varsayılan
type	OpenAI.ToolChoiceParamType		Yes

OpenAI.ToolChoiceParamType

Property	Değer
Türü	Dize
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.

Name	Türü	Description	Zorunlu	Varsayılan
type	enum	Olası değerler: web_search_preview	Yes

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.

Name	Türü	Description	Zorunlu	Varsayılan
type	enum	Olası değerler: web_search_preview_2025_03_11	Yes

OpenAI.ToolType

Property	Değer
Türü	Dize
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. İşlev çağırma 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 logaritmik olasılığı.

Name	Türü	Description	Zorunlu	Varsayılan
bytes	OpenAI.integer dizisi		Yes
logprob	OpenAI.numeric		Yes
token	Dize		Yes

OpenAI.Type

Metin yazmak için bir eylem.

Name	Türü	Description	Zorunlu	Varsayılan
text	Dize	Yazılacak metin.	Yes
type	enum	Olay türünü belirtir. Tür eylemi için, bu özellik şöyledir: her zaman type olarak ayarlanır. Olası değerler: type	Yes

OpenAI.UpdateConversationBody

Name	Türü	Description	Zorunlu	Varsayılan
metadata	OpenAI.Metadata (null atanabilir)	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu olabilir 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.	Yes

OpenAI.UrlCitationBody

Model yanıtı oluşturmak için kullanılan bir web kaynağı alıntısı.

Name	Türü	Description	Zorunlu	Varsayılan
end_index	OpenAI.integer		Yes
start_index	OpenAI.integer		Yes
title	Dize	Web kaynağının başlığı.	Yes
type	enum	URL alıntısının türü. Her zaman url_citation. Olası değerler: url_citation	Yes
url	Dize	Web kaynağının URL'si.	Yes

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.

Property	Değer
Türü	Dize
Nullable	Yes
Değerler	low medium high

OpenAI.Wait

Bir bekleme eylemi.

Name	Türü	Description	Zorunlu	Varsayılan
type	enum	Olay türünü belirtir. Bekleme eylemi için bu özellik her zaman wait olarak ayarlanır. Olası değerler: wait	Yes

OpenAI.WebSearchActionFind

Eylem türü "bul": Yüklenen bir sayfada desen arar.

Name	Türü	Description	Zorunlu	Varsayılan
pattern	Dize	Sayfa içinde aranacak desen veya metin.	Yes
type	enum	Eylem türü. Olası değerler: find_in_page	Yes
url	Dize	Desenin arandığı sayfanın URL'si.	Yes

OpenAI.WebSearchActionOpenPage

Eylem türü "open_page" - Arama sonuçlarından belirli bir URL'yi açar.

Name	Türü	Description	Zorunlu	Varsayılan
type	enum	Eylem türü. Olası değerler: open_page	Yes
url	Dize	Modelin açtığı URL	Yes

OpenAI.WebSearchActionSearch

Eylem türü "arama" - Web araması sorgusu gerçekleştirir.

Name	Türü	Description	Zorunlu	Varsayılan
queries	dize dizisi	Arama sorguları.	Hayır
soru	dize (kullanım dışı)	[KULLANIM DIŞI] Arama sorgusu.	Yes
Kaynak	OpenAI.WebSearchActionSearchSources dizisi	Aramada kullanılan kaynaklar.	Hayır
type	enum	Eylem türü. Olası değerler: search	Yes

OpenAI.WebSearchActionSearchSources

Name	Türü	Description	Zorunlu	Varsayılan
type	enum	Olası değerler: url	Yes
url	Dize		Yes

OpenAI.WebSearchApproximateLocation

Kullanıcının yaklaşık konumu.

Name	Türü	Description	Zorunlu	Varsayılan
city	dize (null atanabilir)		Hayır
country	dize (null atanabilir)		Hayır
region	dize (null atanabilir)		Hayır
timezone	dize (null atanabilir)		Hayır
type	enum	Konum yaklaşımının türü. Her zaman approximate. Olası değerler: approximate	Hayır

OpenAI.WebSearchPreviewTool

Bu araç, yanıt için ilgili sonuçları internette arar. web arama aracı hakkında daha fazla bilgi edinin.

Name	Türü	Description	Zorunlu	Varsayılan
arama_bağlam_boyutu	OpenAI.SearchContextSize		Hayır
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	Yes
kullanıcı_konumu	OpenAI.ApproximateLocation (null atanabilir)		Hayır
└─ şehir	dize (null atanabilir)		Hayır
└─ ülke	dize (null atanabilir)		Hayır
└─ bölge	dize (null atanabilir)		Hayır
└─ saat dilimi	dize (null atanabilir)		Hayır
└─ türü	enum	Konum yaklaşımının türü. Her zaman approximate. Olası değerler: approximate	Yes

OpenAI.WebSearchTool

Yönlendirmeyle ilgili kaynakları internette arayın. web arama aracı hakkında daha fazla bilgi edinin.

Name	Türü	Description	Zorunlu	Varsayılan
custom_search_configuration	WebSearchConfiguration	bing özel arama için web araması yapılandırması	Hayır
└─ instance_name	Dize	Yapılandırmaya verilen özel yapılandırma örneğinin adı.	Yes
└─ project_connection_id	Dize	bing özel arama ile topraklama için Project bağlantı kimliği	Yes
filters	OpenAI.WebSearchToolFilters (null atanabilir)		Hayır
└─ allowed_domains	dize dizisi (null atanabilir)		Hayır
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ır
type	enum	Web arama aracının türü. web_search veya web_search_2025_08_26'den biri. Olası değerler: web_search	Yes
kullanıcı_konumu	OpenAI.WebSearchApproximateLocation (null atanabilir)	Kullanıcının yaklaşık konumu.	Hayır
└─ şehir	dize (null atanabilir)		Hayır
└─ ülke	dize (null atanabilir)		Hayır
└─ bölge	dize (null atanabilir)		Hayır
└─ saat dilimi	dize (null atanabilir)		Hayır
└─ türü	enum	Konum yaklaşımının türü. Her zaman approximate. Olası değerler: approximate	Hayır

OpenAI.WebSearchToolFilters

Name	Türü	Description	Zorunlu	Varsayılan
allowed_domains	dize dizisi		Hayır

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ı

Name	Türü	Description	Zorunlu	Varsayılan
type	enum	Her zaman 'anonim' olan nesne türü. Olası değerler: anonymous	Yes

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	Schema
anonymous	OpenApiAnonymousAuthDetails
project_connection	OpenApiProjectConnectionAuthDetails
managed_identity	OpenApiManagedAuthDetails

Name	Türü	Description	Zorunlu	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ısı (AI Foundry'de kurulum olarak uç noktaya project_connection_id gerektirir) - Managed_Identity (kimlik tabanlı kimlik doğrulaması için hedef kitle gerektirir)	Yes

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)

Property	Değer
Tanım	OpenApi uç noktası için kimlik doğrulama türü. İzin verilen türler şunlardır: - Anonim (kimlik doğrulaması gerekmez) - Project Bağlantısı (AI Foundry'de kurulum olarak uç noktaya project_connection_id gerektirir) - Managed_Identity (kimlik tabanlı kimlik doğrulaması için hedef kitle gerektirir)
Türü	Dize
Değerler	anonymous project_connection managed_identity

OpenApiFunctionDefinition

Openapi işlevinin giriş tanımı bilgileri.

Name	Türü	Description	Zorunlu	Varsayılan
auth	OpenApiAuthDetails	OpenApiFunctionDefinition için kimlik doğrulama ayrıntıları	Yes
└─ türü	OpenApiAuthType	Kimlik doğrulama türü anonim/project_connection/managed_identity olmalıdır	Yes
default_params	dize dizisi	Kullanıcı tarafından sağlanan varsayılanları kullanacak OpenAPI belirtim parametrelerinin listesi	Hayır
Açıklama	Dize	İş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ır
functions	nesne dizisi	OpenApi aracı tarafından kullanılan işlev tanımlarının listesi	Hayır
name	Dize	Çağrılacak işlevin adı.	Yes
spec	Obje	JSON Şeması nesnesi olarak tanımlanan openapi işlev şekli.	Yes

OpenApiManagedAuthDetails

OpenApi managed_identity kimlik doğrulaması için güvenlik ayrıntıları

Name	Türü	Description	Zorunlu	Varsayılan
security_scheme	OpenApiManagedSecurityScheme	OpenApi managed_identity kimlik doğrulaması için güvenlik şeması	Yes
└─ hedef kitle	Dize	managed_identity kimlik doğrulama türü için kimlik doğrulama kapsamı	Yes
type	enum	Her zaman 'managed_identity' olan nesne türü. Olası değerler: managed_identity	Yes

OpenApiManagedSecurityScheme

OpenApi managed_identity kimlik doğrulaması için güvenlik şeması

Name	Türü	Description	Zorunlu	Varsayılan
audience	Dize	managed_identity kimlik doğrulama türü için kimlik doğrulama kapsamı	Yes

OpenApiProjectConnectionAuthDetails

OpenApi project bağlantı kimlik doğrulaması için güvenlik ayrıntıları

Name	Türü	Description	Zorunlu	Varsayılan
security_scheme	OpenApiProjectConnectionSecurityScheme	OpenApi managed_identity kimlik doğrulaması için güvenlik şeması	Yes
└─ project_connection_id	Dize	Project Bağlantı kimlik doğrulaması türü için Project bağlantı kimliği	Yes
type	enum	Her zaman 'project_connection' olan nesne türü. Olası değerler: project_connection	Yes

OpenApiProjectConnectionSecurityScheme

OpenApi managed_identity kimlik doğrulaması için güvenlik şeması

Name	Türü	Description	Zorunlu	Varsayılan
project_connection_id	Dize	Project Bağlantı kimlik doğrulaması türü için Project bağlantı kimliği	Yes

OpenApiTool

Aracıyı yapılandırmak için kullanılan OpenAPI aracının giriş tanımı bilgileri.

Name	Türü	Description	Zorunlu	Varsayılan
openapi	OpenApiFunctionDefinition	Openapi işlevinin giriş tanımı bilgileri.	Yes
└─ kimlik doğrulaması	OpenApiAuthDetails	Açık API kimlik doğrulaması ayrıntıları	Yes
└─ default_params	dize dizisi	Kullanıcı tarafından sağlanan varsayılanları kullanacak OpenAPI belirtim parametrelerinin listesi	Hayır
└─ açıklama	Dize	İş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ır
└─ işlevleri	nesne dizisi (salt okunur)	OpenApi aracı tarafından kullanılan işlev tanımlarının listesi	Hayır
└─ açıklama	Dize	İş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ır
└─ ad	Dize	Çağrılacak işlevin adı.	Yes
└─ parametreler	Obje	İşlevlerin kabullediği, JSON Şeması nesnesi olarak tanımlanan parametreler.	Yes
└─ ad	Dize	Çağrılacak işlevin adı.	Yes
└─ belirtim	Obje	JSON Şeması nesnesi olarak tanımlanan openapi işlev şekli.	Yes
type	enum	Her zaman 'openapi' olan nesne türü. Olası değerler: openapi	Yes

PageOrder

Property	Değer
Türü	Dize
Değerler	asc desc

PagedConnection

Bağlantı öğelerinin disk belleğine alınmış koleksiyonu

Name	Türü	Description	Zorunlu	Varsayılan
nextLink	Dize	Öğelerin sonraki sayfasına bağlantı	Hayır
value	Bağlantı dizisi	Bu sayfadaki Bağlantı öğeleri	Yes

PagedDatasetVersion

DatasetVersion öğelerinin disk belleğine alınmış koleksiyonu

Name	Türü	Description	Zorunlu	Varsayılan
nextLink	Dize	Öğelerin sonraki sayfasına bağlantı	Hayır
value	DatasetVersion dizisi	Bu sayfadaki DatasetVersion öğeleri	Yes

PagedDeployment

Dağıtım öğelerinin disk belleğine alınmış koleksiyonu

Name	Türü	Description	Zorunlu	Varsayılan
nextLink	Dize	Öğelerin sonraki sayfasına bağlantı	Hayır
value	Dağıtım dizisi	Bu sayfadaki Dağıtım öğeleri	Yes

PagedEvaluationRule

EvaluationRule öğelerinin disk belleğine alınmış koleksiyonu

Name	Türü	Description	Zorunlu	Varsayılan
nextLink	Dize	Öğelerin sonraki sayfasına bağlantı	Hayır
value	EvaluationRule dizisi	Bu sayfadaki EvaluationRule öğeleri	Yes

PagedEvaluationTaxonomy

EvaluationTaxonomy öğelerinin sayfalanmış koleksiyonu

Name	Türü	Description	Zorunlu	Varsayılan
nextLink	Dize	Öğelerin sonraki sayfasına bağlantı	Hayır
value	EvaluationTaxonomy dizisi	Bu sayfadaki EvaluationTaxonomy öğeleri	Yes

PagedEvaluatorVersion

EvaluatorVersion öğelerinin disk belleğine alınmış koleksiyonu

Name	Türü	Description	Zorunlu	Varsayılan
nextLink	Dize	Öğelerin sonraki sayfasına bağlantı	Hayır
value	EvaluatorVersion dizisi	Bu sayfadaki EvaluatorVersion öğeleri	Yes

PagedIndex

Dizin öğelerinin disk belleğine alınmış koleksiyonu

Name	Türü	Description	Zorunlu	Varsayılan
nextLink	Dize	Öğelerin sonraki sayfasına bağlantı	Hayır
value	Dizin dizisi	Bu sayfadaki Dizin öğeleri	Yes

PagedInsight

İçgörü öğelerinin disk belleğine alınmış koleksiyonu

Name	Türü	Description	Zorunlu	Varsayılan
nextLink	Dize	Öğelerin sonraki sayfasına bağlantı	Hayır
value	insight dizisi	Bu sayfadaki İçgörü öğeleri	Yes

PagedRedTeam

RedTeam öğelerinin disk belleğine alınmış koleksiyonu

Name	Türü	Description	Zorunlu	Varsayılan
nextLink	Dize	Öğelerin sonraki sayfasına bağlantı	Hayır
value	RedTeam dizisi	Bu sayfadaki RedTeam öğeleri	Yes

PagedSchedule

Zamanlama öğelerinin disk belleğine alınmış koleksiyonu

Name	Türü	Description	Zorunlu	Varsayılan
nextLink	Dize	Öğelerin sonraki sayfasına bağlantı	Hayır
value	Zamanlama dizisi	Bu sayfadaki Öğeleri zamanla	Yes

PagedScheduleRun

ScheduleRun öğelerinin disk belleğine alınmış koleksiyonu

Name	Türü	Description	Zorunlu	Varsayılan
nextLink	Dize	Öğelerin sonraki sayfasına bağlantı	Hayır
value	ScheduleRun dizisi	Bu sayfadaki ScheduleRun öğeleri	Yes

PendingUploadRequest

Bekleyen bir yükleme isteğini temsil eder.

Name	Türü	Description	Zorunlu	Varsayılan
Connectionname	Dize	Geçici SAS belirteci oluşturmak için kullanılacak Azure Depolama Hesabı bağlantı adı	Hayır
pendingUploadId	Dize	PendingUploadId sağlanmazsa, rastgele bir GUID kullanılır.	Hayır
pendingUploadType	enum	BlobReference desteklenen tek türdür. Olası değerler: BlobReference	Yes

PendingUploadResponse

Bekleyen bir yükleme isteğinin yanıtını temsil eder

Name	Türü	Description	Zorunlu	Varsayılan
blobReference	BlobReference	Blob başvuru ayrıntıları.	Yes
└─ blobUri	Dize	İstemcinin verileri karşıya yüklemesi için Blob URI yolu. Örnek: https://blob.windows.core.net/Container/Path	Yes
└─ kimlik bilgisi	SasCredential	Depolama hesabına erişmek için kimlik bilgileri.	Yes
└─ storageAccountArmId	Dize	Kullanılacak depolama hesabının ARM kimliği.	Yes
pendingUploadId	Dize	Bu yükleme isteğinin kimliği.	Yes
pendingUploadType	enum	BlobReference desteklenen tek türdür Olası değerler: BlobReference	Yes
version	Dize	Kullanıcı ilk yükleme oluşturulurken sürüm belirtmediyse oluşturulacak öğenin sürümü	Hayır

PromptAgentDefinition

İstem aracısı tanımı

Name	Türü	Description	Zorunlu	Varsayılan
instructions	dize (null atanabilir)	Modelin bağlamı içine eklenen bir sistem (veya geliştirici) iletisi.	Hayır
tür	enum	Olası değerler: prompt	Yes
model	Dize	Bu aracı için kullanılacak model dağıtımı.	Yes
rai_config	RaiConfig	Sorumlu Yapay Zeka (RAI) içerik filtreleme ve güvenlik özellikleri için yapılandırma.	Hayır
└─ rai_policy_name	Dize	Uygulanacak RAI ilkesinin adı.	Yes
reasoning	OpenAI.Reasoning (null atanabilir)	yalnızca gpt-5 ve o serisi modeller İçin yapılandırma seçenekleri mantık modelleri.	Hayır
└─ çaba	OpenAI.ReasoningEffort	Akıl yürütmeye yönelik çabayı kısıtlar mantık 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ır
└─ özet oluştur	enum	Olası değerler: auto, concise, detailed	Hayır
└─ özeti	enum	Olası değerler: auto, concise, detailed	Hayır
structured_inputs	Obje	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ır
sıcaklık	number	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 veya top_p değiştirmenizi öneririz, ancak ikisini birden değiştirmeyin.	Hayır	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ır
└─ biçimi	OpenAI.TextResponseFormatConfiguration	Modelin çıkış yapması gereken biçimi belirten bir nesne. { "type": "json_schema" }'yi yapılandırmak, Yapılandırılmış Çıkışları etkinleştirir. modelin sağlanan JSON şemanızla eşleşmesini sağlar. Daha fazla bilgi için burayı ziyaret edin 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ır
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ır
tools	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ır
top_p	number	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 veya temperature değiştirmenizi öneririz, ancak ikisini birden değiştirmeyin.	Hayır	1

PromptAgentDefinitionTextOptions

Modelden metin yanıtı için yapılandırma seçenekleri. Düz metin veya yapılandırılmış JSON verileri olabilir.

Name	Türü	Description	Zorunlu	Varsayılan
format	OpenAI.TextResponseFormatConfiguration	Modelin çıkış yapması gereken biçimi belirten bir nesne. { "type": "json_schema" }'yi yapılandırmak, Yapılandırılmış Çıkışları etkinleştirir. modelin sağlanan JSON şemanızla eşleşmesini sağlar. Daha fazla bilgi için burayı ziyaret edin 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ır

PromptBasedEvaluatorDefinition

İstem tabanlı değerlendirici

Name	Türü	Description	Zorunlu	Varsayılan
data_schema	Obje	Değerlendiricinin giriş verileri için JSON şeması (Taslak 2020-12). Bu, tür, özellikler, gerekli gibi parametreleri içerir.	Hayır
init_parameters	Obje	Değerlendiricinin giriş parametreleri için JSON şeması (Taslak 2020-12). Bu, tür, özellikler, gerekli gibi parametreleri içerir.	Hayır
metrics	Obje	Bu değerlendirici tarafından üretilen çıktı metriklerinin listesi	Hayır
prompt_text	Dize	Değerlendirme için kullanılan istem metni	Yes
type	enum	Olası değerler: prompt	Yes

ProtocolVersionRecord

Tek bir protokol ve sürümü için kayıt eşlemesi.

Name	Türü	Description	Zorunlu	Varsayılan
protocol	AgentProtocol		Yes
version	Dize	Protokolün sürüm dizesi, örneğin 'v0.1.1'.	Yes

RaiConfig

Sorumlu Yapay Zeka (RAI) içerik filtreleme ve güvenlik özellikleri için yapılandırma.

Name	Türü	Description	Zorunlu	Varsayılan
rai_policy_name	Dize	Uygulanacak RAI ilkesinin adı.	Yes

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	Schema
Hourly	HourlyRecurrenceSchedule
Daily	DailyRecurrenceSchedule
Weekly	WeeklyRecurrenceSchedule
Monthly	MonthlyRecurrenceSchedule

Name	Türü	Description	Zorunlu	Varsayılan
type	RecurrenceType	Yinelenme türü.	Yes

RecurrenceTrigger

Yinelenmeye dayalı tetikleyici.

Name	Türü	Description	Zorunlu	Varsayılan
endTime	Dize	ISO 8601 biçiminde yinelenme zamanlaması için bitiş saati.	Hayır
interval	integer	Yinelenme zamanlaması aralığı.	Yes
schedule	RecurrenceSchedule	Yinelenme zamanlama modeli.	Yes
└─ türü	RecurrenceType	Yinelenme zamanlaması için yinelenme türü.	Yes
startTime	Dize	ISO 8601 biçiminde yinelenme zamanlaması için başlangıç saati.	Hayır
timeZone	Dize	Yinelenme zamanlaması için saat dilimi.	Hayır	UTC
type	enum	Tetikleyicinin türü. Olası değerler: Recurrence	Yes

RecurrenceType

Yinelenme türü.

Property	Değer
Tanım	Yinelenme türü.
Türü	Dize
Değerler	Hourly Daily Weekly Monthly

RedTeam

Kırmızı takım detayları.

Name	Türü	Description	Zorunlu	Varsayılan
applicationScenario	Dize	Senaryoya özgü saldırılar oluşturmak için kırmızı takım işlemine yönelik uygulama senaryosu.	Hayır
attackStrategies	AttackStrategy dizisi	Saldırı stratejilerinin listesi veya saldırı stratejilerinin iç içe yerleştirilmiş listeleri.	Hayır
displayName	Dize	Kırmızı takım çalıştırmasının adı.	Hayır
kimlik	dize (salt okunur)	Kırmızı takım çalıştırmasının tanımlayıcısı.	Yes
numTurns	integer	Benzetimi yuvarlama sayısı.	Hayır
properties	Obje	Kırmızı takımın özellikleri. Etiketlerden farklı olarak özellikler yalnızca eklentidir. Bir özellik eklendikten sonra kaldırılamaz.	Hayır
risk Kategorileri	RiskCategory dizisi	Saldırı hedeflerinin oluşturulacağı risk kategorilerinin listesi.	Hayır
simulationOnly	boolean	Yalnızca simülasyon veya Simülasyon + Değerlendirme. Varsayılan false, true ise tarama konuşmanın değerlendirme sonucunu değil çıkışını oluşturur.	Hayır	Yanlış
durum	dize (salt okunur)	Kırmızı takımın durumu. Hizmete göre ayarlanır ve salt okunurdur.	Hayır
tags	Obje	Kırmızı takımın etiketleri. Özelliklerden farklı olarak etiketler tamamen değişebilir.	Hayır
target	TargetConfig	Hedef yapılandırma için soyut sınıf.	Yes
└─ türü	Dize	Model yapılandırmasının türü.	Yes

RedTeamEvalRunDataSource

Name	Türü	Description	Zorunlu	Varsayılan
item_generation_params	ItemGenerationParams	Öğe oluşturma işlemlerini denetlemek için kullanılan parametre kümesini temsil eder.	Yes
└─ türü	ItemGenerationParamsType	Kullanılacak öğe oluşturma parametrelerinin türü.	Yes
target	Hedef	Ayırıcı desteği olan hedefler için temel sınıf.	Yes
└─ türü	Dize	Hedefin türü.	Yes
type	enum	Veri kaynağının türü. Her zaman azure_ai_red_team. Olası değerler: azure_ai_red_team	Yes

RedTeamItemGenerationParams

Name	Türü	Description	Zorunlu	Varsayılan
attack_strategies	AttackStrategy dizisi	Kullanılacak saldırı stratejilerinin koleksiyonu.	Yes
num_turns	integer	Oyunda izin verilen dönüş sayısı.	Yes	20
type	enum	Öğe oluşturma parametrelerinin türü. Olası değerler: red_team	Yes

RedTeamSeedPromptsItemGenerationParams

Kırmızı takım çekirdek istemleri öğe oluşturma parametrelerini temsil eder.

Name	Türü	Description	Zorunlu	Varsayılan
attack_strategies	AttackStrategy dizisi	Kullanılacak saldırı stratejilerinin koleksiyonu.	Yes
num_turns	integer	Oyunda izin verilen dönüş sayısı.	Yes	20
kaynak	OpenAI.EvalJsonlFileContentSource		Yes
└─ içerik	OpenAI.EvalJsonlFileContentSourceContent dizisi	jsonl dosyasının içeriği.	Yes
└─ türü	enum	Jsonl kaynağının türü. Her zaman file_content. Olası değerler: file_content	Yes
type	enum	Her zaman red_team_seed_promptsolan öğe oluşturma parametrelerinin türü. Olası değerler: red_team_seed_prompts	Yes

RedTeamTaxonomyItemGenerationParams

Kırmızı takım taksonomisi öğesi oluşturma parametrelerini temsil eder.

Name	Türü	Description	Zorunlu	Varsayılan
attack_strategies	AttackStrategy dizisi	Kullanılacak saldırı stratejilerinin koleksiyonu.	Yes
num_turns	integer	Oyunda izin verilen dönüş sayısı.	Yes	20
kaynak	OpenAI.EvalJsonlFileContentSource		Yes
└─ içerik	OpenAI.EvalJsonlFileContentSourceContent dizisi	jsonl dosyasının içeriği.	Yes
└─ türü	enum	Jsonl kaynağının türü. Her zaman file_content. Olası değerler: file_content	Yes
type	enum	Her zaman red_team_taxonomyolan öğe oluşturma parametrelerinin türü. Olası değerler: red_team_taxonomy	Yes

ResponseRetrievalItemGenerationParams

Yanıt alma öğesi oluşturma parametrelerini temsil eder.

Name	Türü	Description	Zorunlu	Varsayılan
veri eşleme	Obje	Sohbet geçmişini almak için gereken kaynak alanlardan response_id alanına eşleme.	Yes
max_num_turns	integer	Değerlendirilecek sohbet geçmişinin maksimum dönüş sayısı.	Yes
kaynak	OpenAI.EvalJsonlFileContentSource veya OpenAI.EvalJsonlFileIdSource	JSONL içeriğinin okunduğu kaynak.	Yes
type	enum	Her zaman response_retrievalolan öğe oluşturma parametrelerinin türü. Olası değerler: response_retrieval	Yes

RiskCategory

Saldırı hedefi için risk kategorisi.

Property	Değer
Tanım	Saldırı hedefi için risk kategorisi.
Türü	Dize
Değerler	HateUnfairness Violence Sexual SelfHarm ProtectedMaterial CodeVulnerability UngroundedAttributes ProhibitedActions SensitiveDataLeakage TaskAdherence

SASCredentials

Paylaşılan Erişim İmzası (SAS) kimlik bilgisi tanımı

Name	Türü	Description	Zorunlu	Varsayılan
SAS	dize (salt okunur)	SAS belirteci	Hayır
type	enum	Kimlik türü Olası değerler: SAS	Yes

Sampletype

Analizde kullanılan numunenin türü.

Property	Değer
Tanım	Analizde kullanılan numunenin türü.
Türü	Dize
Değerler	EvaluationResultSample

SasCredential

SAS Kimlik Bilgisi tanımı

Name	Türü	Description	Zorunlu	Varsayılan
sasUri	dize (salt okunur)	SAS uri'si	Yes
type	enum	Kimlik bilgisi türü Olası değerler: SAS	Yes

Schedule

Zamanlama modeli.

Name	Türü	Description	Zorunlu	Varsayılan
Açıklama	Dize	Zamanlamanın açıklaması.	Hayır
displayName	Dize	Zamanlamanın adı.	Hayır
enabled	boolean	Zamanlamanın durumu etkin.	Yes
kimlik	dize (salt okunur)	Zamanlamanın tanımlayıcısı.	Yes
properties	Obje	Zamanlamanın özellikleri. Etiketlerden farklı olarak özellikler yalnızca eklentidir. Bir özellik eklendikten sonra kaldırılamaz.	Hayır
provisioningStatus	ScheduleProvisioningStatus (salt okunur)	Sağlama durumunu zamanlayın.	Hayır
sistem verileri	object (salt okunur)	Kaynak için sistem meta verileri.	Yes
tags	Obje	Zamanlama etiketleri. Özelliklerden farklı olarak etiketler tamamen değişebilir.	Hayır
görev	ScheduleTask	Zamanlama görev modeli.	Yes
└─ yapılandırması	Obje	Görevin yapılandırması.	Hayır
└─ türü	ScheduleTaskType	Görevin türü.	Yes
trigger	Trigger	Zamanlamanın tetikleyicisi için temel model.	Yes
└─ türü	TriggerType	Tetikleyicinin türü.	Yes

ScheduleProvisioningStatus

Sağlama durumunu zamanlayın.

Property	Değer
Tanım	Sağlama durumunu zamanlayın.
Türü	Dize
Değerler	Creating Updating Deleting Succeeded Failed

ScheduleRun

Zamanlama çalıştırma modeli.

Name	Türü	Description	Zorunlu	Varsayılan
hata	dize (salt okunur)	Zamanlama çalıştırması için hata bilgileri.	Hayır
kimlik	dize (salt okunur)	Zamanlama çalıştırmasının tanımlayıcısı.	Yes
properties	object (salt okunur)	Zamanlama çalıştırmasının özellikleri.	Yes
scheduleId	Dize	Zamanlamanın tanımlayıcısı.	Yes
başarı	boole (salt okunur)	Zamanlama çalıştırmasının başarı durumunu tetikleme.	Yes
triggerTime	Dize	Zamanlama çalıştırmasının tetikleme zamanı.	Hayır

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	Schema
Evaluation	EvaluationScheduleTask
Insight	InsightScheduleTask

Name	Türü	Description	Zorunlu	Varsayılan
configuration	Obje	Görevin yapılandırması.	Hayır
type	ScheduleTaskType	Görevin türü.	Yes

ScheduleTaskType

Görevin türü.

Property	Değer
Tanım	Görevin türü.
Türü	Dize
Değerler	Evaluation Insight

SharepointGroundingToolParameters

Sharepoint topraklama aracı parametreleri.

Name	Türü	Description	Zorunlu	Varsayılan
project_connections	ToolProjectConnection dizisi	Bu ara çubuğuna bağlı project bağlantıları. En fazla 1 bağlantı olabilir aracına bağlı kaynak.	Hayır

SharepointPreviewTool

Aracıyı yapılandırmak için kullanılan sharepoint aracının giriş tanımı bilgileri.

Name	Türü	Description	Zorunlu	Varsayılan
sharepoint_grounding_preview	SharepointGroundingToolParameters	Sharepoint topraklama aracı parametreleri.	Yes
└─ project_connections	ToolProjectConnection dizisi	Bu ara çubuğuna bağlı project bağlantıları. En fazla 1 bağlantı olabilir aracına bağlı kaynak. Kısıtlamalar: maxItems: 1	Hayır
type	enum	Nesne türü, ki her zaman 'sharepoint_grounding_preview' olur. Olası değerler: sharepoint_grounding_preview	Yes

Sku

Sku bilgileri

Name	Türü	Description	Zorunlu	Varsayılan
capacity	integer	Sku kapasitesi	Yes
family	Dize	Sku ailesi	Yes
name	Dize	Sku adı	Yes
size	Dize	Sku boyutu	Yes
tier	Dize	Sku katmanı	Yes

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

Name	Türü	Description	Zorunlu	Varsayılan
default_value		Çalışma zamanı değeri sağlanmamışsa giriş için varsayılan değer.	Hayır
Açıklama	Dize	Girişin okunabilir bir açıklaması.	Hayır
required	boolean	Aracı çağrıldığında giriş özelliğinin gerekli olup olmadığı.	Hayır	Yanlış
schema	Obje	Yapılandırılmış giriş için JSON şeması (isteğe bağlı).	Hayır

StructuredOutputDefinition

Aracı tarafından üretilebilen yapılandırılmış bir çıkış.

Name	Türü	Description	Zorunlu	Varsayılan
Açıklama	Dize	Yaymak için çıkışın açıklaması. Modeli tarafından çıkışın ne zaman yayılabileceğini belirlemek için kullanılır.	Yes
name	Dize	Yapılandırılmış çıkışın adı.	Yes
schema	Obje	Yapılandırılmış çıktı için JSON şeması.	Yes
Kesin	boole değeri (null atanabilir)	Katı doğrulamanın zorunlu kılınıp uygulanmayacağı. Varsayılan true.	Yes

StructuredOutputsOutputItem

Name	Türü	Description	Zorunlu	Varsayılan
agent_reference	AgentReference		Hayır
└─ ad	Dize	Aracının adı. Kısıtlamalar: maxLength: 256	Yes
└─ türü	enum	Olası değerler: agent_reference	Yes
└─ sürümü	Dize	Aracının sürüm tanımlayıcısı.	Hayır
output		Yanıt sırasında yakalanan yapılandırılmış çıkış.	Yes
response_id	Dize	Öğenin oluşturulduğu yanıt.	Hayır
type	enum	Olası değerler: structured_outputs	Yes

SyntheticDataGenerationPreviewEvalRunDataSource

Test amacıyla oluşturulan yapay verileri temel alan değerlendirme çalıştırmaları için bir veri kaynağını temsil eder.

Name	Türü	Description	Zorunlu	Varsayılan
input_mesajları	OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate		Hayır
└─ şablon	object dizisi veya OpenAI.EvalItem		Yes
└─ türü	enum	Olası değerler: template	Yes
item_generation_params	SyntheticDataGenerationPreviewItemGenerationParams		Yes
└─ model_deployment_name	Dize	Yapay veri oluşturmak için kullanılacak model dağıtımının adı.	Yes
└─ 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ır
└─ output_dataset_name	Dize	Oluşturulan yapay verilerin depolanacağı çıkış veri kümesinin adı. Sağlanmazsa, hizmet otomatik olarak veri kümesi adı oluşturur.	Hayır
└─ istemi	Dize	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ır
└─ samples_count	integer	Oluşturulacak en fazla veri örneği sayısı.	Yes
└─ kaynaklar	OpenAI.EvalJsonlFileIdSource dizisi	Veri oluşturma için isteğe bağlı çekirdek veri içerik kaynağı dosyaları.	Yes
└─ türü	enum	Öğe oluşturma parametrelerinin türü. Olası değerler: synthetic_data_gen_preview	Yes
target	Hedef	Ayırıcı desteği olan hedefler için temel sınıf.	Yes
└─ türü	Dize	Hedefin türü.	Yes
type	enum	Her zaman azure_ai_synthetic_data_gen_previewveri kaynağı türü. Olası değerler: azure_ai_synthetic_data_gen_preview	Yes

SyntheticDataGenerationPreviewItemGenerationParams

Name	Türü	Description	Zorunlu	Varsayılan
model_dağıtım_adı	Dize	Yapay veri oluşturmak için kullanılacak model dağıtımının adı.	Yes
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ır
output_dataset_name	Dize	Oluşturulan yapay verilerin depolanacağı çıkış veri kümesinin adı. Sağlanmazsa, hizmet otomatik olarak veri kümesi adı oluşturur.	Hayır
prompt	Dize	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ır
samples_count	integer	Oluşturulacak en fazla veri örneği sayısı.	Yes
Kaynak	OpenAI.EvalJsonlFileIdSource dizisi	Veri oluşturma için isteğe bağlı çekirdek veri içerik kaynağı dosyaları.	Yes
type	enum	Öğe oluşturma parametrelerinin türü. Olası değerler: synthetic_data_gen_preview	Yes

Target

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	Schema
azure_ai_model	AzureAIModelTarget
azure_ai_agent	AzureAIAgentTarget

Name	Türü	Description	Zorunlu	Varsayılan
type	Dize	Hedefin türü.	Yes

TargetCompletionEvalRunDataSource

Hedef tabanlı tamamlama değerlendirme yapılandırması için bir veri kaynağını temsil eder.

Name	Türü	Description	Zorunlu	Varsayılan
input_mesajları	OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference		Hayır
└─ öğe_referansı	Dize		Yes
└─ türü	enum	Olası değerler: item_reference	Yes
kaynak	OpenAI.EvalJsonlFileContentSource veya OpenAI.EvalJsonlFileIdSource	Satır içi veya dosya verileri için kaynak yapılandırma.	Yes
target	Hedef	Ayırıcı desteği olan hedefler için temel sınıf.	Yes
└─ türü	Dize	Hedefin türü.	Yes
type	enum	Her zaman azure_ai_target_completionsveri kaynağı türü. Olası değerler: azure_ai_target_completions	Yes

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	Schema
AzureOpenAIModel	AzureOpenAIModelConfiguration

Name	Türü	Description	Zorunlu	Varsayılan
type	Dize	Model yapılandırmasının türü.	Yes

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	Schema
azure_ai_model	AzureAIModelTargetUpdate
azure_ai_agent	AzureAIAgentTargetUpdate

Name	Türü	Description	Zorunlu	Varsayılan
type	Dize	Hedefin türü.	Yes

TaksonomiKategorisi

Taksonomi kategori tanımı.

Name	Türü	Description	Zorunlu	Varsayılan
Açıklama	Dize	Taksonomi kategorisinin açıklaması.	Hayır
kimlik	Dize	Taksonomi kategorisinin benzersiz tanımlayıcısı.	Yes
name	Dize	Taksonomi kategorisinin adı.	Yes
properties	Obje	Taksonomi kategorisi için ek özellikler.	Hayır
riskCategory	RiskCategory	Saldırı hedefi için risk kategorisi.	Yes
Alt kategori	TaxonomySubCategory dizisi	Taksonomi alt kategorilerinin listesi.	Yes

TaxonomySubCategory

Taksonomi alt kategori tanımı.

Name	Türü	Description	Zorunlu	Varsayılan
Açıklama	Dize	Taksonomi alt kategorisinin açıklaması.	Hayır
enabled	boolean	Bu alt kategori altındaki taksonomi öğelerinin listesi.	Yes
kimlik	Dize	Taksonomi alt kategorisinin benzersiz tanımlayıcısı.	Yes
name	Dize	Taksonomi alt kategorisinin adı.	Yes
properties	Obje	Taksonomi alt kategorisi için ek özellikler.	Hayır

ToolDescription

Bir aracı tarafından kullanılabilecek bir aracın açıklaması.

Name	Türü	Description	Zorunlu	Varsayılan
Açıklama	Dize	Aracın amacının kısa bir açıklaması.	Hayır
name	Dize	Araç adı.	Hayır

ToolProjectConnection

project bağlantı kaynağı.

Name	Türü	Description	Zorunlu	Varsayılan
project_connection_id	Dize	ToolProjectConnectionList içindeki bu aracı ekli bir proje bağlantısı.	Yes

TracesPreviewEvalRunDataSource

Application Insights'ta depolanan Aracı izlemeleri üzerinde çalışan değerlendirme çalıştırmaları için bir veri kaynağını temsil eder.

Name	Türü	Description	Zorunlu	Varsayılan
agent_id	Dize	Değerlendirme için izlemeleri filtrelemek için kullanılan aracı kimliği.	Hayır
agent_name	Dize	Değerlendirme için izlemeleri filtrelemek için kullanılan aracı adı.	Hayır
bitiş_zamanı	integer	İzleme sorgusu penceresinin sonunu işaret eden Unix zaman damgası (saniye olarak). Varsayılan olarak geçerli saati kullanır.	Hayır
ingestion_delay_seconds	integer	İzlemeleri sorgularken alma için uygulanacak gecikme.	Hayır	300
lookback_hours	integer	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ır	168
max_traces	integer	Değerlendirme için alınan izlemelere uygulanan örnekleme sınırı.	Hayır	1000
trace_ids	dize dizisi	Değerlendirilmesi gereken Aracı izleme tanımlayıcıları koleksiyonu.	Hayır
type	enum	Her zaman azure_ai_traces_previewveri kaynağı türü. Olası değerler: azure_ai_traces_preview	Yes

TreatmentEffectType

Tedavi Etki Türü.

Property	Değer
Tanım	Tedavi Etki Türü.
Türü	Dize
Değerler	TooFewSamples Inconclusive Changed Improved Degraded

Trigger

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	Schema
Cron	CronTrigger
Recurrence	RecurrenceTrigger
OneTime	OneTimeTrigger

Name	Türü	Description	Zorunlu	Varsayılan
type	TriggerType	Tetikleyicinin türü.	Yes

Tetikleme Türü

Tetikleyicinin türü.

Property	Değer
Tanım	Tetikleyicinin türü.
Türü	Dize
Değerler	Cron Recurrence OneTime

UpdateAgentFromManifestRequest

Name	Türü	Description	Zorunlu	Varsayılan
Açıklama	Dize	Aracının insan tarafından okunabilir bir açıklaması. Kısıtlamalar: maxLength: 512	Hayır
manifest_id	Dize	Aracı sürümünü içeri aktaracak bildirim kimliği.	Yes
metadata	Obje	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu olabilir 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ır
parameter_values	Obje	Bildirime yapılan ve tam olarak gerçekleştirilmiş bir Aracı ile sonuçlanacak girişler.	Yes

UpdateAgentRequest

Name	Türü	Description	Zorunlu	Varsayılan
tanım	AgentDefinition		Yes
└─ tür	AgentKind		Yes
└─ rai_config	RaiConfig	Sorumlu Yapay Zeka (RAI) içerik filtreleme ve güvenlik özellikleri için yapılandırma.	Hayır
Açıklama	Dize	Aracının insan tarafından okunabilir bir açıklaması. Kısıtlamalar: maxLength: 512	Hayır
metadata	Obje	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu olabilir 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ır

UpdateEvalParametersBody

Name	Türü	Description	Zorunlu	Varsayılan
metadata	OpenAI.Metadata (null atanabilir)	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu olabilir 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ır
name	Dize		Hayır
properties	Obje	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ır

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.

Name	Türü	Description	Zorunlu	Varsayılan
içerik	Dize	Belleğin içeriği.	Yes
tür	enum	Bellek öğesinin türü. Olası değerler: user_profile	Yes
memory_id	Dize	Bellek öğesinin benzersiz kimliği.	Yes
scope	Dize	Kullanıcı kimliği gibi anıları mantıksal olarak gruplandıran ve yalıtan ad alanı.	Yes
updated_at	integer	Bellek öğesinin son güncelleme zamanı.	Yes

WebSearchConfiguration

bing özel arama için web araması yapılandırması

Name	Türü	Description	Zorunlu	Varsayılan
instance_name	Dize	Yapılandırmaya verilen özel yapılandırma örneğinin adı.	Yes
project_connection_id	Dize	bing özel arama ile topraklama için Project bağlantı kimliği	Yes

WeeklyRecurrenceSchedule

Haftalık yineleme programı.

Name	Türü	Description	Zorunlu	Varsayılan
Haftanın Günleri	DayOfWeek dizisi	Yinelenme zamanlaması için haftanın günleri.	Yes
type	enum	Haftalık yinelenme türü. Olası değerler: Weekly	Yes

WorkflowActionOutputItem

Name	Türü	Description	Zorunlu	Varsayılan
action_id	Dize	Eylem için benzersiz tanımlayıcı.	Yes
agent_reference	AgentReference		Hayır
└─ ad	Dize	Aracının adı. Kısıtlamalar: maxLength: 256	Yes
└─ türü	enum	Olası değerler: agent_reference	Yes
└─ sürümü	Dize	Aracının sürüm tanımlayıcısı.	Hayır
tür	Dize	CSDL eyleminin türü (örneğin, 'SetVariable', 'InvokeAzureAgent').	Yes
parent_action_id	Dize	Bu iç içe bir eylemse, üst eylemin kimliği.	Hayır
previous_action_id	Dize	Bu eylem başka bir eylemden sonra gelirse, önceki eylemin kimliği.	Hayır
response_id	Dize	Öğenin oluşturulduğu yanıt.	Hayır
durum	enum	Eylemin durumu (örneğin, 'in_progress', 'tamamlandı', 'başarısız', 'iptal edildi'). Olası değerler: completed, failed, in_progress, cancelled	Yes
type	enum	Olası değerler: workflow_action	Yes

WorkflowAgentDefinition

İş akışı aracısı tanımı.

Name	Türü	Description	Zorunlu	Varsayılan
tür	enum	Olası değerler: workflow	Yes
rai_config	RaiConfig	Sorumlu Yapay Zeka (RAI) içerik filtreleme ve güvenlik özellikleri için yapılandırma.	Hayır
└─ rai_policy_name	Dize	Uygulanacak RAI ilkesinin adı.	Yes
iş akışı	Dize	İş akışının CSDL YAML tanımı.	Hayır

integer

Tür: tamsayı

Biçim: int64