Microsoft Foundry Project REST başvurusu

API Sürümü: 2025-11-15-preview

Aracılar - aracı oluşturma

POST {endpoint}/agents?api-version=2025-11-15-preview

Aracıyı oluşturur.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

İstek Gövdesi

İçerik Türü: application/json

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Aracılar - liste aracıları

GET {endpoint}/agents?api-version=2025-11-15-preview

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

URI Parametreleri

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

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Aracılar - aracı alma

GET {endpoint}/agents/{agent_name}?api-version=2025-11-15-preview

Aracıyı alır.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
agent_name	path	Evet	String	Alınacak aracının adı.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

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

POST {endpoint}/agents/{agent_name}?api-version=2025-11-15-preview

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
agent_name	path	Evet	String	Alınacak aracının adı.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

İstek Gövdesi

İçerik Türü: application/json

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Aracılar - aracıyı silme

DELETE {endpoint}/agents/{agent_name}?api-version=2025-11-15-preview

Aracıyı siler.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
agent_name	path	Evet	String	Silinecek aracının adı.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

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

POST {endpoint}/agents/{agent_name}/import?api-version=2025-11-15-preview

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
agent_name	path	Evet	String	Güncelleştirilecek aracının adı.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

İstek Gövdesi

İçerik Türü: application/json

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

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

GET {endpoint}/agents/{agent_name}/operations?api-version=2025-11-15-preview

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

URI Parametreleri

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

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

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

GET {endpoint}/agents/{agent_name}/operations/{operation_id}?api-version=2025-11-15-preview

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
agent_name	path	Evet	String	Aracının adı.
operation_id	path	Evet	String	İşlem kimliği.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

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

POST {endpoint}/agents/{agent_name}/versions?api-version=2025-11-15-preview

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

URI Parametreleri

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

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

İstek Gövdesi

İçerik Türü: application/json

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

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

GET {endpoint}/agents/{agent_name}/versions?api-version=2025-11-15-preview

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

URI Parametreleri

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

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

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

GET {endpoint}/agents/{agent_name}/versions/{agent_version}?api-version=2025-11-15-preview

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
agent_name	path	Evet	String	Alınacak aracının adı.
agent_version	path	Evet	String	Alınacak aracı sürümü.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

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

DELETE {endpoint}/agents/{agent_name}/versions/{agent_version}?api-version=2025-11-15-preview

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
agent_name	path	Evet	String	Silinecek aracının adı.
agent_version	path	Evet	String	Silinecek aracı sürümü

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

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

GET {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default?api-version=2025-11-15-preview

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
agent_name	path	Evet	String	Aracının adı.
agent_version	path	Evet	String	Aracının sürümü.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

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

GET {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default/operations?api-version=2025-11-15-preview

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

URI Parametreleri

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

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

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

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:delete?api-version=2025-11-15-preview

Bir aracının belirli bir sürümü için kapsayıcıyı silin. Kapsayıcı yoksa, işlem no-opolur. İşlem uzun süre çalışan bir işlemdir. Azure REST API'lerinde uzun sü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

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
agent_name	path	Evet	String	Aracının adı.
agent_version	path	Evet	String	Aracının sürümü.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 202

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

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

Durum Kodu: varsayılan

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

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

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

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:start?api-version=2025-11-15-preview

Bir aracının belirli bir sürümü için kapsayıcı başlatın. Kapsayıcı zaten çalışıyorsa, işlem no-opolur. İşlem uzun süre çalışan bir işlemdir. Azure REST API'lerinde uzun sü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

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
agent_name	path	Evet	String	Aracının adı.
agent_version	path	Evet	String	Aracının sürümü.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

İstek Gövdesi

İçerik Türü: application/json

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

Yanıtlar

Durum Kodu: 202

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

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

Durum Kodu: varsayılan

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

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

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

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:stop?api-version=2025-11-15-preview

Aracının belirli bir sürümü için kapsayıcıyı durdurun. Kapsayıcı çalışmıyorsa veya zaten durdurulmuşsa, işlem no-opolur. İşlem uzun süre çalışan bir işlemdir. Azure REST API'lerinde uzun sü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

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
agent_name	path	Evet	String	Aracının adı.
agent_version	path	Evet	String	Aracının sürümü.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 202

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

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

Durum Kodu: varsayılan

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

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

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

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:update?api-version=2025-11-15-preview

Bir aracının belirli bir sürümü için kapsayıcıyı güncelleştirme. Kapsayıcı çalışmıyorsa, işlem no-opolur. İşlem uzun süre çalışan bir işlemdir. Azure REST API'lerinde uzun sü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

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
agent_name	path	Evet	String	Aracının adı.
agent_version	path	Evet	String	Aracının sürümü.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

İstek Gövdesi

İçerik Türü: application/json

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

Yanıtlar

Durum Kodu: 202

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

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

Durum Kodu: varsayılan

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

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

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

POST {endpoint}/agents/{agent_name}/versions:import?api-version=2025-11-15-preview

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

URI Parametreleri

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

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

İstek Gövdesi

İçerik Türü: application/json

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Aracılar - bildirimden aracı oluşturma

POST {endpoint}/agents:import?api-version=2025-11-15-preview

Bildirimden bir aracı oluşturur.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

İstek Gövdesi

İçerik Türü: application/json

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Bağlantılar - liste

GET {endpoint}/connections?api-version=2025-11-15-preview

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
connectionType	soru	Hayı		Bu belirli türdeki bağlantıları listeleme
defaultConnection	soru	Hayı	Boolean	Varsayılan bağlantı olan bağlantıları listeleme
x-ms-client-request-id	üstbilgi	Hayı		İstek için opak, genel olarak benzersiz, istemci tarafından oluşturulan bir dize tanımlayıcısı.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Bağlantılar - get

GET {endpoint}/connections/{name}?api-version=2025-11-15-preview

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
name	path	Evet	String	Kullanıcı tarafından sağlanan bağlantının kolay adı.
x-ms-client-request-id	üstbilgi	Hayı		İstek için opak, genel olarak benzersiz, istemci tarafından oluşturulan bir dize tanımlayıcısı.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Bağlantılar - kimlik bilgileriyle alma

POST {endpoint}/connections/{name}/getConnectionWithCredentials?api-version=2025-11-15-preview

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
name	path	Evet	String	Kullanıcı tarafından sağlanan bağlantının kolay adı.
x-ms-client-request-id	üstbilgi	Hayı		İstek için opak, genel olarak benzersiz, istemci tarafından oluşturulan bir dize tanımlayıcısı.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Veri kümeleri - en son liste

GET {endpoint}/datasets?api-version=2025-11-15-preview

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Veri kümeleri - liste sürümleri

GET {endpoint}/datasets/{name}/versions?api-version=2025-11-15-preview

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
name	path	Evet	String	Kaynağın adı

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Veri kümeleri - sürüm alma

GET {endpoint}/datasets/{name}/versions/{version}?api-version=2025-11-15-preview

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
name	path	Evet	String	Kaynağın adı
version	path	Evet	String	Alınacak DatasetVersion'ın belirli sürüm kimliği.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

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

DELETE {endpoint}/datasets/{name}/versions/{version}?api-version=2025-11-15-preview

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
name	path	Evet	String	Kaynağın adı
version	path	Evet	String	Silinecek DatasetVersion sürümü.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 204

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

Durum Kodu: varsayılan

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

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

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

PATCH {endpoint}/datasets/{name}/versions/{version}?api-version=2025-11-15-preview

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
name	path	Evet	String	Kaynağın adı
version	path	Evet	String	Oluşturulacak veya güncelleştirilecek DatasetVersion'ın belirli sürüm kimliği.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

İstek Gövdesi

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

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: 201

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

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

Durum Kodu: varsayılan

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

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

Veri kümeleri - kimlik bilgilerini alma

POST {endpoint}/datasets/{name}/versions/{version}/credentials?api-version=2025-11-15-preview

Veri kümesi sürümüyle ilişkili depolama hesabına erişmek için SAS kimlik bilgilerini alın.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
name	path	Evet	String	Kaynağın adı
version	path	Evet	String	Üzerinde çalışılacak DatasetVersion'ın belirli sürüm kimliği.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

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

POST {endpoint}/datasets/{name}/versions/{version}/startPendingUpload?api-version=2025-11-15-preview

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
name	path	Evet	String	Kaynağın adı
version	path	Evet	String	Üzerinde çalışılacak DatasetVersion'ın belirli sürüm kimliği.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
connectionName (bağlantıadı)	String	Geçici SAS belirteci oluşturmak için kullanılacak Azure Depolama Hesabı bağlantı adı	Hayı
pendingUploadId	String	PendingUploadId sağlanmazsa, rastgele bir GUID kullanılır.	Hayı
pendingUploadType	enum	BlobReference desteklenen tek türdür. Olası değerler: BlobReference	Evet

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Dağıtımlar - liste

GET {endpoint}/deployments?api-version=2025-11-15-preview

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
modelPublisher	soru	Hayı	String	Modelleri filtreleme ölçütü olarak model yayımcısı
modelName	soru	Hayı	String	Modelleri filtreleme ölçütü olarak kullanmak için model adı (yayıncıya özel ad)
deploymentType	soru	Hayı		Listeyi filtreleme ölçütü olarak kullanılacak dağıtım türü
x-ms-client-request-id	üstbilgi	Hayı		İstek için opak, genel olarak benzersiz, istemci tarafından oluşturulan bir dize tanımlayıcısı.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Dağıtımlar - get

GET {endpoint}/deployments/{name}?api-version=2025-11-15-preview

Dağıtılan bir model edinin.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
name	path	Evet	String	Dağıtımın adı
x-ms-client-request-id	üstbilgi	Hayı		İstek için opak, genel olarak benzersiz, istemci tarafından oluşturulan bir dize tanımlayıcısı.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Değerlendirme kuralları - liste

GET {endpoint}/evaluationrules?api-version=2025-11-15-preview

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
actionType	soru	Hayı		Değerlendirme kuralı türüne göre filtreleyin.
ajan adı	soru	Hayı	String	Temsilci adına göre filtreleyin.
etkinleştirildi	soru	Hayı	Boolean	Etkin duruma göre filtreleyin.
x-ms-client-request-id	üstbilgi	Hayı		İstek için opak, genel olarak benzersiz, istemci tarafından oluşturulan bir dize tanımlayıcısı.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Değerlendirme kuralları - get

GET {endpoint}/evaluationrules/{id}?api-version=2025-11-15-preview

Bir değerlendirme kuralı alın.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
kimlik	path	Evet	String	Değerlendirme kuralı için benzersiz tanımlayıcı.
x-ms-client-request-id	üstbilgi	Hayı		İstek için opak, genel olarak benzersiz, istemci tarafından oluşturulan bir dize tanımlayıcısı.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Değerlendirme kuralları - silme

DELETE {endpoint}/evaluationrules/{id}?api-version=2025-11-15-preview

Değerlendirme kuralını silin.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
kimlik	path	Evet	String	Değerlendirme kuralı için benzersiz tanımlayıcı.
x-ms-client-request-id	üstbilgi	Hayı		İstek için opak, genel olarak benzersiz, istemci tarafından oluşturulan bir dize tanımlayıcısı.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 204

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

Durum Kodu: varsayılan

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

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

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

PUT {endpoint}/evaluationrules/{id}?api-version=2025-11-15-preview

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
kimlik	path	Evet	String	Değerlendirme kuralı için benzersiz tanımlayıcı.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

İstek Gövdesi

İçerik Türü: application/json

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: 201

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

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

Durum Kodu: varsayılan

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

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

Değerlendirme taksonomileri - liste

GET {endpoint}/evaluationtaxonomies?api-version=2025-11-15-preview

Liste değerlendirme taksonomileri

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
inputName	soru	Hayı	String	Değerlendirme giriş adına göre filtreleyin.
inputType	soru	Hayı	String	Taksonomi giriş türüne göre filtreleyin.
x-ms-client-request-id	üstbilgi	Hayı		İstek için opak, genel olarak benzersiz, istemci tarafından oluşturulan bir dize tanımlayıcısı.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Değerlendirme taksonomileri - get

GET {endpoint}/evaluationtaxonomies/{name}?api-version=2025-11-15-preview

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
name	path	Evet	String	Kaynağın adı
x-ms-client-request-id	üstbilgi	Hayı		İstek için opak, genel olarak benzersiz, istemci tarafından oluşturulan bir dize tanımlayıcısı.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Değerlendirme taksonomileri - silme

DELETE {endpoint}/evaluationtaxonomies/{name}?api-version=2025-11-15-preview

Bir değerlendirme taksonomisini ada göre silin.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
name	path	Evet	String	Kaynağın adı
x-ms-client-request-id	üstbilgi	Hayı		İstek için opak, genel olarak benzersiz, istemci tarafından oluşturulan bir dize tanımlayıcısı.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 204

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

Durum Kodu: varsayılan

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

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

Değerlendirme taksonomileri - oluşturma

PUT {endpoint}/evaluationtaxonomies/{name}?api-version=2025-11-15-preview

Bir değerlendirme taksonomisi oluşturun.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
name	path	Evet	String	Değerlendirme taksonomisinin adı.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

İstek Gövdesi

İçerik Türü: application/json

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: 201

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

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

Durum Kodu: varsayılan

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

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

Değerlendirme taksonomileri - güncelleştirme

PATCH {endpoint}/evaluationtaxonomies/{name}?api-version=2025-11-15-preview

Değerlendirme taksonomisini güncelleştirin.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
name	path	Evet	String	Değerlendirme taksonomisinin adı.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

İstek Gövdesi

İçerik Türü: application/json

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

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

GET {endpoint}/evaluators?api-version=2025-11-15-preview

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

URI Parametreleri

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

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Değerlendiriciler - liste sürümleri

GET {endpoint}/evaluators/{name}/versions?api-version=2025-11-15-preview

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

URI Parametreleri

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

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

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

POST {endpoint}/evaluators/{name}/versions?api-version=2025-11-15-preview

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
name	path	Evet	String	Kaynağın adı

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

İstek Gövdesi

İçerik Türü: application/json

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

Yanıtlar

Durum Kodu: 201

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

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

Durum Kodu: varsayılan

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

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

Değerlendiriciler - sürümü alma

GET {endpoint}/evaluators/{name}/versions/{version}?api-version=2025-11-15-preview

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
name	path	Evet	String	Kaynağın adı
version	path	Evet	String	Alınacak EvaluatorVersion'ın belirli sürüm kimliği.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Değerlendiriciler - sürümü silme

DELETE {endpoint}/evaluators/{name}/versions/{version}?api-version=2025-11-15-preview

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
name	path	Evet	String	Kaynağın adı
version	path	Evet	String	Silinecek EvaluatorVersion sürümü.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 204

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

Durum Kodu: varsayılan

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

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

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

PATCH {endpoint}/evaluators/{name}/versions/{version}?api-version=2025-11-15-preview

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
name	path	Evet	String	Kaynağın adı
version	path	Evet	String	Güncelleştirilecek EvaluatorVersion sürümü.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

İstek Gövdesi

İçerik Türü: application/json

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Dizinler - en son liste

GET {endpoint}/indexes?api-version=2025-11-15-preview

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Dizinler - liste sürümleri

GET {endpoint}/indexes/{name}/versions?api-version=2025-11-15-preview

Verilen Dizinin tüm sürümlerini listeleyin

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
name	path	Evet	String	Kaynağın adı

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Dizinler - sürüm alma

GET {endpoint}/indexes/{name}/versions/{version}?api-version=2025-11-15-preview

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
name	path	Evet	String	Kaynağın adı
version	path	Evet	String	Alınacak Dizinin belirli sürüm kimliği.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Dizinler - sürümü silme

DELETE {endpoint}/indexes/{name}/versions/{version}?api-version=2025-11-15-preview

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
name	path	Evet	String	Kaynağın adı
version	path	Evet	String	Silinecek Dizin sürümü.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 204

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

Durum Kodu: varsayılan

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

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

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

PATCH {endpoint}/indexes/{name}/versions/{version}?api-version=2025-11-15-preview

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
name	path	Evet	String	Kaynağın adı
version	path	Evet	String	Oluşturulacak veya güncelleştirilecek Dizinin belirli sürüm kimliği.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

İstek Gövdesi

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

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: 201

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

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

Durum Kodu: varsayılan

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

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

İçgörüler - oluşturma

POST {endpoint}/insights?api-version=2025-11-15-preview

İçgörüler Oluşturun

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
Yinelenebilirlik-Request-ID	üstbilgi	Hayı	String	İstek iktidarını sağlamak için benzersiz, istemci tarafından oluşturulan tanımlayıcı. Yinelenen değerlendirmeleri önlemek için yeniden denemeler için aynı kimliği kullanın.
Yinelenebilirlik-First-Sent	üstbilgi	Hayı	String	Bu isteğin ilk kez ne zaman başlatıldığını gösteren zaman damgası. İdempotens kontrolü için repeatability-request-id ile birlikte kullanılır.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

İstek Gövdesi

İçerik Türü: application/json

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

Yanıtlar

Durum Kodu: 201

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

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

Durum Kodu: varsayılan

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

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

İçgörüler - liste

GET {endpoint}/insights?api-version=2025-11-15-preview

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
type	soru	Hayı		Analiz türüne göre filtreleyin.
evalId	soru	Hayı	String	Değerlendirme kimliğine göre filtreleyin.
runId	soru	Hayı	String	Değerlendirme çalıştırma kimliğine göre filtreleyin.
ajan adı	soru	Hayı	String	Temsilci adına göre filtreleyin.
includeCoordinates	soru	Hayı	Boolean	Yanıta görselleştirme için koordinatların dahil edilip edilmeyeceği. Varsayılan değer false'tur.
x-ms-client-request-id	üstbilgi	Hayı		İstek için opak, genel olarak benzersiz, istemci tarafından oluşturulan bir dize tanımlayıcısı.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

İçgörüler - get

GET {endpoint}/insights/{id}?api-version=2025-11-15-preview

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
kimlik	path	Evet	String	İçgörüler raporunun benzersiz tanımlayıcısı.
includeCoordinates	soru	Hayı	Boolean	Yanıta görselleştirme için koordinatların dahil edilip edilmeyeceği. Varsayılan değer false'tur.
x-ms-client-request-id	üstbilgi	Hayı		İstek için opak, genel olarak benzersiz, istemci tarafından oluşturulan bir dize tanımlayıcısı.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Bellek deposu oluşturma

POST {endpoint}/memory_stores?api-version=2025-11-15-preview

Bir bellek deposu oluşturun.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

İstek Gövdesi

İçerik Türü: application/json

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Bellek depolarını listeleme

GET {endpoint}/memory_stores?api-version=2025-11-15-preview

Tüm bellek depolarını listeleyin.

URI Parametreleri

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

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Bellek depolarını güncelleştirme

POST {endpoint}/memory_stores/{name}?api-version=2025-11-15-preview

Bellek deposunu güncelleştirin.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
name	path	Evet	String	Güncelleştirilecek bellek deposunun adı.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

İstek Gövdesi

İçerik Türü: application/json

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Bellek deposu alma

GET {endpoint}/memory_stores/{name}?api-version=2025-11-15-preview

Bir bellek deposu alın.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
name	path	Evet	String	Alınacak bellek deposunun adı.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Bellek depolarını silme

DELETE {endpoint}/memory_stores/{name}?api-version=2025-11-15-preview

Bellek deposunu silin.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
name	path	Evet	String	Silinecek bellek deposunun adı.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Güncelleştirme sonucunu alma

GET {endpoint}/memory_stores/{name}/updates/{update_id}?api-version=2025-11-15-preview

Bellek deposu güncelleme sonucunu alın.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
name	path	Evet	String	Bellek deposunun adı.
update_id	path	Evet	String	Bellek güncelleştirme işleminin kimliği.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Kapsam belleklerini silme

POST {endpoint}/memory_stores/{name}:delete_scope?api-version=2025-11-15-preview

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
name	path	Evet	String	Bellek deposunun adı.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

İstek Gövdesi

İçerik Türü: application/json

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Anılarda arama

POST {endpoint}/memory_stores/{name}:search_memories?api-version=2025-11-15-preview

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
name	path	Evet	String	Aranacak bellek deposunun adı.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

İstek Gövdesi

İçerik Türü: application/json

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Bellekleri güncelleştirme

POST {endpoint}/memory_stores/{name}:update_memories?api-version=2025-11-15-preview

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
name	path	Evet	String	Güncelleştirilecek bellek deposunun adı.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

İstek Gövdesi

İçerik Türü: application/json

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

Yanıtlar

Durum Kodu: 202

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

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

Durum Kodu: varsayılan

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

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

Konuşma oluşturma

POST {endpoint}/openai/conversations?api-version=2025-11-15-preview

Konuşma oluşturma.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
nesneler	dizi	Konuşma bağlamını içerecek ilk öğeler. Bir kerede en fazla 20 öğe ekleyebilirsiniz.	Hayı
metadata	nesne	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Hayı

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Konuşmaları listeleme

GET {endpoint}/openai/conversations?api-version=2025-11-15-preview

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

URI Parametreleri

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

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Konuşmayı güncelleştirme

POST {endpoint}/openai/conversations/{conversation_id}?api-version=2025-11-15-preview

Bir konuşmayı güncelleştirme.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
conversation_id	path	Evet	String	Güncelleştirilecek konuşmanın kimliği.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

İstek Gövdesi

İçerik Türü: application/json

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Konuşma alma

GET {endpoint}/openai/conversations/{conversation_id}?api-version=2025-11-15-preview

Bir konuşmayı alır.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
conversation_id	path	Evet	String	Alınacak konuşmanın kimliği.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Konuşmayı silme

DELETE {endpoint}/openai/conversations/{conversation_id}?api-version=2025-11-15-preview

Bir konuşmayı siler.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
conversation_id	path	Evet	String	Silinecek konuşmanın kimliği.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Konuşma öğeleri oluşturma

POST {endpoint}/openai/conversations/{conversation_id}/items?api-version=2025-11-15-preview

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
conversation_id	path	Evet	String	Öğenin oluşturulması gereken konuşmanın kimliği.
include	soru	Hayı	dizi	Yanıta eklenecek ek alanlar. include Daha fazla bilgi için Konuşma öğelerini listeleme parametresine bakın.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

İstek Gövdesi

İçerik Türü: application/json

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Konuşma öğelerini listeleme

GET {endpoint}/openai/conversations/{conversation_id}/items?api-version=2025-11-15-preview

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

URI Parametreleri

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

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Konuşma öğesini alma

GET {endpoint}/openai/conversations/{conversation_id}/items/{item_id}?api-version=2025-11-15-preview

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
conversation_id	path	Evet	String	Öğeyi içeren konuşmanın kimliği.
item_id	path	Evet	String	Alınacak konuşma öğesinin kimliği.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Konuşma öğesini silme

DELETE {endpoint}/openai/conversations/{conversation_id}/items/{item_id}?api-version=2025-11-15-preview

Verilen kimliklerle bir konuşmadaki öğeyi silin.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
conversation_id	path	Evet	String	Öğenin silinmesi gereken konuşmanın kimliği.
item_id	path	Evet	String	Silinecek konuşma öğesinin kimliği.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

OpenAI değerlendirmeleri - liste değerlendirmeleri

GET {endpoint}/openai/evals?api-version=2025-11-15-preview

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

URI Parametreleri

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

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

OpenAI değerlendirmeleri - değerlendirme oluşturma

POST {endpoint}/openai/evals?api-version=2025-11-15-preview

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.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
veri_kaynağı_yapılandırması	nesne	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?	Evet
└─ örn_veri_düzeni_dahil_et	Boolean	Değerlendirmenin örnek ad alanını doldurmanızı beklemesi gerekip gerekmediği (örneğin, veri kaynağınızdan yanıt oluşturarak)	Hayı
└─ öğe şeması	nesne	Veri kaynağındaki her satır için json şeması.	Hayı
└─ meta veriler	nesne	Depolanan tamamlamalar veri kaynağı için meta veri filtreleri.	Hayı
└─ senaryosu	enum	Veri şeması senaryosu. Olası değerler: red_team, responses, traces	Hayı
└─ türü	enum	Her zaman label_modelolan nesne türü. Olası değerler: azure_ai_source	Hayı
metadata	OpenAI.Metadata	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Hayı
name	String	Değerlendirmenin adı.	Hayı
properties	nesne	Ek bilgileri depolamak için bir nesneye eklenebilen sabit 16 anahtar-değer çifti kümesi. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler, uzunluğu en fazla 512 karakter olan dizelerdir.	Hayı
test kriterleri	dizi	Bu gruptaki tüm değerlendirme çalıştırmaları için değerlendirici listesi. Not verenler, gibi {{item.variable_name}}çift küme ayracı gösterimini kullanarak veri kaynağındaki değişkenlere başvurabilir. Modelin çıkışına başvurmak için ad alanını sample (örneğin, {{sample.output_text}}) kullanın.	Evet

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

OpenAI değerlendirmeleri - değerlendirmeyi silme

DELETE {endpoint}/openai/evals/{eval_id}?api-version=2025-11-15-preview

Değerlendirmeyi silme Değerlendirmeyi silin.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
eval_id	path	Evet	String	Silinecek değerlendirmenin kimliği.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

OpenAI değerlendirmeleri - değerlendirme alma

GET {endpoint}/openai/evals/{eval_id}?api-version=2025-11-15-preview

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
eval_id	path	Evet	String	Elde edilecek değerlendirmenin kimliği.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

OpenAI değerlendirmeleri - güncelleştirme değerlendirmeleri

POST {endpoint}/openai/evals/{eval_id}?api-version=2025-11-15-preview

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
eval_id	path	Evet	String	Güncelleştirilecek değerlendirmenin kimliği.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

İstek Gövdesi

İçerik Türü: application/json

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

OpenAI değerlendirmeleri - liste çalıştırmaları

GET {endpoint}/openai/evals/{eval_id}/runs?api-version=2025-11-15-preview

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

URI Parametreleri

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

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

OpenAI değerlendirmeleri - değerlendirme çalıştırması oluşturma

POST {endpoint}/openai/evals/{eval_id}/runs?api-version=2025-11-15-preview

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
eval_id	path	Evet	String	Çalıştırma oluşturulacak değerlendirmenin kimliği.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
veri_kaynağı	nesne	Değerlendirmeyle eşleşen JSONL dosyasını belirten bir JsonlRunDataSource nesnesi	Evet
└─ giriş_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ı
└─ item_generation_params	RedTeamItemGenerationParams	Öğe oluşturma parametreleri.	Hayı
└─ modeli	String	Tamamlanmaları oluşturmak için kullanılacak modelin adı (örneğin, "o3-mini").	Hayı
└─ örnekleme_parametreleri	OpenAI.CreateEvalResponsesRunDataSourceSamplingParams		Hayı
└─ kaynak	OpenAI.EvalJsonlFileContentSource veya OpenAI.EvalJsonlFileIdSource veya OpenAI.EvalResponsesSource	Bu çalıştırmanın veri kaynağındaki ad alanını item neyin dolduracaklarını belirler.	Hayı
└─ hedef	Hedef	Değerlendirme için hedef yapılandırma.	Hayı
└─ türü	String	Veri kaynağı türü ayrıştırıcısı.	Hayı
metadata	OpenAI.Metadata	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Hayı
name	String	Koşunun adı.	Hayı
properties	nesne	Ek bilgileri depolamak için bir nesneye eklenebilen sabit 16 anahtar-değer çifti kümesi. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler, uzunluğu en fazla 512 karakter olan dizelerdir.	Hayı

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

OpenAI değerlendirmeleri - değerlendirme çalıştırmayı silme

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

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
eval_id	path	Evet	String	Silinmesi istenen çalışmanın değerlendirmenin kimliği.
run_id	path	Evet	String	Silinecek çalıştırmanın kimliği.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

OpenAI değerlendirmeleri - değerlendirme çalıştırması alma

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

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
eval_id	path	Evet	String	Çalıştırmaları almak için kullanılacak değerlendirmenin kimliği.
run_id	path	Evet	String	Alınacak çalıştırmanın kimliği.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

OpenAI değerlendirmeleri - değerlendirme çalıştırmayı iptal etme

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

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
eval_id	path	Evet	String	Çalıştırmasını iptal etmek istediğiniz değerlendirmenin kimliği.
run_id	path	Evet	String	İptal edilen çalıştırmanın kimliği.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

OpenAI değerlendirmeleri - değerlendirme çalıştırma çıkış öğelerini alma

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

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

URI Parametreleri

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

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

OpenAI değerlendirmeleri - değerlendirme çalıştırma çıkış öğesini alma

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

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
eval_id	path	Evet	String	Çalıştırmaları almak için kullanılacak değerlendirmenin kimliği.
run_id	path	Evet	String	Alınacak çalıştırmanın kimliği.
output_item_id	path	Evet	String	Alınacak çıkış öğesinin kimliği.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

İnce ayar işi oluşturma

POST {endpoint}/openai/fine-tuning/jobs?api-version=2025-11-15-preview

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

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

İnce ayarlama hakkında daha fazla bilgi edinin

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
hiper parametreler	nesne	İnce ayar işi için kullanılan hiper parametreler. Bu değer artık yerine methodkullanım dışı bırakılmıştır ve parametresi altında method geçirilmelidir.	Hayı
└─ yığın boyutu	enum	Olası değerler: auto	Hayı
└─ öğrenme oranı çarpanı	enum	Olası değerler: auto	Hayı
└─ n_epochs	enum	Olası değerler: auto	Hayı
Entegrasyonlar	dizi	İnce ayar işiniz için etkinleştirecek tümleştirmelerin listesi.	Hayı
metadata	nesne	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Hayı
method	OpenAI.FineTuneMethod	İnce ayar için kullanılan yöntem.	Hayı
model	dize (aşağıdaki geçerli modellere bakın)	İnce ayar için modelin adı. Aşağıdakilerden birini seçebilirsiniz: desteklenen modeller.	Evet
seed	tamsayı	Tohum, işin yeniden üretilebilirliğini denetler. Aynı tohum ve iş parametrelerinin geçirilmesi aynı sonuçları vermelidir, ancak nadir durumlarda farklılık gösterebilir. Bir tohum belirtilmezse, sizin için bir tane oluşturulur.	Hayı
suffix	String	İnce ayarlı model adınıza eklenecek en fazla 64 karakterlik bir dize. Örneğin, suffix "özel model-adı" gibi bir model adı ft:gpt-4o-mini:openai:custom-model-name:7p4lURelüretir.	Hayı	Hiç kimse
eğitim_dosyası	String	Eğitim verilerini içeren karşıya yüklenen bir dosyanın kimliği. Veri kümeniz JSONL dosyası olarak biçimlendirilmelidir. Ayrıca, dosyanızı amacı fine-tuneile karşıya yüklemeniz gerekir. Dosyanın içeriği, modelin sohbet, tamamlanma biçimi veya ince ayar yönteminin tercih biçimini kullanıp kullanmama durumuna bağlı olarak farklılık göstermelidir. Daha fazla ayrıntı için ince ayar kılavuzuna bakın.	Evet
doğrulama_dosyası	String	Doğrulama verilerini içeren karşıya yüklenen bir dosyanın kimliği. Bu dosyayı sağlarsanız, veriler doğrulama oluşturmak için kullanılır ölçümlerini ince ayarlama sırasında düzenli aralıklarla gerçekleştirin. Bu ölçümler ince ayar sonuçları dosyası. Aynı veriler hem eğitme hem de doğrulama dosyalarında bulunmamalıdır. Veri kümeniz JSONL dosyası olarak biçimlendirilmelidir. Dosyanızı amacı fine-tuneile karşıya yüklemeniz gerekir. Daha fazla ayrıntı için ince ayar kılavuzuna bakın.	Hayı

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

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

GET {endpoint}/openai/fine-tuning/jobs?api-version=2025-11-15-preview

Kuruluşunuzun ince ayar işlerini listeleme

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
after	soru	Hayı	String	Önceki sayfalandırma isteğindeki son işin tanımlayıcısı.
limit	soru	Hayı	tamsayı	Alınacak ince ayar işlerinin sayısı.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

hassas ayarlama işini alma

GET {endpoint}/openai/fine-tuning/jobs/{fine_tuning_job_id}?api-version=2025-11-15-preview

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

İnce ayarlama hakkında daha fazla bilgi edinin

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
ince_ayarlama_iş_id	path	Evet	String	İnce ayar işinin kimliği.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

İnce ayarlama işini iptal etme

POST {endpoint}/openai/fine-tuning/jobs/{fine_tuning_job_id}/cancel?api-version=2025-11-15-preview

Hassas ayarlama işini hemen iptal edin.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
ince_ayarlama_iş_id	path	Evet	String	İptal edilecek ince ayar işinin kimliği.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

İnce ayar iş denetim noktalarını listeleme

GET {endpoint}/openai/fine-tuning/jobs/{fine_tuning_job_id}/checkpoints?api-version=2025-11-15-preview

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

URI Parametreleri

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

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

İnce ayar iş olaylarını listeleme

GET {endpoint}/openai/fine-tuning/jobs/{fine_tuning_job_id}/events?api-version=2025-11-15-preview

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

URI Parametreleri

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

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

İnce ayarlama işini duraklatma

POST {endpoint}/openai/fine-tuning/jobs/{fine_tuning_job_id}/pause?api-version=2025-11-15-preview

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
ince_ayarlama_iş_id	path	Evet	String	Duraklatmak için ince ayar işinin kimliği.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

hassas ayarlama işini sürdürme

POST {endpoint}/openai/fine-tuning/jobs/{fine_tuning_job_id}/resume?api-version=2025-11-15-preview

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
ince_ayarlama_iş_id	path	Evet	String	Sürdürülecek ince ayar işinin kimliği.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

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

POST {endpoint}/openai/responses?api-version=2025-11-15-preview

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Hayı	String	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
ajan	AgentReference	Yanıtı oluşturmak için kullanılacak aracı.	Hayı
arka plan	Boolean	Model yanıtının arka planda çalıştırılıp çalıştırılmayacağı. Arka plan yanıtları hakkında daha fazla bilgi edinin.	Hayı	Yanlış
konuşma	dize veya nesne		Hayı
include	dizi	Model yanıtına eklenecek ek çıktı verilerini belirtin. Şu anda desteklenen değerler şunlardır: - code_interpreter_call.outputs: Python kod yürütme çıktılarını içerir kod yorumlayıcı aracı çağrı öğeleri. - computer_call_output.output.image_url: Bilgisayar çağrısı çıkışından görüntü URL'lerini ekleyin. - file_search_call.results: Arama sonuçlarını ekleyin: dosya arama aracı çağrısı. - message.input_image.image_url: Giriş iletisinden görüntü URL'lerini ekleyin. - message.output_text.logprobs: Yardımcı iletilerine logprobs ekleyin. - reasoning.encrypted_content: Mantığın şifrelenmiş bir sürümünü içerir akıl yürütme öğe çıkışlarındaki belirteçler. Bu, mantık öğelerinin kullanılmasına olanak sağlar. Yanıtlar API'sini durum bilgisi olmayan bir şekilde kullanırken çok aşamalı konuşmalar (örneğin when the store parameter is set to false, or when an organization is store parametresi false olarak ayarlandığında veya bir kuruluş olduğunda sıfır veri saklama programına kaydedilir).	Hayı
girdi	dize veya dizi	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 çıkışları - Görüntü girişleri - Dosya girişleri - Konuşma durumunu yönetme - İşlev çağrısı	Hayı
instructions	String	Modelin bağlamı içine eklenen bir sistem (veya geliştirici) iletisi. previous_response_id ile birlikte kullanırken, önceki yönergelerden gelen talimatlar yanıt bir sonraki yanıta aktarılmaz. Bu, basit olmasını sağlar yeni yanıtlarda sistem (veya geliştirici) iletilerini değiştirmek için.	Hayı
max_output_tokens	tamsayı	Görünür çıkış belirteçleri ve muhakeme belirteçleri de dahil olmak üzere yanıt için oluşturulabilecek belirteç sayısı için üst sınır.	Hayı
max_tool_calls	tamsayı	Bir yanıtta işlenebilen yerleşik araçlara yapılan toplam çağrı sayısı üst sınırı. Bu maksimum sayı, tek tek araç başına değil, tüm yerleşik araç çağrıları için geçerlidir. Model tarafından bir aracı çağırmaya yönelik diğer girişimler yoksayılır.	Hayı
metadata	nesne	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Hayı
model	String	Bu yanıtın oluşturulması için kullanılacak model dağıtımı.	Hayı
paralel araç çağrıları	Boolean	Modelin araç çağrılarını paralel olarak çalıştırmasına izin verilip verilmeyeceği.	Hayı	Doğru
previous_response_id	String	Modele önceki yanıtın benzersiz kimliği. Bunu şunu yapmak için kullanın: çok aşamalı konuşmalar oluşturun. Hakkında daha fazla bilgi edinin konuşma durumunu yönetme.	Hayı
prompt	OpenAI.Prompt	bir istem şablonuna ve değişkenlerine başvuru. Daha fazla bilgi edinin.	Hayı
reasoning	OpenAI.Reasoning	yalnızca o serisi modeller Mantık modelleri için yapılandırma seçenekleri.	Hayı
hizmet seviyesi	OpenAI.ServiceTier	Not: service_tier Azure OpenAI için geçerli değildir.	Hayı
store	Boolean	Oluşturulan model yanıtının daha sonra almak üzere belirli bir yolla (aracılığıyla) depolanıp depolanmayacağı API	Hayı	Doğru
veri akışı	Boolean	True olarak ayarlanırsa model yanıt verileri istemciye akışla aktarılır sunucu tarafından gönderilen olaylar kullanılarak oluşturulur. daha fazla bilgi için.	Hayı	Yanlış
structured_inputs	nesne	Yanıta, istem şablonu değiştirme veya araç bağımsız değişkeni bağlamalarına katılabilen yapılandırılmış girişler.	Hayı
sıcaklık	Numara	0 ile 2 arasında hangi örnekleme sıcaklığının kullanılacağı. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir. Genellikle bunu değiştirmenizi öneririz top_p ancak ikisini birden değiştirmemenizi öneririz.	Hayı	1
text	nesne	Modelden metin yanıtı için yapılandırma seçenekleri. Düz olabilir metin veya yapılandırılmış JSON verileri. Bkz . Metin girişleri ve çıkışları ve Yapılandırılmış Çıkışlar	Hayı
└─ biçimi	OpenAI.ResponseTextFormatConfiguration		Hayı
tool_choice	OpenAI.ToolChoiceOptions veya OpenAI.ToolChoiceObject	Model, oluştururken kullanılacak aracı (veya araçları) nasıl seçmelidir? bir cevap tools Hangi araçların nasıl belirtileceğini görmek için parametresine bakın modeli çağırabilir.	Hayı
araçlar	dizi	Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Sen parametresini ayarlayarak tool_choice hangi aracın kullanılacağını belirtebilir. Modeli sağlayabileceğiniz iki araç kategorisi şunlardır: - Yerleşik araçlar: OpenAI tarafından sağlanan ve işlevselliği genişleten araçlar dosya arama gibi modelin özellikleri. - İşlev çağrıları (özel araçlar): Sizin tanımladığınız işlevler, Modelin kendi yazdığınız kodu çağırmasını sağlama.	Hayı
top_logprobs	tamsayı	Her biri ilişkili günlük olasılığına sahip her belirteç konumunda döndürülecek en olası belirteç sayısını belirten 0 ile 20 arasında bir tamsayı.	Hayı
top_p	Numara	Sıcaklıkla örneklemeye alternatif olarak çekirdek örneklemesi adı verilir, burada model, belirteçlerin sonuçlarını top_p olasılıkla değerlendirir kütle. Yani 0,1 yalnızca ilk 10% olasılık kütlesini oluşturan belirteçler anlamına gelir dikkate alınır. Genellikle bunu değiştirmenizi öneririz temperature ancak ikisini birden değiştirmemenizi öneririz.	Hayı	1
truncation	enum	Model yanıtı için kullanılacak kesme stratejisi. - auto: Bu yanıtın bağlamı ve önceki yanıtlar aşarsa modelin bağlam penceresi boyutu, modelin yanıtı bağlam penceresine uydurmak için giriş öğelerini düşürerek konuşmanın ortasında. - disabled (varsayılan): Model yanıtı bağlam penceresini aşarsa Bir model için boyut yanlış girilirse, istek 400 hatasıyla başarısız olur. Olası değerler: auto, disabled	Hayı
user	String	En iyi güvenlik uygulamaları hakkında daha fazla bilgi edinin.	Hayı

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Yanıtları listeleme

GET {endpoint}/openai/responses?api-version=2025-11-15-preview

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

URI Parametreleri

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

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Yanıt alma - yanıt akışı alma

GET {endpoint}/openai/responses/{response_id}?api-version=2025-11-15-preview

Belirtilen ID numarası ile bir model tepkisi getirir. Verilen kimlikle (akış yanıtı) bir model yanıtı alır.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Hayı	String	Bu işlem için kullanılacak API sürümü.
response_id	path	Evet	String
include[]	soru	Hayı	dizi
veri akışı	soru	Hayı	Boolean
starting_after	soru	Hayı	tamsayı
kabul et	üstbilgi	Hayı	String Olası değerler: text/event-stream

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Yanıtı silme

DELETE {endpoint}/openai/responses/{response_id}?api-version=2025-11-15-preview

Model yanıtlarını siler.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
response_id	path	Evet	String	Silinecek yanıtın kimliği.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Yanıtı iptal et

POST {endpoint}/openai/responses/{response_id}/cancel?api-version=2025-11-15-preview

Model yanıtlarını iptal eder.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
response_id	path	Evet	String	İptal edilecek yanıtın kimliği.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Giriş öğelerini listeleme

GET {endpoint}/openai/responses/{response_id}/input_items?api-version=2025-11-15-preview

Belirli bir yanıt için giriş öğelerinin listesini döndürür.

URI Parametreleri

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

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Redteams - liste

GET {endpoint}/redTeams/runs?api-version=2025-11-15-preview

Bir kırmızı takımı adına göre listeleyin.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
x-ms-client-request-id	üstbilgi	Hayı		İstek için opak, genel olarak benzersiz, istemci tarafından oluşturulan bir dize tanımlayıcısı.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Redteams -

GET {endpoint}/redTeams/runs/{name}?api-version=2025-11-15-preview

İsme göre bir kırmızı takım alın.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
name	path	Evet	String	Kırmızı takım koşusunun tanımlayıcısı.
x-ms-client-request-id	üstbilgi	Hayı		İstek için opak, genel olarak benzersiz, istemci tarafından oluşturulan bir dize tanımlayıcısı.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Redteams - oluşturma

POST {endpoint}/redTeams/runs:run?api-version=2025-11-15-preview

Bir redteam çalıştırması oluşturur.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
applicationScenario	String	Senaryoya özel saldırılar oluşturmak için kırmızı takım operasyonu için uygulama senaryosu.	Hayı
attackStrategies	dizi	Saldırı stratejilerinin listesi veya saldırı stratejilerinin iç içe geçmiş listeleri.	Hayı
ekran adı	String	Kırmızı takım koşusunun adı.	Hayı
kimlik	String	Kırmızı takım koşusunun tanımlayıcısı.	Evet
numTurns	tamsayı	Simülasyon turlarının sayısı.	Hayı
properties	nesne	Kırmızı takımın özellikleri. Etiketlerden farklı olarak özellikler yalnızca eklentidir. Bir özellik eklendikten sonra kaldırılamaz.	Hayı
risk Kategorileri	dizi	Saldırı hedefleri oluşturmak için risk kategorilerinin listesi.	Hayı
simulationOnly	Boolean	Yalnızca simülasyon veya Simülasyon + Değerlendirme. Varsayılan olarak false, doğruysa tarama değerlendirme sonucunu değil konuşma çıktısını verir.	Hayı	Yanlış
durum	String	Kırmızı takımın durumu. Hizmet tarafından ayarlanır ve salt okunurdur.	Hayı
tags	nesne	Kırmızı takımın etiketleri. Özelliklerden farklı olarak etiketler tamamen değişebilir.	Hayı
target	nesne	Hedef yapılandırma için soyut sınıf.	Evet
└─ türü	String	Model yapılandırmasının türü.	Hayı

Yanıtlar

Durum Kodu: 201

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

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

Durum Kodu: varsayılan

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

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

Zamanlamalar - liste

GET {endpoint}/schedules?api-version=2025-11-15-preview

Tüm programları listeleyin.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
x-ms-client-request-id	üstbilgi	Hayı		İstek için opak, genel olarak benzersiz, istemci tarafından oluşturulan bir dize tanımlayıcısı.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Zamanlamalar - silme

DELETE {endpoint}/schedules/{id}?api-version=2025-11-15-preview

Bir programı sil.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
kimlik	path	Evet	String	Zamanlamanın tanımlayıcısı.
x-ms-client-request-id	üstbilgi	Hayı		İstek için opak, genel olarak benzersiz, istemci tarafından oluşturulan bir dize tanımlayıcısı.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 204

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

Durum Kodu: varsayılan

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

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

Zamanlamalar - get

GET {endpoint}/schedules/{id}?api-version=2025-11-15-preview

Kimliğe göre bir program alın.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
kimlik	path	Evet	String	Zamanlamanın tanımlayıcısı.
x-ms-client-request-id	üstbilgi	Hayı		İstek için opak, genel olarak benzersiz, istemci tarafından oluşturulan bir dize tanımlayıcısı.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Zamanlamalar - oluşturma veya güncelleştirme

PUT {endpoint}/schedules/{id}?api-version=2025-11-15-preview

Kimliğe göre bir zamanlama oluşturun veya güncelleştirin.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
kimlik	path	Evet	String	Zamanlamanın tanımlayıcısı.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
açıklama	String	Zamanlamanın açıklaması.	Hayı
ekran adı	String	Zamanlamanın adı.	Hayı
etkinleştirildi	Boolean	Zamanlamanın etkin durumu.	Evet
kimlik	String	Zamanlamanın tanımlayıcısı.	Evet
properties	nesne	Schedule'ın özellikleri. Etiketlerden farklı olarak özellikler yalnızca eklentidir. Bir özellik eklendikten sonra kaldırılamaz.	Hayı
provisioningStatus	nesne	Sağlama durumunu zamanlayın.	Hayı
sistem verileri	nesne	Kaynak için sistem meta verileri.	Evet
tags	nesne	Schedule'un etiketleri. Özelliklerden farklı olarak etiketler tamamen değişebilir.	Hayı
görev	nesne	Zamanlama görev modeli.	Evet
└─ yapılandırması	nesne	Görev için yapılandırma.	Hayı
└─ türü	ScheduleTaskType	Görevin türü.	Hayı
trigger	nesne	Zamanlamanın tetikleyicisi için temel model.	Evet
└─ türü	TriggerType	Tetikleyicinin türü.	Hayı

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: 201

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

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

Durum Kodu: varsayılan

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

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

Zamanlamalar - liste çalıştırmaları

GET {endpoint}/schedules/{id}/runs?api-version=2025-11-15-preview

Tüm zamanlama çalıştırmalarını listeleyin.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
kimlik	path	Evet	String	Zamanlamanın tanımlayıcısı.
x-ms-client-request-id	üstbilgi	Hayı		İstek için opak, genel olarak benzersiz, istemci tarafından oluşturulan bir dize tanımlayıcısı.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Zamanlamalar - çalıştırmayı alma

GET {endpoint}/schedules/{scheduleId}/runs/{runId}?api-version=2025-11-15-preview

Kimliğe göre çalışan bir program alın.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	biçimindeki https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}Dökümhane Projesi uç noktası. Foundry Hub'ınızda yalnızca bir Project varsa veya Hub'ınızdaki varsayılan Project'i hedeflemek için şu formu kullanın: https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
API-sürümü	soru	Evet	String	Bu işlem için kullanılacak API sürümü.
scheduleId	path	Evet	String	Zamanlamanın tanımlayıcısı.
runId	path	Evet	String	Zamanlama çalıştırmasının tanımlayıcısı.

İstek Başlığı

İsim	Gerekli	Türü	Description
Authorization	Doğru	String	Örnek: Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://ai.azure.com/ Tür: oauth2 Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize kapsam: https://ai.azure.com/.default

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Components

A2ATool

A2A protokolünü uygulayan bir aracı.

İsim	Türü	Description	Gerekli	Varsayılan
agent_card_path	String	Temsilci kartına göre base_urlgiden yol. Sağlanmazsa, varsayılan olarak /.well-known/agent-card.json	Hayı
base_url	String	Aracının temel URL'si.	Hayı
project_connection_id	String	A2A sunucusu için projedeki bağlantı kimliği. Bağlantı, A2A sunucusuna bağlanmak için gereken kimlik doğrulamasını ve diğer bağlantı ayrıntılarını saklar.	Hayı
type	enum	Aracın türü. Her zaman a2a. Olası değerler: a2a_preview	Evet

AISearchIndexResource

Bir AI Arama Dizini kaynağı.

İsim	Türü	Description	Gerekli	Varsayılan
filtre	String	Arama kaynağı için filtre dizesi. daha fazla bilgi için buraya.	Hayı
index_asset_id	String	Arama kaynağı için dizin varlık kimliği.	Hayı
endeks_adı	String	Bu aracıya bağlı bir IndexResource'taki dizinin adı.	Hayı
project_connection_id	String	Bu aracıya iliştirilmiş bir IndexResource'daki dizin bağlantı kimliği.	Hayı
sorgu_tipi	nesne	Azure AI Search aracı için kullanılabilir sorgu türleri.	Hayı
top_k	tamsayı	Aramadan alınacak ve modele sunulacak belge sayısı.	Hayı

AgentClusterInsightResult

Aracı küme analizinden elde edilen bilgiler.

İsim	Türü	Description	Gerekli	Varsayılan
clusterInsight	ClusterInsightResult	Küme analizinden elde edilen bilgiler.	Evet
type	enum	İçgörülerin türü sonucu. Olası değerler: AgentClusterInsight	Evet

AgentClusterInsightsRequest

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

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

AgentContainerObject

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

İsim	Türü	Description	Gerekli	Varsayılan
oluşturulma_tarihi	String	Kapsayıcının oluşturma zamanı.	Evet
error_message	String	Varsa, kapsayıcı çalışamadıysa hata iletisi.	Hayı
max_replicas	tamsayı	Kapsayıcı için en fazla çoğaltma sayısı. Varsayılan değer 1'dir.	Hayı
min_replicas	tamsayı	Kapsayıcı için en az çoğaltma sayısı. Varsayılan değer 1'dir.	Hayı
nesne	enum	Her zaman 'agent.container' olan nesne türü. Olası değerler: agent.container	Evet
durum	nesne	Aracının belirli bir sürümünün kapsayıcısının durumu.	Evet
updated_at	String	Kapsayıcının son güncelleştirme zamanı.	Evet

AgentContainerOperationError

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

İsim	Türü	Description	Gerekli	Varsayılan
kod	String	Varsa kapsayıcı işleminin hata kodu.	Evet
mesaj	String	Varsa kapsayıcı işleminin hata iletisi.	Evet
type	String	Varsa kapsayıcı işleminin hata türü.	Evet

AgentContainerOperationObject

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

İsim	Türü	Description	Gerekli	Varsayılan
agent_id	String	Aracının kimliği.	Evet
agent_version_id	String	Aracı sürümünün kimliği.	Evet
container	nesne	Bir aracının belirli bir sürümünün kapsayıcısının ayrıntıları.	Hayı
└─ oluşturulma_tarihi	String	Kapsayıcının oluşturma zamanı.	Hayı
└─ error_message	String	Varsa, kapsayıcı çalışamadıysa hata iletisi.	Hayı
└─ max_replicas	tamsayı	Kapsayıcı için en fazla çoğaltma sayısı. Varsayılan değer 1'dir.	Hayı
└─ min_replicas	tamsayı	Kapsayıcı için en az çoğaltma sayısı. Varsayılan değer 1'dir.	Hayı
└─ nesne	enum	Her zaman 'agent.container' olan nesne türü. Olası değerler: agent.container	Hayı
└─ durumu	AgentContainerStatus	Aracının belirli bir sürümünün kapsayıcısının durumu.	Hayı
└─ updated_at	String	Kapsayıcının son güncelleştirme zamanı.	Hayı
hata	nesne	Varsa kapsayıcı işleminin hata ayrıntıları.	Hayı
└─ kod	String	Varsa kapsayıcı işleminin hata kodu.	Hayı
└─ ileti	String	Varsa kapsayıcı işleminin hata iletisi.	Hayı
└─ türü	String	Varsa kapsayıcı işleminin hata türü.	Hayı
kimlik	String	Kapsayıcı işleminin kimliği. Bu kimlik, sistem genelinde benzersiz bir tanımlayıcıdır.	Evet
durum	nesne	Bir aracının belirli bir sürümü için kapsayıcı işleminin durumu.	Evet

AgentContainerOperationStatus

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

Mülkiyet	Değer
Açıklama	Bir aracının belirli bir sürümü için kapsayıcı işleminin durumu.
Türü	String
Değerler	NotStarted InProgress Succeeded Failed

AgentContainerStatus

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

Mülkiyet	Değer
Açıklama	Aracının belirli bir sürümünün kapsayıcısının durumu.
Türü	String
Değerler	Starting Running Stopping Stopped Failed Deleting Deleted Updating

AgentDefinition

AgentDefinition için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini kind kullanır:

Tür Değeri	Şema
workflow	WorkflowAgentDefinition
hosted	HostedAgentDefinition
container_app	ContainerAppAgentDefinition
prompt	PromptAgentDefinition

İsim	Türü	Description	Gerekli	Varsayılan
tür	AgentKind		Evet
rai_config	nesne	Sorumlu Yapay Zeka (RAI) içerik filtreleme ve güvenlik özellikleri için yapılandırma.	Hayı
└─ rai_policy_name	String	Uygulanacak RAI politikasının adı.	Hayı

AgentId

İsim	Türü	Description	Gerekli	Varsayılan
name	String	Aracının adı.	Evet
type	enum	Olası değerler: agent_id	Evet
version	String	Aracının sürüm tanımlayıcısı.	Evet

AgentKind

Mülkiyet	Değer
Türü	String
Değerler	prompt hosted container_app workflow

AgentObject

İsim	Türü	Description	Gerekli	Varsayılan
kimlik	String	Aracının benzersiz tanımlayıcısı.	Evet
name	String	Aracının adı.	Evet
nesne	enum	Her zaman 'aracı' olan nesne türü. Olası değerler: agent	Evet
versions	nesne	Ajanın en son sürümü.	Evet
└─ en son	AgentVersionObject		Hayı

AgentProtocol

Mülkiyet	Değer
Türü	String
Değerler	activity_protocol responses

Temsilci Referansı

İsim	Türü	Description	Gerekli	Varsayılan
name	String	Aracının adı.	Evet
type	enum	Olası değerler: agent_reference	Evet
version	String	Aracının sürüm tanımlayıcısı.	Hayı

AgentTaxonomyInput

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

İsim	Türü	Description	Gerekli	Varsayılan
risk Kategorileri	dizi	Değerlendirilecek risk kategorilerinin listesi.	Evet
target	nesne	Azure AI aracısı belirten bir hedefi temsil eder.	Evet
└─ ad	String	Azure AI aracısının benzersiz tanımlayıcısı.	Hayı
└─ tool_descriptions	dizi	Metin oluşturma sırasında aracının örnekleme davranışını kontrol etmek için kullanılan parametreler.	Hayı
└─ türü	enum	Hedefin türü, her zaman azure_ai_agent. Olası değerler: azure_ai_agent	Hayı
└─ sürümü	String	Azure AI aracısının sürümü.	Hayı
type	enum	Değerlendirme taksonomisinin giriş türü. Olası değerler: agent	Evet

AgentTaxonomyInputUpdate

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

İsim	Türü	Description	Gerekli	Varsayılan
risk Kategorileri	dizi	Değerlendirilecek risk kategorilerinin listesi.	Hayı
target	nesne	Azure AI aracısı belirten bir hedefi temsil eder.	Hayı
└─ ad	String	Azure AI aracısının benzersiz tanımlayıcısı.	Hayı
└─ tool_descriptions	dizi	Metin oluşturma sırasında aracının örnekleme davranışını kontrol etmek için kullanılan parametreler.	Hayı
└─ türü	enum	Hedefin türü, her zaman azure_ai_agent. Olası değerler: azure_ai_agent	Hayı
└─ sürümü	String	Azure AI aracısının sürümü.	Hayı
type	enum	Değerlendirme taksonomisinin giriş türü. Olası değerler: agent	Hayı

AgentVersionObject

İsim	Türü	Description	Gerekli	Varsayılan
oluşturulma_tarihi	tamsayı	Aracının oluşturulduğu Unix zaman damgası (saniye).	Evet
tanım	AgentDefinition		Evet
açıklama	String	Aracının insan tarafından okunabilir bir açıklaması.	Hayı
kimlik	String	Aracı sürümünün benzersiz tanımlayıcısı.	Evet
metadata	nesne	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Evet
name	String	Aracının adı. Ad, aracıyı almak/güncellemek/silmek için kullanılabilir.	Evet
nesne	enum	Her zaman 'agent.version' olan nesne türü. Olası değerler: agent.version	Evet
version	String	Aracının sürüm tanımlayıcısı. Aracılar değişmezdir ve her güncelleme, adı aynı tutarak yeni bir sürüm oluşturur.	Evet

AgenticIdentityCredentials

Aracı kimliği kimlik bilgisi tanımlaması

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Kimlik bilgisi türü Olası değerler: AgenticIdentityToken	Evet

ApiErrorResponse

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

İsim	Türü	Description	Gerekli	Varsayılan
hata	OpenAI.Error		Evet

ApiKeyCredentials

API Anahtarı Kimlik Bilgisi tanımı

İsim	Türü	Description	Gerekli	Varsayılan
key	String	API Anahtarı	Hayı
type	enum	Kimlik bilgisi türü Olası değerler: ApiKey	Evet

AssetCredentialResponse

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

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

Varlık Kimliği

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

Tür: dize

AttackStrategy

Saldırılar için stratejiler.

Mülkiyet	Değer
Açıklama	Saldırılar için stratejiler.
Türü	String
Değerler	easy moderate difficult ascii_art ascii_smuggler atbash base64 binary caesar character_space jailbreak ansii_attack character_swap suffix_append string_join unicode_confusable unicode_substitution diacritic flip leetspeak rot13 morse url baseline indirect_jailbreak tense multi_turn crescendo

Azure.Core.Foundations.Error

Hata nesnesi.

İsim	Türü	Description	Gerekli	Varsayılan
kod	String	Sunucu tanımlı hata kodları kümesinden biri.	Evet
details	dizi	Bu bildirilen hataya yol açan belirli hatalar hakkında bir dizi ayrıntı.	Hayı
innererror	nesne	Hata hakkında daha ayrıntılı bilgi içeren bir nesne. Azure REST API yönergelerine göre - https://aka.ms/AzureRestApiGuidelines#handling-errors.	Hayı
└─ kod	String	Sunucu tanımlı hata kodları kümesinden biri.	Hayı
└─ iç hata	Azure.Core.Foundations.InnerError	İç hata.	Hayı
mesaj	String	Hatanın insan tarafından okunabilir bir gösterimi.	Evet
target	String	Hatanın hedefi.	Hayı

Azure.Core.Foundations.ErrorResponse

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

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

Azure.Core.Foundations.InnerError

Hata hakkında daha ayrıntılı bilgi içeren bir nesne. Azure REST API yönergelerine göre - https://aka.ms/AzureRestApiGuidelines#handling-errors.

İsim	Türü	Description	Gerekli	Varsayılan
kod	String	Sunucu tanımlı hata kodları kümesinden biri.	Hayı
innererror	nesne	Hata hakkında daha ayrıntılı bilgi içeren bir nesne. Azure REST API yönergelerine göre - https://aka.ms/AzureRestApiGuidelines#handling-errors.	Hayı
└─ kod	String	Sunucu tanımlı hata kodları kümesinden biri.	Hayı
└─ iç hata	Azure.Core.Foundations.InnerError	İç hata.	Hayı

Azure.Core.Foundations.OperationState

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

Mülkiyet	Değer
Türü	String
Değerler	NotStarted Running Succeeded Failed Canceled

Azure.Core.uuid

Evrensel Olarak Benzersiz Tanımlayıcı

Tür: dize

Biçim: uuid

AzureAIAgentTarget

Azure AI aracısı belirten bir hedefi temsil eder.

İsim	Türü	Description	Gerekli	Varsayılan
name	String	Azure AI aracısının benzersiz tanımlayıcısı.	Evet
tool_descriptions	dizi	Metin oluşturma sırasında aracının örnekleme davranışını kontrol etmek için kullanılan parametreler.	Hayı
type	enum	Hedefin türü, her zaman azure_ai_agent. Olası değerler: azure_ai_agent	Evet
version	String	Azure AI aracısının sürümü.	Hayı

AzureAIAgentTargetUpdate

Azure AI aracısı belirten bir hedefi temsil eder.

İsim	Türü	Description	Gerekli	Varsayılan
name	String	Azure AI aracısının benzersiz tanımlayıcısı.	Hayı
tool_descriptions	dizi	Metin oluşturma sırasında aracının örnekleme davranışını kontrol etmek için kullanılan parametreler.	Hayı
type	enum	Hedefin türü, her zaman azure_ai_agent. Olası değerler: azure_ai_agent	Hayı
version	String	Azure AI aracısının sürümü.	Hayı

AzureAIAssistantTarget

Kimliği de dahil olmak üzere bir Azure AI Yardımcısı (Aracı V1) uç noktasını belirten bir hedefi temsil eder.

İsim	Türü	Description	Gerekli	Varsayılan
kimlik	String	Azure AI Yardımcısı'nın benzersiz tanımlayıcısı.	Hayı
tool_descriptions	dizi	Yardımcının kullanabileceği araçların açıklamaları.	Evet
type	enum	Hedefin türü, her zaman azure_ai_assistant. Olası değerler: azure_ai_assistant	Evet

AzureAIAssistantTargetUpdate

Kimliği de dahil olmak üzere bir Azure AI Yardımcısı (Aracı V1) uç noktasını belirten bir hedefi temsil eder.

İsim	Türü	Description	Gerekli	Varsayılan
kimlik	String	Azure AI Yardımcısı'nın benzersiz tanımlayıcısı.	Hayı
tool_descriptions	dizi	Yardımcının kullanabileceği araçların açıklamaları.	Hayı
type	enum	Hedefin türü, her zaman azure_ai_assistant. Olası değerler: azure_ai_assistant	Hayı

AzureAIEvaluator

Döküm değerlendiricileri için Azure AI Değerlendirici tanımı.

İsim	Türü	Description	Gerekli	Varsayılan
veri eşleme	nesne	Değerlendirme için kullanılacak model. Yapılandırılmış çıktıları destekleme zorunluluğu vardır.	Hayı
evaluator_name	String	Değerlendiricinin adı.	Evet
evaluator_version	String	Değerlendiricinin sürümü.	Hayı
initialization_parameters	nesne	Değerlendirme için başlatma parametreleri. Yapılandırılmış çıktıları destekleme zorunluluğu vardır.	Hayı
name	String	Değerlendiricinin adı.	Evet
type	enum	Her zaman label_modelolan nesne türü. Olası değerler: azure_ai_evaluator	Evet

AzureAIModelTarget

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

İsim	Türü	Description	Gerekli	Varsayılan
model	String	Azure AI modelinin benzersiz tanımlayıcısı.	Hayı
Örnekleme_Parametreleri	nesne	Metin oluşturma sırasında dil modelinin örnekleme davranışını denetlemek için kullanılan bir parametre kümesini temsil eder.	Hayı
└─ maksimum_önem_bitim_kodları	tamsayı	Tamamlanmada izin verilen en fazla belirteç sayısı.	Hayı
└─ tohum	tamsayı	Yeniden üretilebilirlik için rastgele tohum.	Hayı
└─ sıcaklık	Numara	Örnekleme için sıcaklık parametresi.	Hayı
└─ top_p	Numara	Çekirdek örnekleme için top-p parametresi.	Hayı
type	enum	Hedefin türü, her zaman azure_ai_model. Olası değerler: azure_ai_model	Evet

AzureAIModelTargetUpdate

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

İsim	Türü	Description	Gerekli	Varsayılan
model	String	Azure AI modelinin benzersiz tanımlayıcısı.	Hayı
Örnekleme_Parametreleri	nesne	Metin oluşturma sırasında dil modelinin örnekleme davranışını denetlemek için kullanılan bir parametre kümesini temsil eder.	Hayı
└─ maksimum_önem_bitim_kodları	tamsayı	Tamamlanmada izin verilen en fazla belirteç sayısı.	Hayı
└─ tohum	tamsayı	Yeniden üretilebilirlik için rastgele tohum.	Hayı
└─ sıcaklık	Numara	Örnekleme için sıcaklık parametresi.	Hayı
└─ top_p	Numara	Çekirdek örnekleme için top-p parametresi.	Hayı
type	enum	Hedefin türü, her zaman azure_ai_model. Olası değerler: azure_ai_model	Hayı

AzureAIRedTeam

İsim	Türü	Description	Gerekli	Varsayılan
item_generation_params	nesne	Kırmızı takım öğesi oluşturma parametrelerini temsil eder.	Evet
└─ attack_strategies	dizi	Kullanılacak saldırı stratejilerinin koleksiyonu.	Hayı
└─ num_turns	tamsayı	Oyunda izin verilen dönüş sayısı.	Hayı
└─ türü	enum	Her zaman red_teamolan öğe oluşturma parametrelerinin türü. Olası değerler: red_team	Hayı
target	nesne	Ayırıcı desteği olan hedefler için temel sınıf.	Evet
└─ türü	String	Hedefin türü.	Hayı
type	enum	Veri kaynağının türü. Her zaman azure_ai_red_team. Olası değerler: azure_ai_red_team	Evet

AzureAIResponses

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

İsim	Türü	Description	Gerekli	Varsayılan
event_configuration_id	String	Bu değerlendirme çalıştırmasıyla ilişkili olay yapılandırma adı.	Evet
item_generation_params	nesne	Sürekli değerlendirme öğesi oluşturma parametrelerini temsil eder.	Evet
└─ data_mapping	nesne	Sohbet geçmişini almak için gereken kaynak alanlardan response_id alanına eşleme.	Hayı
└─ max_num_turns	tamsayı	Değerlendirilecek sohbet geçmişinin maksimum dönüş sayısı.	Hayı
└─ kaynak	OpenAI.EvalJsonlFileContentSource veya OpenAI.EvalJsonlFileIdSource	JSONL içeriğinin okunduğu kaynak.	Hayı
└─ türü	enum	Her zaman ResponseRetrievalolan öğe oluşturma parametrelerinin türü. Olası değerler: response_retrieval	Hayı
max_runs_hourly	tamsayı	Saat başına izin verilen en fazla değerlendirme çalıştırması sayısı.	Evet
type	enum	Her zaman AzureAIResponsesveri kaynağı türü. Olası değerler: azure_ai_responses	Evet

AzureAISearchAgentTool

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

İsim	Türü	Description	Gerekli	Varsayılan
azure_ai_search	nesne	azure_ai_search aracı tarafından kullanılan dizin kaynakları kümesi.	Evet
└─ dizinler	dizi	Bu aracıya bağlı dizinler. En fazla 1 dizin olabilir aracıya bağlı kaynak.	Hayı
type	enum	Her zaman 'azure_ai_search' olan nesne türü. Olası değerler: azure_ai_search	Evet

Azure AISearch Dizini

Azure AI Search Dizin Tanımı

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Endeks türü Olası değerler: AzureSearch	Evet

AzureAISearchIndexUpdate

Azure AI Search Dizin Tanımı

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Endeks türü Olası değerler: AzureSearch	Evet

AzureAISearchQueryType

Azure AI Search aracı için kullanılabilir sorgu türleri.

Mülkiyet	Değer
Açıklama	Azure AI Search aracı için kullanılabilir sorgu türleri.
Türü	String
Değerler	simple semantic vector vector_simple_hybrid vector_semantic_hybrid

AzureAISearchToolResource

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

İsim	Türü	Description	Gerekli	Varsayılan
Dizin	dizi	Bu aracıya bağlı dizinler. En fazla 1 dizin olabilir aracıya bağlı kaynak.	Evet

AzureAISource

İsim	Türü	Description	Gerekli	Varsayılan
senaryo	enum	Veri şeması senaryosu. Olası değerler: red_team, responses, traces	Evet
type	enum	Her zaman label_modelolan nesne türü. Olası değerler: azure_ai_source	Evet

AzureFunctionAgentTool

Aracıyı yapılandırmak için kullanılan Azure İşlev Aracı giriş tanımı bilgileri.

İsim	Türü	Description	Gerekli	Varsayılan
azure_function	nesne	Azure işlevinin tanımı.	Evet
└─ işlevi	nesne	Azure işlevinin tanımı ve parametreleri.	Hayı
└─ açıklama	String	İşlevin ne zaman ve nasıl çağrıldığını seçmek için model tarafından kullanılan işlevin ne yaptığının açıklaması.	Hayı
└─ ad	String	Çağrılacak işlevin adı.	Hayı
└─ parametreler		İşlevlerin kabullediği, JSON Şeması nesnesi olarak tanımlanan parametreler.	Hayı
└─ input_binding	AzureFunctionBinding	Giriş depolama kuyruğu. Kuyruk depolama tetikleyicisi, iletiler eklendiğinde bir işlev çalıştırır.	Hayı
└─ output_binding	AzureFunctionBinding	Çıktı depolama kuyruğu. İşlev, giriş öğeleri işlendiğinde çıkışı bu kuyruğa yazar.	Hayı
type	enum	Her zaman 'browser_automation' olan nesne türü. Olası değerler: azure_function	Evet

AzureFunctionBinding

Depolama kuyruğu adını ve URI'sini tutmaya yönelik yapı.

İsim	Türü	Description	Gerekli	Varsayılan
storage_queue	nesne	Depolama kuyruğu adını ve URI'sini tutmaya yönelik yapı.	Evet
└─ queue_name	String	Azure işlev depolama kuyruğunun adı.	Hayı
└─ queue_service_endpoint	String	Bir kuyruğu işlemenize olanak sağlayan Azure Depolama Kuyruğu hizmetine yönelik URI.	Hayı
type	enum	Her zaman 'storage_queue' olan bağlama türü. Olası değerler: storage_queue	Evet

AzureFunctionDefinition

Azure işlevinin tanımı.

İsim	Türü	Description	Gerekli	Varsayılan
function	nesne	Azure işlevinin tanımı ve parametreleri.	Evet
└─ açıklama	String	İşlevin ne zaman ve nasıl çağrıldığını seçmek için model tarafından kullanılan işlevin ne yaptığının açıklaması.	Hayı
└─ ad	String	Çağrılacak işlevin adı.	Hayı
└─ parametreler		İşlevlerin kabullediği, JSON Şeması nesnesi olarak tanımlanan parametreler.	Hayı
input_binding	nesne	Depolama kuyruğu adını ve URI'sini tutmaya yönelik yapı.	Evet
└─ storage_queue	AzureFunctionStorageQueue	Depolama kuyruğu.	Hayı
└─ türü	enum	Her zaman 'storage_queue' olan bağlama türü. Olası değerler: storage_queue	Hayı
output_binding	nesne	Depolama kuyruğu adını ve URI'sini tutmaya yönelik yapı.	Evet
└─ storage_queue	AzureFunctionStorageQueue	Depolama kuyruğu.	Hayı
└─ türü	enum	Her zaman 'storage_queue' olan bağlama türü. Olası değerler: storage_queue	Hayı

AzureFunctionStorageQueue

Depolama kuyruğu adını ve URI'sini tutmaya yönelik yapı.

İsim	Türü	Description	Gerekli	Varsayılan
queue_name	String	Azure işlev depolama kuyruğunun adı.	Evet
queue_service_endpoint	String	Bir kuyruğu işlemenize olanak sağlayan Azure Depolama Kuyruğu hizmetine yönelik URI.	Evet

AzureOpenAIModelConfiguration

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

İsim	Türü	Description	Gerekli	Varsayılan
modelDeploymentName	String	AOAI modeli için dağıtım adı. Örnek: AIServices veya bağlantı tabanlı connection_name/deployment_name ise gpt-4o (örn. my-aoai-connection/gpt-4o	Evet
type	enum	Olası değerler: AzureOpenAIModel	Evet

BaseCredentials

Bağlantı kimlik bilgileri için bir temel sınıf

BaseCredentials için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
ApiKey	ApiKeyCredentials
AAD	EntraIDCredentials
CustomKeys	CustomCredential
SAS	SASCredentials
None	NoAuthenticationCredentials
AgenticIdentityToken	AgenticIdentityCredentials

İsim	Türü	Description	Gerekli	Varsayılan
type	nesne	Bağlantı tarafından kullanılan kimlik bilgisi türü	Evet

BingCustomSearchAgentTool

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

İsim	Türü	Description	Gerekli	Varsayılan
bing_custom_search_preview	nesne	Bing özel arama aracı parametreleri.	Evet
└─ search_configurations	dizi	Bu araca bağlı proje bağlantıları. En fazla 1 bağlantı olabilir aracına bağlı kaynak.	Hayı
type	enum	Her zaman 'bing_custom_search' olan nesne türü. Olası değerler: bing_custom_search_preview	Evet

BingCustomSearchConfiguration

Bing özel arama yapılandırması.

İsim	Türü	Description	Gerekli	Varsayılan
sayı	tamsayı	Bing api yanıtında döndürülecek arama sonuçlarının sayısı	Hayı
freshness	String	Arama sonuçlarını belirli bir zaman aralığına göre filtreleyin. Kabul edilen değerlere buradan bakın.	Hayı
instance_name	String	Yapılandırmaya verilen özel yapılandırma örneğinin adı.	Evet
pazar	String	Sonuçların geldiği pazar.	Hayı
project_connection_id	String	Bing araması ile topraklama için proje bağlantı kimliği	Evet
set_lang	String	Bing API'sini çağırırken kullanıcı arabirimi dizeleri için kullanılacak dil.	Hayı

BingCustomSearchToolParameters

Bing özel arama aracı parametreleri.

İsim	Türü	Description	Gerekli	Varsayılan
search_configurations	dizi	Bu araca bağlı proje bağlantıları. En fazla 1 bağlantı olabilir aracına bağlı kaynak.	Evet

BingGroundingAgentTool

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

İsim	Türü	Description	Gerekli	Varsayılan
bing_grounding	nesne	Bing topraklama arama aracı parametreleri.	Evet
└─ search_configurations	dizi	Bu araca eklenen arama yapılandırmaları. En fazla 1 olabilir ara çubuğuna bağlı arama yapılandırma kaynağı.	Hayı
type	enum	Her zaman 'bing_grounding' olan nesne türü. Olası değerler: bing_grounding	Evet

BingGroundingSearchConfiguration

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

İsim	Türü	Description	Gerekli	Varsayılan
sayı	tamsayı	Bing api yanıtında döndürülecek arama sonuçlarının sayısı	Hayı
freshness	String	Arama sonuçlarını belirli bir zaman aralığına göre filtreleyin. Kabul edilen değerlere buradan bakın.	Hayı
pazar	String	Sonuçların geldiği pazar.	Hayı
project_connection_id	String	Bing araması ile topraklama için proje bağlantı kimliği	Evet
set_lang	String	Bing API'sini çağırırken kullanıcı arabirimi dizeleri için kullanılacak dil.	Hayı

BingGroundingSearchToolParameters

Bing topraklama arama aracı parametreleri.

İsim	Türü	Description	Gerekli	Varsayılan
search_configurations	dizi	Bu araca eklenen arama yapılandırmaları. En fazla 1 olabilir ara çubuğuna bağlı arama yapılandırma kaynağı.	Evet

BlobReference

Blob başvuru ayrıntıları.

İsim	Türü	Description	Gerekli	Varsayılan
blobUri	String	İstemcinin verileri karşıya yüklemesi için Blob URI yolu. Örnek: https://blob.windows.core.net/Container/Path	Evet
credential	nesne	SAS Kimlik Bilgisi tanımı	Evet
└─ sasUri	String	SAS uri'si	Hayı
└─ türü	enum	Kimlik bilgisi türü Olası değerler: SAS	Hayı
storageAccountArmId	String	Kullanılacak depolama hesabının ARM kimliği.	Evet

BrowserAutomationAgentTool

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

İsim	Türü	Description	Gerekli	Varsayılan
browser_automation_preview	nesne	Tarayıcı Otomasyon Aracı için giriş parametrelerinin tanımı.	Evet
└─ bağlantı	BrowserAutomationToolConnectionParameters	Tarayıcı Otomasyon Aracı ile ilişkili proje bağlantı parametreleri.	Hayı
type	enum	Her zaman 'browser_automation' olan nesne türü. Olası değerler: browser_automation_preview	Evet

BrowserAutomationToolConnectionParameters

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

İsim	Türü	Description	Gerekli	Varsayılan
project_connection_id	String	Azure Playwright kaynağınıza proje bağlantısının kimliği.	Evet

BrowserAutomationToolParameters

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

İsim	Türü	Description	Gerekli	Varsayılan
bağlantı	nesne	Tarayıcı Otomasyon Aracı tarafından kullanılan bağlantı için giriş parametrelerinin tanımı.	Evet
└─ project_connection_id	String	Azure Playwright kaynağınıza proje bağlantısının kimliği.	Hayı

CaptureStructuredOutputsTool

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

İsim	Türü	Description	Gerekli	Varsayılan
Çıktılar	nesne	Aracı tarafından üretilebilen yapılandırılmış bir çıkış.	Evet
└─ açıklama	String	Yayınlanacak çıkışın açıklaması. Çıktının ne zaman yayınlanacağını belirlemek için model tarafından kullanılır.	Hayı
└─ ad	String	Yapılandırılmış çıkışın adı.	Hayı
└─ şeması		Yapılandırılmış çıkış için JSON şeması.	Hayı
└─ katı	Boolean	Sıkı doğrulamanın uygulanıp uygulanmayacağı. Varsayılan true.	Hayı
type	enum	Aracın türü. Her zaman capture_structured_outputs. Olası değerler: capture_structured_outputs	Evet

ChartCoordinate

Analiz tablosu için koordinatlar.

İsim	Türü	Description	Gerekli	Varsayılan
boyut	tamsayı	Grafik öğesinin boyutu.	Evet
x	tamsayı	X ekseni koordinatı.	Evet
y	tamsayı	Y ekseni koordinatı.	Evet

ChatSummaryMemoryItem

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

İsim	Türü	Description	Gerekli	Varsayılan
tür	enum	Hafıza öğesinin türü. Olası değerler: chat_summary	Evet

ClusterInsightResult

Küme analizinden elde edilen bilgiler.

İsim	Türü	Description	Gerekli	Varsayılan
clusters	dizi	İçgörülerde tanımlanan kümelerin listesi.	Evet
koordinatlar	nesne	Kimliklerin görselleştirme için UX tarafından kullanılan 2B koordinatlara isteğe bağlı eşlenmesi. Eşleme anahtarları dize tanımlayıcılarıdır (örneğin, küme kimliği veya örnek kimlik) ve değerler, 2B grafik üzerinde işleme için koordinatlar ve görsel boyutlardır. İstemci koordinat istemediği sürece bu özellik atlanır (örneğin, bir sorgu parametresi olarak geçirerek includeCoordinates=true ). Örnek: <br> {<br> "cluster-1": { "x": 12, "y": 34, "size": 8 },<br> "sample-123": { "x": 18, "y": 22, "size": 4 }<br> }<br> Koordinatlar yalnızca istemci tarafı görselleştirme için tasarlanmıştır ve kurallı içgörü sonuçlarını değiştirin.	Hayı
summary	nesne	Hata kümesi analizinin özeti.	Evet
└─ yöntemi	String	Kümeleme için kullanılan yöntem.	Hayı
└─ sampleCount	tamsayı	Analiz edilen toplam numune sayısı.	Hayı
└─ uniqueClusterCount	tamsayı	Benzersiz kümelerin toplam sayısı.	Hayı
└─ uniqueSubclusterCount	tamsayı	Benzersiz alt küme etiketlerinin toplam sayısı.	Hayı
└─ kullanımı	ClusterTokenUsage	Kümeleme analizi yapılırken belirteç kullanımı	Hayı

ClusterTokenUsage

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

İsim	Türü	Description	Gerekli	Varsayılan
inputTokenUsage	tamsayı	Giriş belirteci kullanımı	Evet
outputTokenUsage	tamsayı	Çıkış belirteci kullanımı	Evet
totalTokenUsage	tamsayı	Toplam jeton kullanımı	Evet

CodeBasedEvaluatorDefinition

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

İsim	Türü	Description	Gerekli	Varsayılan
code_text	String	Değerlendirici için satır içi kod metni	Evet
type	enum	Olası değerler: code	Evet

Bağlantı

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

İsim	Türü	Description	Gerekli	Varsayılan
credentials	nesne	Bağlantı kimlik bilgileri için bir temel sınıf	Evet
└─ türü	CredentialType	Bağlantı tarafından kullanılan kimlik bilgisi türü	Hayı
kimlik	String	Hizmet tarafından oluşturulan bağlantı için benzersiz bir tanımlayıcı	Evet
Varsayılan	Boolean	Bağlantının kendi türünde varsayılan bağlantı olarak etiketlenip etiketlenmediği	Evet
metadata	nesne	Bağlantının meta verileri	Evet
name	String	Kullanıcı tarafından sağlanan bağlantının kolay adı.	Evet
target	String	Bu hizmet için kullanılacak bağlantı URL'si	Evet
type	nesne	Bağlantının Türü (veya kategorisi)	Evet

BağlantıTürü

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

Mülkiyet	Değer
Açıklama	Bağlantının Türü (veya kategorisi)
Türü	String
Değerler	AzureOpenAI AzureBlob AzureStorageAccount CognitiveSearch CosmosDB ApiKey AppConfig AppInsights CustomKeys RemoteTool

ContainerAppAgentDefinition

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

İsim	Türü	Description	Gerekli	Varsayılan
container_app_resource_id	String	Bu aracıyı barındıran Azure Container App'in kaynak kimliği. Sürümler arasında değiştirilemez.	Evet
container_protocol_versions	dizi	Aracının kapsayıcıların giriş iletişimi için desteklediği protokoller.	Evet
ingress_subdomain_suffix	String	Aracıya giriş gönderirken uygulama alt etki alanına uygulanacak sonek. Bu, kapsayıcı uygulamasının varsayılan uç noktasını kullanmak için bir etiket (örneğin, '---geçerli'), belirli bir düzeltme (örneğin, '--0000001') veya boş olabilir.	Evet
tür	enum	Olası değerler: container_app	Evet

ContinuousEvalItemGenerationParams

Sürekli değerlendirme öğesi oluşturma parametrelerini temsil eder.

İsim	Türü	Description	Gerekli	Varsayılan
veri eşleme	nesne	Sohbet geçmişini almak için gereken kaynak alanlardan response_id alanına eşleme.	Evet
max_num_turns	tamsayı	Değerlendirilecek sohbet geçmişinin maksimum dönüş sayısı.	Evet
kaynak	nesne		Evet
└─ içerik	dizi	jsonl dosyasının içeriği.	Hayı
└─ kimlik	String	Dosyanın tanımlayıcısı.	Hayı
└─ türü	enum	Jsonl kaynağının türü. Her zaman file_id. Olası değerler: file_id	Hayı
type	enum	Her zaman ResponseRetrievalolan öğe oluşturma parametrelerinin türü. Olası değerler: response_retrieval	Evet

ContinuousEvaluationRuleAction

Sürekli değerlendirme için değerlendirme kuralı eylemi.

İsim	Türü	Description	Gerekli	Varsayılan
evalId	String	Sürekli değerlendirme çalıştırmaları eklemek için Değerlendirme Kimliği.	Evet
maxHourlyRuns	tamsayı	Saat başına izin verilen en fazla değerlendirme çalıştırması sayısı.	Hayı
type	enum	Olası değerler: continuousEvaluation	Evet

CosmosDB Dizini

CosmosDB Vektör Deposu Dizin Tanımı

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Endeks türü Olası değerler: CosmosDBNoSqlVectorStore	Evet

CosmosDBIndexUpdate

CosmosDB Vektör Deposu Dizin Tanımı

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Endeks türü Olası değerler: CosmosDBNoSqlVectorStore	Evet

CreateAgentFromManifestRequest

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

CreateAgentRequest

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

CreateAgentVersionFromManifestRequest

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

CreateAgentVersionRequest

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

Değerlendirme İstek Oluştur

İsim	Türü	Description	Gerekli	Varsayılan
veri_kaynağı_yapılandırması	nesne	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?	Evet
└─ örn_veri_düzeni_dahil_et	Boolean	Değerlendirmenin örnek ad alanını doldurmanızı beklemesi gerekip gerekmediği (örneğin, veri kaynağınızdan yanıt oluşturarak)	Hayı
└─ öğe şeması	nesne	Veri kaynağındaki her satır için json şeması.	Hayı
└─ meta veriler	nesne	Depolanan tamamlamalar veri kaynağı için meta veri filtreleri.	Hayı
└─ senaryosu	enum	Veri şeması senaryosu. Olası değerler: red_team, responses, traces	Hayı
└─ türü	enum	Her zaman label_modelolan nesne türü. Olası değerler: azure_ai_source	Hayı
metadata	OpenAI.Metadata	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Hayı
name	String	Değerlendirmenin adı.	Hayı
properties	nesne	Ek bilgileri depolamak için bir nesneye eklenebilen sabit 16 anahtar-değer çifti kümesi. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler, uzunluğu en fazla 512 karakter olan dizelerdir.	Hayı
test kriterleri	dizi	Bu gruptaki tüm değerlendirme çalıştırmaları için değerlendirici listesi. Not verenler, gibi {{item.variable_name}}çift küme ayracı gösterimini kullanarak veri kaynağındaki değişkenlere başvurabilir. Modelin çıkışına başvurmak için ad alanını sample (örneğin, {{sample.output_text}}) kullanın.	Evet

Değerlendirme Çalışması İsteği Oluştur

İsim	Türü	Description	Gerekli	Varsayılan
veri_kaynağı	nesne	Değerlendirmeyle eşleşen JSONL dosyasını belirten bir JsonlRunDataSource nesnesi	Evet
└─ giriş_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ı
└─ item_generation_params	RedTeamItemGenerationParams	Öğe oluşturma parametreleri.	Hayı
└─ modeli	String	Tamamlanmaları oluşturmak için kullanılacak modelin adı (örneğin, "o3-mini").	Hayı
└─ örnekleme_parametreleri	OpenAI.CreateEvalResponsesRunDataSourceSamplingParams		Hayı
└─ kaynak	OpenAI.EvalJsonlFileContentSource veya OpenAI.EvalJsonlFileIdSource veya OpenAI.EvalResponsesSource	Bu çalıştırmanın veri kaynağındaki ad alanını item neyin dolduracaklarını belirler.	Hayı
└─ hedef	Hedef	Değerlendirme için hedef yapılandırma.	Hayı
└─ türü	String	Veri kaynağı türü ayrıştırıcısı.	Hayı
metadata	OpenAI.Metadata	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Hayı
name	String	Koşunun adı.	Hayı
properties	nesne	Ek bilgileri depolamak için bir nesneye eklenebilen sabit 16 anahtar-değer çifti kümesi. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler, uzunluğu en fazla 512 karakter olan dizelerdir.	Hayı

Oluşturan

İsim	Türü	Description	Gerekli	Varsayılan
ajan	nesne		Hayı
└─ ad	String	Aracının adı.	Hayı
└─ türü	enum	Olası değerler: agent_id	Hayı
└─ sürümü	String	Aracının sürüm tanımlayıcısı.	Hayı
response_id	String	Öğenin oluşturulduğu yanıt.	Hayı

CredentialType

Bağlantı tarafından kullanılan kimlik bilgisi türü

Mülkiyet	Değer
Açıklama	Bağlantı tarafından kullanılan kimlik bilgisi türü
Türü	String
Değerler	ApiKey AAD SAS CustomKeys None AgenticIdentityToken

CronTrigger

Cron tabanlı tetikleyici.

İsim	Türü	Description	Gerekli	Varsayılan
endTime	String	ISO 8601 biçiminde cron zamanlaması için bitiş saati.	Hayı
ifade	String	Zamanlama sıklığını tanımlayan cron ifadesi.	Evet
startTime	String	ISO 8601 biçiminde cron zamanlaması için başlangıç saati.	Hayı
timeZone	String	Cron zamanlaması için saat dilimi.	Hayı	UTC (Koordinatlı Evrensel Zaman)
type	enum	Olası değerler: Cron	Evet

CustomCredential

Özel kimlik bilgisi tanımı

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Kimlik bilgisi türü Olası değerler: CustomKeys	Evet

DailyRecurrenceSchedule

Günlük yineleme programı.

İsim	Türü	Description	Gerekli	Varsayılan
hours	dizi	Yinelenme zamanlaması için saatler.	Evet
type	enum	Günlük tekrarlama türü. Olası değerler: Daily	Evet

DatasetType

Veri türünü belirlemek için sabit listesi.

Mülkiyet	Değer
Açıklama	Veri türünü belirlemek için sabit listesi.
Türü	String
Değerler	uri_file uri_folder

DatasetVersion

DatasetVersion Tanımı

DatasetVersion için Ayrıştırıcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
uri_file	FileDatasetVersion
uri_folder	FolderDatasetVersion

İsim	Türü	Description	Gerekli	Varsayılan
connectionName (bağlantıadı)	String	Azure Depolama Hesabı bağlantı adı. Veri Kümesi oluşturulmadan önce startPendingUploadVersion çağrılmadıysa gereklidir	Hayı
dataUri	String	Verilerin URI'si (örnek)	Evet
kimlik	String	Öğe kimliği, öğe için benzersiz bir tanımlayıcı	Hayı
isReference	Boolean	Veri kümesinin depolamaya bir başvuru içerip içermediğini veya veri kümesinin depolamayı kendisinin yönetip yönetmediğini gösterir. Doğruysa, veri kümesi sürümü silindiğinde temel alınan veriler silinmez	Hayı
name	String	Kaynağın adı	Evet
type	nesne	Veri türünü belirlemek için sabit listesi.	Evet
version	String	Kaynağın sürümü	Evet

DatasetVersionUpdate

DatasetVersion Tanımı

DatasetVersionUpdate için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
uri_file	FileDatasetVersionUpdate
uri_folder	FolderDatasetVersionUpdate

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

HaftanınGünü

Tekrarlama zamanlaması için haftanın günleri.

Mülkiyet	Değer
Açıklama	Tekrarlama zamanlaması için haftanın günleri.
Türü	String
Değerler	Sunday Monday Tuesday Wednesday Thursday Friday Saturday

DeleteAgentResponse

Silinmiş bir aracı Nesnesi

İsim	Türü	Description	Gerekli	Varsayılan
silindi	Boolean	Aracının başarıyla silinip silinmediği.	Evet
name	String	Aracının adı.	Evet
nesne	enum	Nesne türü. Her zaman 'agent.deleted'. Olası değerler: agent.deleted	Evet

DeleteAgentVersionResponse

Silinmiş bir aracı sürümü Nesnesi

İsim	Türü	Description	Gerekli	Varsayılan
silindi	Boolean	Aracının başarıyla silinip silinmediği.	Evet
name	String	Aracının adı.	Evet
nesne	enum	Nesne türü. Her zaman 'agent.deleted'. Olası değerler: agent.version.deleted	Evet
version	String	Aracının sürüm tanımlayıcısı.	Evet

DeleteEvalResponse

Silinen değerlendirme Nesnesi

İsim	Türü	Description	Gerekli	Varsayılan
silindi	Boolean	Değerlendirmenin başarıyla silinip silinmediği.	Evet
eval_id	String	değerlendirmenin kimliği.	Evet
nesne	enum	Nesne türü. Her zaman 'eval.deleted'. Olası değerler: eval.deleted	Evet

DeleteEvalRunResponse

Silinen değerlendirme çalıştırma nesnesi.

İsim	Türü	Description	Gerekli	Varsayılan
silindi	Boolean	Değerlendirmenin başarıyla silinip silinmediği.	Hayı
nesne	enum	Nesne türü. Her zaman 'eval.deleted'. Olası değerler: eval.deleted	Hayı
run_id	String	değerlendirmenin kimliği.	Hayı

DeleteMemoryStoreResponse

İsim	Türü	Description	Gerekli	Varsayılan
silindi	Boolean	Bellek deposunun başarıyla silinip silinmediği.	Evet
name	String	Bellek deposunun adı.	Evet
nesne	enum	Nesne türü. Her zaman 'memory_store.deleted'. Olası değerler: memory_store.deleted	Evet

DeleteResponseResult

Yanıt silme işleminin sonucu.

İsim	Türü	Description	Gerekli	Varsayılan
silindi	enum	Her zaman true döndür Olası değerler: True	Evet
kimlik	String	İşlem kimliği.	Evet
nesne	enum	Her zaman 'yanıt' döndür. Olası değerler: response	Evet

Dağıtım

Model Dağıtım Tanımı

Dağıtım için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
ModelDeployment	ModelDeployment

İsim	Türü	Description	Gerekli	Varsayılan
name	String	Dağıtımın adı	Evet
type	nesne		Evet

Deploymenttype

Mülkiyet	Değer
Türü	String
Değerler	ModelDeployment

EntraIDCredentials

Entra ID kimlik bilgisi tanımı

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Kimlik bilgisi türü Olası değerler: AAD	Evet

Değerlendirme

Veri kaynağı yapılandırması ve test ölçütlerine sahip bir Değerlendirme nesnesi. Değerlendirme, LLM tümleştirmeniz için yapılacak bir görevi temsil eder. Gibi:

• Sohbet botlarımın kalitesini artırma
• Sohbet botlarımın müşteri desteğini ne kadar iyi işlediğini görün
• O4-mini'nin benim kullanım alanımda gpt-4o'dan daha iyi olup olmadığını denetleyin

İsim	Türü	Description	Gerekli	Varsayılan
oluşturulma_tarihi	nesne		Evet
Oluşturan	String	çalıştırmayı oluşturan kişinin adı.	Hayı
veri_kaynağı_yapılandırması	nesne	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?	Evet
└─ örn_veri_düzeni_dahil_et	Boolean	Değerlendirmenin örnek ad alanını doldurmanızı beklemesi gerekip gerekmediği (örneğin, veri kaynağınızdan yanıt oluşturarak)	Hayı
└─ öğe şeması	nesne	Veri kaynağındaki her satır için json şeması.	Hayı
└─ meta veriler	nesne	Depolanan tamamlamalar veri kaynağı için meta veri filtreleri.	Hayı
└─ senaryosu	enum	Veri şeması senaryosu. Olası değerler: red_team, responses, traces	Hayı
└─ türü	enum	Her zaman label_modelolan nesne türü. Olası değerler: azure_ai_source	Hayı
kimlik	String	Değerlendirme için benzersiz tanımlayıcı.	Evet
metadata	OpenAI.Metadata	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Evet
modified_at	nesne		Hayı
name	String	Değerlendirmenin adı.	Evet
nesne	enum	Nesne türü. Olası değerler: eval	Evet
properties	nesne	Ek bilgileri depolamak için bir nesneye eklenebilen sabit 16 anahtar-değer çifti kümesi. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler, uzunluğu en fazla 512 karakter olan dizelerdir.	Hayı
test kriterleri	dizi	Test ölçütlerinin listesi.	Evet

EvalCompareReport

Değerlendirme karşılaştırmasından elde edilen bilgiler.

İsim	Türü	Description	Gerekli	Varsayılan
Karşılaştırma	dizi	Her tedavi için karşılaştırma sonuçları taban çizgisine göre çalışır.	Evet
method	String	Karşılaştırma için kullanılan istatistiksel yöntem.	Evet
type	enum	İçgörülerin türü sonucu. Olası değerler: EvaluationComparison	Evet

EvalResult

Değerlendirme sonucu.

İsim	Türü	Description	Gerekli	Varsayılan
name	String	Çekin adı	Evet
Geçirilen	Boolean	kontrolün başarılı olup olmadığını gösterir	Evet
Puan	Numara	Puan	Evet
type	String	Çekin türü	Evet

EvalRun

Değerlendirme oturumunu temsil eden şema.

İsim	Türü	Description	Gerekli	Varsayılan
oluşturulma_tarihi	nesne		Evet
Oluşturan	String	çalıştırmayı oluşturan kişinin adı.	Hayı
veri_kaynağı	nesne	Değerlendirmeyle eşleşen JSONL dosyasını belirten bir JsonlRunDataSource nesnesi	Evet
└─ giriş_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ı
└─ item_generation_params	RedTeamItemGenerationParams	Öğe oluşturma parametreleri.	Hayı
└─ modeli	String	Tamamlanmaları oluşturmak için kullanılacak modelin adı (örneğin, "o3-mini").	Hayı
└─ örnekleme_parametreleri	OpenAI.CreateEvalResponsesRunDataSourceSamplingParams		Hayı
└─ kaynak	OpenAI.EvalJsonlFileContentSource veya OpenAI.EvalJsonlFileIdSource veya OpenAI.EvalResponsesSource	Bu çalıştırmanın veri kaynağındaki ad alanını item neyin dolduracaklarını belirler.	Hayı
└─ hedef	Hedef	Değerlendirme için hedef yapılandırma.	Hayı
└─ türü	String	Veri kaynağı türü ayrıştırıcısı.	Hayı
hata	OpenAI.EvalApiError	Değerlendirme API'sinden bir hata yanıtını temsil eden nesne.	Evet
eval_id	String	İlişkili değerlendirmenin tanımlayıcısı.	Evet
kimlik	String	Değerlendirme çalışması için benzersiz tanımlayıcı.	Evet
metadata	OpenAI.Metadata	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Evet
model	String	Değerlendirilen model, eğer uygulanabiliyorsa.	Evet
modified_at	nesne		Hayı
name	String	Değerlendirme çalıştırmasının adı.	Evet
nesne	enum	Nesnenin türü. Her zaman "eval.run". Olası değerler: eval.run	Evet
model_başına_kullanım	dizi	Değerlendirme çalıştırması sırasında her model için kullanım istatistikleri.	Evet
test_kriterlerine_göre_sonuçlar	dizi	Değerlendirme çalıştırması sırasında uygulanan test kriterlerine göre sonuçlar.	Evet
properties	nesne	Ek bilgileri depolamak için bir nesneye eklenebilen sabit 16 anahtar-değer çifti kümesi. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler, uzunluğu en fazla 512 karakter olan dizelerdir.	Hayı
rapor_url	String	kullanıcı arabirimi panosunda görüntülenen değerlendirme raporunun URL'si.	Evet
sonuç_sayıları	nesne		Evet
└─ hata	OpenAI.integer		Hayı
└─ başarısız oldu	OpenAI.integer		Hayı
└─ geçti	OpenAI.integer		Hayı
└─ toplam	OpenAI.integer		Hayı
durum	String	Çalıştırma değerlendirmesinin durumu.	Evet

EvalRunDataSource

Ayrıştırıcı desteğiyle veri kaynaklarını çalıştırmak için temel sınıf.

EvalRunDataSource için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
azure_ai_traces	TracesEvalRunDataSource
azure_ai_responses	AzureAIResponses
azure_ai_target_completions	TargetCompletions

İsim	Türü	Description	Gerekli	Varsayılan
type	String	Veri kaynağı türü ayrıştırıcısı.	Evet

EvalRunOutputItem

Değerlendirme çalıştırmasının çıkış öğesini temsil eden bir şema.

İsim	Türü	Description	Gerekli	Varsayılan
oluşturulma_tarihi	nesne		Evet
veri kaynağı öğesi	nesne	Giriş veri kaynağı öğesinin ayrıntıları.	Evet
veri_kaynağı_öğe_kimliği	nesne		Evet
eval_id	String	Değerlendirme grubunun tanımlayıcısı.	Evet
kimlik	String	Değerlendirme çalıştırma çıkış öğesinin benzersiz tanımlayıcısı.	Evet
nesne	enum	Nesnenin türü. Her zaman "eval.run.output_item". Olası değerler: eval.run.output_item	Evet
results	dizi	Bu çıkış öğesi için not veren sonuçlarının listesi.	Evet
run_id	String	Bu çıkış öğesiyle ilişkili değerlendirme çalıştırmasının tanımlayıcısı.	Evet
örnek	nesne		Evet
└─ hata	OpenAI.EvalApiError	Değerlendirme API'sinden bir hata yanıtını temsil eden nesne.	Hayı
└─ bitiş_nedeni	String		Hayı
└─ giriş	dizi		Hayı
└─ maksimum_önem_bitim_kodları	OpenAI.integer		Hayı
└─ modeli	String		Hayı
└─ çıkış	dizi		Hayı
└─ tohum	OpenAI.integer		Hayı
└─ sıcaklık	OpenAI.numeric		Hayı
└─ top_p	OpenAI.numeric		Hayı
└─ kullanımı	OpenAI.EvalRunOutputItemSampleUsage		Hayı
durum	String	Çalıştırma değerlendirmesinin durumu.	Evet

EvalRunOutputItemResult

Değerlendirme çalıştırması çıkış öğesi için tek bir not veren sonucu.

İsim	Türü	Description	Gerekli	Varsayılan
label	String	Test ölçütü ölçümüyle ilişkili etiket (örneğin, "pass", "fail", "good", "bad").	Hayı
metric	String	Ölçümün adı (örneğin, "akıcılık", "f1_score").	Hayı
name	String	Değerlendiricinin adı.	Evet
Geçirilen	Boolean	Not verenin çıkışı bir geçiş olarak değerlendirip değerlendirmediği.	Evet
properties	nesne	Test ölçütleri ölçümü hakkında ek ayrıntılar.	Hayı
sebep	String	Test ölçütleri ölçüm nedeni.	Hayı
örnek	nesne	Not veren tarafından üretilen isteğe bağlı örnek veya ara veriler.	Hayı
Puan	nesne		Evet
threshold	Numara	Sayısalsa, bu test ölçütlerinin başarılı/başarısız olduğunu belirlemek için kullanılan eşik.	Hayı
type	String	Not veren türü (örneğin, "string-check-grader").	Hayı

EvalRunResultCompareItem

Bir tedavi için taban çizgisine karşı metrik karşılaştırma.

İsim	Türü	Description	Gerekli	Varsayılan
deltaEstimate	Numara	Tedavi ve başlangıç arasındaki tahmini fark.	Evet
pValue	Numara	Tedavi etkisi için P değeri.	Evet
treatmentEffect	nesne	Tedavi Etki Türü.	Evet
treatmentRunId	String	Tedavi çalıştırma kimliği.	Evet
treatmentRunSummary	nesne	Değerlendirme çalıştırmasındaki bir ölçümün özet istatistikleri.	Evet
└─ ortalama	Numara	Değerlendirme çalıştırmasındaki ölçümün ortalama değeri.	Hayı
└─ runId	String	Değerlendirme çalıştırma kimliği.	Hayı
└─ sampleCount	tamsayı	Değerlendirme çalıştırmasındaki örnek sayısı.	Hayı
└─ standardDeviation	Numara	Değerlendirme çalıştırmasında metriğin standart sapması.	Hayı

EvalRunResultComparison

Tedavi için karşılaştırma sonuçları taban çizgisine göre çalışır.

İsim	Türü	Description	Gerekli	Varsayılan
baselineRunSummary	nesne	Değerlendirme çalıştırmasındaki bir ölçümün özet istatistikleri.	Evet
└─ ortalama	Numara	Değerlendirme çalıştırmasındaki ölçümün ortalama değeri.	Hayı
└─ runId	String	Değerlendirme çalıştırma kimliği.	Hayı
└─ sampleCount	tamsayı	Değerlendirme çalıştırmasındaki örnek sayısı.	Hayı
└─ standardDeviation	Numara	Değerlendirme çalıştırmasında metriğin standart sapması.	Hayı
compareItems	dizi	Her tedavi çalışması için karşılaştırma sonuçlarının listesi.	Evet
Değerlendir -ici	String	Bu test kriteri için değerlendiricinin adı.	Evet
metric	String	Metrik değerlendiriliyor.	Evet
testingCriteria	String	Test kriterlerinin adı.	Evet

EvalRunResultSummary

Değerlendirme çalıştırmasındaki bir ölçümün özet istatistikleri.

İsim	Türü	Description	Gerekli	Varsayılan
ortalama	Numara	Değerlendirme çalıştırmasındaki ölçümün ortalama değeri.	Evet
runId	String	Değerlendirme çalıştırma kimliği.	Evet
sampleCount	tamsayı	Değerlendirme çalıştırmasındaki örnek sayısı.	Evet
standardDeviation	Numara	Değerlendirme çalıştırmasında metriğin standart sapması.	Evet

EvaluationComparisonRequest

Değerlendirme Karşılaştırma İsteği

İsim	Türü	Description	Gerekli	Varsayılan
baselineRunId	String	Karşılaştırma için temel çalıştırma kimliği.	Evet
evalId	String	Değerlendirme için tanımlayıcı.	Evet
treatmentRunIds	dizi	Karşılaştırma için tedavi çalıştırma kimliklerinin listesi.	Evet
type	enum	İstek türü. Olası değerler: EvaluationComparison	Evet

EvaluationResultSample

Değerlendirme sonucundan bir örnek.

İsim	Türü	Description	Gerekli	Varsayılan
evaluationResult	nesne	Değerlendirme sonucu.	Evet
└─ ad	String	Çekin adı	Hayı
└─ geçti	Boolean	kontrolün başarılı olup olmadığını gösterir	Hayı
└─ puanı	Numara	Puan	Hayı
└─ türü	String	Çekin türü	Hayı
type	enum	Değerlendirme Sonucu Örnek Türü Olası değerler: EvaluationResultSample	Evet

Değerlendirme Kuralı

Değerlendirme kuralı modeli.

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

EvaluationRuleAction

Değerlendirme eylem modeli.

EvaluationRuleAction için Ayrıştırıcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
continuousEvaluation	ContinuousEvaluationRuleAction
humanEvaluation	HumanEvaluationRuleAction

İsim	Türü	Description	Gerekli	Varsayılan
type	nesne	Değerlendirme eyleminin türü.	Evet

EvaluationRuleActionType

Değerlendirme eyleminin türü.

Mülkiyet	Değer
Açıklama	Değerlendirme eyleminin türü.
Türü	String
Değerler	continuousEvaluation humanEvaluation

EvaluationRuleEventType

Değerlendirme kuralı olayının türü.

Mülkiyet	Değer
Açıklama	Değerlendirme kuralı olayının türü.
Türü	String
Değerler	responseCompleted manual

EvaluationRuleFilter

Değerlendirme filtresi modeli.

İsim	Türü	Description	Gerekli	Varsayılan
ajan adı	String	Müşteri temsilcisi adına göre filtreleyin.	Evet

EvaluationRunClusterInsightResult

Değerlendirmeden elde edilen içgörüler küme analizini çalıştırır.

İsim	Türü	Description	Gerekli	Varsayılan
clusterInsight	ClusterInsightResult	Küme analizinden elde edilen bilgiler.	Evet
type	enum	İçgörülerin türü sonucu. Olası değerler: EvaluationRunClusterInsight	Evet

EvaluationRunClusterInsightsRequest

Değerlendirme Sonuçları kümesine ilişkin içgörüler

İsim	Türü	Description	Gerekli	Varsayılan
evalId	String	İçgörüler için Değerlendirme Kimliği.	Evet
model yapılandırması	nesne	İçgörü oluşturmada kullanılan modelin yapılandırması.	Hayı
└─ modelDeploymentName	String	Değerlendirilecek model dağıtımı. Dağıtım adını tek başına veya bağlantı adı olarak {connectionName}/<modelDeploymentName>kabul eder.	Hayı
runId'ler	dizi	İçgörüler için değerlendirme çalıştırma kimliklerinin listesi.	Evet
type	enum	İçgörü isteğinin türü. Olası değerler: EvaluationRunClusterInsight	Evet

EvaluationScheduleTask

Zamanlama için değerlendirme görevi.

İsim	Türü	Description	Gerekli	Varsayılan
evalId	String	Değerlendirme grubunun tanımlayıcısı.	Evet
evalRun	nesne	Değerlendirme çalıştırma yükü.	Evet
type	enum	Olası değerler: Evaluation	Evet

EvaluationTaxonomy

Değerlendirme Taksonomisi Tanımı

İsim	Türü	Description	Gerekli	Varsayılan
kimlik	String	Öğe kimliği, öğe için benzersiz bir tanımlayıcı	Hayı
name	String	Kaynağın adı	Evet
properties	nesne	Değerlendirme taksonomisi için ek özellikler.	Hayı
taksonomi Kategorileri	dizi	Taksonomi kategorilerinin listesi.	Hayı
taksonomiInput	nesne	Değerlendirme taksonomisi için giriş yapılandırması.	Evet
└─ türü	EvaluationTaxonomyInputType	Değerlendirme taksonomisinin giriş türü.	Hayı
version	String	Kaynağın sürümü	Evet

EvaluationTaxonomyCreateOrUpdate

Değerlendirme Taksonomisi Tanımı

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

EvaluationTaxonomyInput

Değerlendirme taksonomisi için giriş yapılandırması.

EvaluationTaxonomyInput için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
agent	AgentTaxonomyInput

İsim	Türü	Description	Gerekli	Varsayılan
type	nesne	Değerlendirme taksonomisi girişinin türü.	Evet

EvaluationTaxonomyInputType

Değerlendirme taksonomisi girişinin türü.

Mülkiyet	Değer
Açıklama	Değerlendirme taksonomisi girişinin türü.
Türü	String
Değerler	agent policy

EvaluationTaxonomyInputUpdate

Değerlendirme taksonomisi için giriş yapılandırması.

EvaluationTaxonomyInputUpdate için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
agent	AgentTaxonomyInputUpdate

İsim	Türü	Description	Gerekli	Varsayılan
type	nesne	Değerlendirme taksonomisi girişinin türü.	Evet

EvaluationTaxonomyUpdate

Değerlendirme Taksonomisi Tanımı

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

DeğerlendiriciKategorisi

Değerlendiricinin kategorisi

Mülkiyet	Değer
Açıklama	Değerlendiricinin kategorisi
Türü	String
Değerler	quality safety agents

DeğerlendiriciDefinition

Ayırıcılı temel değerlendirici konfigürasyonu

DeğerlendiriciDefinition için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
code	CodeBasedEvaluatorDefinition
prompt	PromptBasedEvaluatorDefinition

İsim	Türü	Description	Gerekli	Varsayılan
data_schema		Değerlendiricinin giriş verileri için JSON şeması (Taslak 2020-12). Bu, tür, özellikler, gerekli gibi parametreleri içerir.	Hayı
init_parameters		Değerlendiricinin giriş parametreleri için JSON şeması (Taslak 2020-12). Bu, tür, özellikler, gerekli gibi parametreleri içerir.	Hayı
metrics	nesne	Bu değerlendirici tarafından üretilen çıktı metriklerinin listesi	Hayı
type	nesne	Değerlendirici tanımının türü	Evet

EvaluatorDefinitionType

Değerlendirici tanımının türü

Mülkiyet	Değer
Açıklama	Değerlendirici tanımının türü
Türü	String
Değerler	prompt code prompt_and_code service openai_graders

DeğerlendiriciÖlçerÖlçer

Değerlendirici Metriği

İsim	Türü	Description	Gerekli	Varsayılan
desirable_direction	nesne	Daha yüksek bir değerin daha iyi, daha düşük bir değerin daha iyi veya nötr olup olmadığını gösteren metriğin yönü	Hayı
is_primary	Boolean	Birden çok ölçüm olduğunda bu ölçümün birincil olup olmadığını gösterir.	Hayı
max_value	Numara	Ölçüm için en yüksek değer. Belirtilmezse, sınırsız olduğu varsayılır.	Hayı
min_value	Numara	Metrik için minimum değer	Hayı
type	nesne	Değerlendiricinin türü	Hayı

DeğerlendiriciMetricDirection

Daha yüksek bir değerin daha iyi, daha düşük bir değerin daha iyi veya nötr olup olmadığını gösteren metriğin yönü

Mülkiyet	Değer
Açıklama	Daha yüksek bir değerin daha iyi, daha düşük bir değerin daha iyi veya nötr olup olmadığını gösteren metriğin yönü
Türü	String
Değerler	increase decrease neutral

DeğerlendiriciMetricType

Değerlendiricinin türü

Mülkiyet	Değer
Açıklama	Değerlendiricinin türü
Türü	String
Değerler	ordinal continuous boolean

Değerlendirici Türü

Değerlendiricinin türü

Mülkiyet	Değer
Açıklama	Değerlendiricinin türü
Türü	String
Değerler	builtin custom

EvaluatorVersion

Değerlendirici Tanımı

İsim	Türü	Description	Gerekli	Varsayılan
categories	dizi	Değerlendiricinin kategorileri	Evet
oluşturulma_tarihi	tamsayı	Değerlendiricinin oluşturulma tarihi/saati	Evet
Oluşturan	String	Değerlendiricinin yaratıcısı	Evet
tanım	nesne	Ayırıcılı temel değerlendirici konfigürasyonu	Evet
└─ data_schema		Değerlendiricinin giriş verileri için JSON şeması (Taslak 2020-12). Bu, tür, özellikler, gerekli gibi parametreleri içerir.	Hayı
└─ init_parameters		Değerlendiricinin giriş parametreleri için JSON şeması (Taslak 2020-12). Bu, tür, özellikler, gerekli gibi parametreleri içerir.	Hayı
└─ ölçümler	nesne	Bu değerlendirici tarafından üretilen çıktı metriklerinin listesi	Hayı
└─ türü	EvaluatorDefinitionType	Değerlendirici tanımının türü	Hayı
display_name	String	Değerlendirici için Görünen Ad. Foundry'de değerlendiriciyi kolayca bulmanıza yardımcı olur. Benzersiz olması gerekmez.	Hayı
evaluator_type	nesne	Değerlendiricinin türü	Evet
kimlik	String	Öğe kimliği, öğe için benzersiz bir tanımlayıcı	Hayı
metadata	nesne	Değerlendirici hakkında meta veriler	Hayı
modified_at	tamsayı	Değerlendiricinin son değiştirilme tarihi/saati	Evet
name	String	Kaynağın adı	Evet
version	String	Kaynağın sürümü	Evet

EvaluatorVersionCreate

Değerlendirici Tanımı

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

EvaluatorVersionUpdate

Değerlendirici Tanımı

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

FabricDataAgentToolParameters

Yapı veri aracısı aracı parametreleri.

İsim	Türü	Description	Gerekli	Varsayılan
project_connections	dizi	Bu araca bağlı proje bağlantıları. En fazla 1 bağlantı olabilir aracına bağlı kaynak.	Hayı

FileDatasetVersion

FileDatasetVersion Tanımı

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Veri kümesi türü Olası değerler: uri_file	Evet

FileDatasetVersionUpdate

FileDatasetVersion Tanımı

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Veri kümesi türü Olası değerler: uri_file	Evet

FolderDatasetVersion

FileDatasetVersion Tanımı

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Veri kümesi türü Olası değerler: uri_folder	Evet

FolderDatasetVersionUpdate

FileDatasetVersion Tanımı

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Veri kümesi türü Olası değerler: uri_folder	Evet

HostedAgentDefinition

Barındırılan aracı tanımı.

HostedAgentDefinition için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini kind kullanır:

Tür Değeri	Şema
hosted	ImageBasedHostedAgentDefinition

İsim	Türü	Description	Gerekli	Varsayılan
container_protocol_versions	dizi	Aracının kapsayıcıların giriş iletişimi için desteklediği protokoller.	Evet
cpu	String	Barındırılan aracının CPU yapılandırması.	Evet
environment_variables	nesne	Barındırılan aracı kapsayıcısında ayarlanacak ortam değişkenleri.	Hayı
tür	enum	Olası değerler: hosted	Evet
memory	String	Barındırılan aracının bellek yapılandırması.	Evet
araçlar	dizi	Barındırılan aracının modelinin yanıt oluştururken çağırabileceği bir dizi araç. Siz parametresini ayarlayarak tool_choice hangi aracın kullanılacağını belirtebilir.	Hayı

HourlyRecurrenceSchedule

Saatlik yinelenme zamanlaması.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olası değerler: Hourly	Evet

HumanEvaluationRuleAction

İnsan değerlendirmesi için değerlendirme kuralı eylemi.

İsim	Türü	Description	Gerekli	Varsayılan
şablonId	nesne	Kaydedilmiş bir varlığın tanımlayıcısı.	Evet
type	enum	Olası değerler: humanEvaluation	Evet

ImageBasedHostedAgentDefinition

Barındırılan bir aracı için görüntü tabanlı dağıtım tanımı.

İsim	Türü	Description	Gerekli	Varsayılan
image	String	Barındırılan aracının görüntüsü.	Evet
tür	enum	Olası değerler: hosted	Evet

Index

Dizin kaynağı Tanımı

Dizin için Ayrıştırıcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
AzureSearch	AzureAISearchIndex
ManagedAzureSearch	ManagedAzureAISearchIndex
CosmosDBNoSqlVectorStore	CosmosDBIndex

İsim	Türü	Description	Gerekli	Varsayılan
kimlik	String	Öğe kimliği, öğe için benzersiz bir tanımlayıcı	Hayı
name	String	Kaynağın adı	Evet
type	nesne		Evet
version	String	Kaynağın sürümü	Evet

IndexType

Mülkiyet	Değer
Türü	String
Değerler	AzureSearch CosmosDBNoSqlVectorStore ManagedAzureSearch

IndexUpdate

Dizin kaynağı Tanımı

IndexUpdate için Ayrıştırıcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
AzureSearch	AzureAISearchIndexUpdate
ManagedAzureSearch	ManagedAzureAISearchIndexUpdate
CosmosDBNoSqlVectorStore	CosmosDBIndexUpdate

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

İçgörü

Küme içgörüleri için yanıt gövdesi.

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

InsightCluster

Analiz örneklerinden oluşan bir küme.

İsim	Türü	Description	Gerekli	Varsayılan
açıklama	String	Analiz kümesinin açıklaması.	Evet
kimlik	String	Analiz kümesinin kimliği.	Evet
label	String	Küme için etiket	Evet
Örnekleri	dizi	Bu kümeye ait örneklerin listesi. Örnekler alt kümelerin parçasıysa boşaltın.	Hayı
alt kümeler	dizi	Bu küme içindeki alt kümelerin listesi. Alt küme yoksa boştur.	Hayı
öneri	String	Küme için öneri	Evet
suggestionTitle	String	Küme için önerinin başlığı	Evet
weight	tamsayı	Analiz kümesinin ağırlığı. Bu, kümedeki örnek sayısını gösterir.	Evet

InsightModelConfiguration

İçgörü oluşturmada kullanılan modelin yapılandırması.

İsim	Türü	Description	Gerekli	Varsayılan
modelDeploymentName	String	Değerlendirilecek model dağıtımı. Dağıtım adını tek başına veya bağlantı adı olarak {connectionName}/<modelDeploymentName>kabul eder.	Evet

InsightRequest

İçgörüler raporunun isteği.

InsightRequest için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
EvaluationRunClusterInsight	EvaluationRunClusterInsightsRequest
AgentClusterInsight	AgentClusterInsightsRequest
EvaluationComparison	EvaluationComparisonRequest

İsim	Türü	Description	Gerekli	Varsayılan
type	nesne	İçgörülerin isteği.	Evet

InsightResult

İçgörülerin sonucu.

InsightResult için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
EvaluationComparison	EvalCompareReport
EvaluationRunClusterInsight	EvaluationRunClusterInsightResult
AgentClusterInsight	AgentClusterInsightResult

İsim	Türü	Description	Gerekli	Varsayılan
type	nesne	İçgörülerin isteği.	Evet

InsightSample

Analizden bir örnek.

InsightSample için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
EvaluationResultSample	EvaluationResultSample

İsim	Türü	Description	Gerekli	Varsayılan
correlationInfo	nesne	Analiz örneğinin korelasyonu hakkında bilgi.	Evet
features	nesne	UX'te verilerin ek filtrelenmesine yardımcı olacak özellikler.	Evet
kimlik	String	Analiz örneğinin benzersiz tanımlayıcısı.	Evet
type	nesne	Analizde kullanılan numunenin türü.	Evet

InsightScheduleTask

Zamanlama için içgörü görevi.

İsim	Türü	Description	Gerekli	Varsayılan
içgörü	nesne	Küme içgörüleri için yanıt gövdesi.	Evet
└─ displayName	String	İçgörü için kullanıcı dostu görünen ad.	Hayı
└─ kimlik	String	İçgörüler raporunun benzersiz tanımlayıcısı.	Hayı
└─ meta veriler	InsightsMetadata	İçgörüler raporuyla ilgili meta veriler.	Hayı
└─ isteği	InsightRequest	İçgörü analizi için talepte bulunun.	Hayı
└─ sonuç	InsightResult	İçgörüler raporunun sonucu.	Hayı
└─ durumu	Azure.Core.Foundations.OperationState	İçgörülerin mevcut durumu.	Hayı
type	enum	Olası değerler: Insight	Evet

InsightSummary

Hata kümesi analizinin özeti.

İsim	Türü	Description	Gerekli	Varsayılan
method	String	Kümeleme için kullanılan yöntem.	Evet
sampleCount	tamsayı	Analiz edilen toplam numune sayısı.	Evet
uniqueClusterCount	tamsayı	Benzersiz kümelerin toplam sayısı.	Evet
uniqueSubclusterCount	tamsayı	Benzersiz alt küme etiketlerinin toplam sayısı.	Evet
usage	nesne	Küme analizi için belirteç kullanımı	Evet
└─ inputTokenUsage	tamsayı	Giriş belirteci kullanımı	Hayı
└─ outputTokenUsage	tamsayı	Çıkış belirteci kullanımı	Hayı
└─ totalTokenUsage	tamsayı	Toplam jeton kullanımı	Hayı

InsightType

İçgörülerin isteği.

Mülkiyet	Değer
Türü	String
Değerler	EvaluationRunClusterInsight AgentClusterInsight EvaluationComparison

InsightsMetadata

İçgörülerle ilgili meta veriler.

İsim	Türü	Description	Gerekli	Varsayılan
completedAt	String	İçgörülerin tamamlandığı zaman damgası.	Hayı
createdAt	String	İçgörülerin oluşturulduğu zaman damgası.	Evet

ItemGenerationParams

Öğe oluşturma işlemlerini denetlemek için kullanılan parametre kümesini temsil eder.

ItemGenerationParams için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema

İsim	Türü	Description	Gerekli	Varsayılan
type	String	Kullanılacak öğe oluşturma parametrelerinin türü.	Evet

ManagedAzureAISearchIndex

Yönetilen Azure AI Search Dizin Tanımı

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Endeks türü Olası değerler: ManagedAzureSearch	Evet

ManagedAzureAISearchIndexUpdate

Yönetilen Azure AI Search Dizin Tanımı

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Endeks türü Olası değerler: ManagedAzureSearch	Evet

MemoryItem

Bellek deposunda saklanan, içerik ve meta verileri içeren tek bir bellek öğesi.

MemoryItem için Ayrıştırıcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini kind kullanır:

Tür Değeri	Şema
user_profile	UserProfileMemoryItem
chat_summary	ChatSummaryMemoryItem

İsim	Türü	Description	Gerekli	Varsayılan
içerik	String	Belleğin içeriği.	Evet
tür	nesne	Bellek öğesi türü.	Evet
memory_id	String	Bellek öğesinin benzersiz kimliği.	Evet
kapsam	String	Kullanıcı kimliği gibi anıları mantıksal olarak gruplandıran ve yalıtan ad alanı.	Evet
updated_at	tamsayı	Bellek öğesinin son güncelleme zamanı.	Evet

MemoryItemKind

Bellek öğesi türü.

Mülkiyet	Değer
Açıklama	Bellek öğesi türü.
Türü	String
Değerler	user_profile chat_summary

MemoryOperation

Bir bellek öğesi üzerinde gerçekleştirilen tek bir bellek işlemini (oluşturma, güncelleştirme veya silme) temsil eder.

İsim	Türü	Description	Gerekli	Varsayılan
tür	nesne	Bellek işlemi türü.	Evet
memory_item	nesne	Bellek deposunda saklanan, içerik ve meta verileri içeren tek bir bellek öğesi.	Evet
└─ içerik	String	Belleğin içeriği.	Hayı
└─ tür	MemoryItemKind	Hafıza öğesinin türü.	Hayı
└─ memory_id	String	Bellek öğesinin benzersiz kimliği.	Hayı
└─ kapsam	String	Kullanıcı kimliği gibi anıları mantıksal olarak gruplandıran ve yalıtan ad alanı.	Hayı
└─ updated_at	tamsayı	Bellek öğesinin son güncelleme zamanı.	Hayı

MemoryOperationKind

Bellek işlemi türü.

Mülkiyet	Değer
Açıklama	Bellek işlemi türü.
Türü	String
Değerler	create update delete

MemorySearchItem

Bellek aramasından alınan bir bellek öğesi.

İsim	Türü	Description	Gerekli	Varsayılan
memory_item	nesne	Bellek deposunda saklanan, içerik ve meta verileri içeren tek bir bellek öğesi.	Evet
└─ içerik	String	Belleğin içeriği.	Hayı
└─ tür	MemoryItemKind	Hafıza öğesinin türü.	Hayı
└─ memory_id	String	Bellek öğesinin benzersiz kimliği.	Hayı
└─ kapsam	String	Kullanıcı kimliği gibi anıları mantıksal olarak gruplandıran ve yalıtan ad alanı.	Hayı
└─ updated_at	tamsayı	Bellek öğesinin son güncelleme zamanı.	Hayı

MemorySearchOptions

Bellek arama seçenekleri.

İsim	Türü	Description	Gerekli	Varsayılan
max_memories	tamsayı	Döndürülecek en fazla bellek öğesi sayısı.	Hayı

MemorySearchTool

Anıları aracıya entegre etmek için bir araç.

İsim	Türü	Description	Gerekli	Varsayılan
memory_store_name	String	Kullanılacak bellek deposunun adı.	Evet
kapsam	String	Kullanıcı kimliği gibi anıları gruplandırmak ve yalıtmak için kullanılan ad alanı. Hangi anıların alınabileceğini veya güncellenebileceğini sınırlar. Belleklerin kapsamını geçerli oturum açmış kullanıcıya genişletmek için özel değişken {{$userId}} kullanın.	Evet
search_options	nesne	Bellek arama seçenekleri.	Hayı
└─ max_memories	tamsayı	Döndürülecek en fazla bellek öğesi sayısı.	Hayı
type	enum	Aracın türü. Her zaman memory_search. Olası değerler: memory_search	Evet
update_delay	tamsayı	Hareketsizlikten sonra anıları güncellemeden önce bekleme süresi (saniye). Varsayılan 300.	Hayı	300

MemorySearchToolCallItemParam

İsim	Türü	Description	Gerekli	Varsayılan
results	dizi	Bellek aramasından döndürülen sonuçlar.	Hayı
type	enum	Olası değerler: memory_search_call	Evet

MemorySearchToolCallItemResource

İsim	Türü	Description	Gerekli	Varsayılan
results	dizi	Bellek aramasından döndürülen sonuçlar.	Hayı
durum	enum	Bellek arama aracı çağrısının durumu. Bunlardan biri in_progress searching, completedveya incompletefailed, Olası değerler: in_progress, searching, completed, incomplete, failed	Evet
type	enum	Olası değerler: memory_search_call	Evet

MemoryStoreDefaultDefinition

Varsayılan bellek deposu uygulaması.

İsim	Türü	Description	Gerekli	Varsayılan
chat_model	String	Bellek işleme için kullanılan sohbet tamamlama modeli dağıtımının adı veya tanımlayıcısı.	Evet
embedding_model	String	Bellek işleme için kullanılan ekleme modeli dağıtımının adı veya tanımlayıcısı.	Evet
tür	enum	Bellek deposunun türü. Olası değerler: default	Evet
options	nesne	Varsayılan bellek deposu yapılandırmaları.	Hayı
└─ chat_summary_enabled	Boolean	Sohbet özeti çıkarma ve depolamanın etkinleştirilip etkinleştirilmeyeceği. Varsayılan değer doğrudur	Hayı	Doğru
└─ user_profile_details	String	Ayıklanacak ve saklanacak belirli kategoriler veya kullanıcı profili bilgisi türleri.	Hayı
└─ user_profile_enabled	Boolean	Kullanıcı profili ayıklama ve depolamanın etkinleştirilip etkinleştirilmeyeceği. Varsayılan değer doğrudur	Hayı	Doğru

MemoryStoreDefaultOptions

Varsayılan bellek deposu yapılandırmaları.

İsim	Türü	Description	Gerekli	Varsayılan
chat_summary_enabled	Boolean	Sohbet özeti çıkarma ve depolamanın etkinleştirilip etkinleştirilmeyeceği. Varsayılan değer doğrudur	Evet	Doğru
user_profile_details	String	Ayıklanacak ve saklanacak belirli kategoriler veya kullanıcı profili bilgisi türleri.	Hayı
user_profile_enabled	Boolean	Kullanıcı profili ayıklama ve depolamanın etkinleştirilip etkinleştirilmeyeceği. Varsayılan değer doğrudur	Evet	Doğru

MemoryStoreDefinition

Bellek deposu yapılandırmaları için temel tanım.

MemoryStoreDefinition için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini kind kullanır:

Tür Değeri	Şema
default	MemoryStoreDefaultDefinition

İsim	Türü	Description	Gerekli	Varsayılan
tür	nesne	Kullanılacak bellek deposu uygulamasının türü.	Evet

MemoryStoreDeleteScopeResponse

Bir kapsamdan anıları silme yanıtı.

İsim	Türü	Description	Gerekli	Varsayılan
silindi	Boolean	Silme işleminin başarılı olup olmadığı.	Evet
name	String	Bellek deposunun adı.	Evet
nesne	enum	Nesne türü. Her zaman 'memory_store.scope.deleted'. Olası değerler: memory_store.scope.deleted	Evet
kapsam	String	Anıların silindiği kapsam.	Evet

MemoryStoreKind

Kullanılacak bellek deposu uygulamasının türü.

Mülkiyet	Değer
Açıklama	Kullanılacak bellek deposu uygulamasının türü.
Türü	String
Değerler	default

MemoryStoreObject

Kullanıcı anılarını depolayabilen ve alabilen bir bellek deposu.

İsim	Türü	Description	Gerekli	Varsayılan
oluşturulma_tarihi	tamsayı	Bellek deposunun oluşturulduğu Unix zaman damgası (saniye).	Evet
tanım	nesne	Bellek deposu yapılandırmaları için temel tanım.	Evet
└─ tür	MemoryStoreKind	Bellek deposunun türü.	Hayı
açıklama	String	Bellek deposunun okunabilir bir açıklaması.	Hayı
kimlik	String	Bellek deposunun benzersiz tanımlayıcısı.	Evet
metadata	nesne	Bellek deposuyla ilişkilendirilecek rastgele anahtar-değer meta verileri.	Hayı
name	String	Bellek deposunun adı.	Evet
nesne	enum	Her zaman 'memory_store' olan nesne türü. Olası değerler: memory_store	Evet
updated_at	tamsayı	Bellek deposunun en son güncellendiği Unix zaman damgası (saniye).	Evet

MemoryStoreOperationUsage

Bellek deposu işleminin kullanım istatistikleri.

İsim	Türü	Description	Gerekli	Varsayılan
embedding_tokens	tamsayı	Ekleme belirteçlerinin sayısı.	Evet
input_tokens	tamsayı	Giriş belirteçlerinin sayısı.	Evet
input_tokens_details	nesne	Giriş belirteçlerinin ayrıntılı dökümü.	Evet
└─ önbelleğe alınmış jetonlar	tamsayı	Önbellekten alınan belirteçlerin sayısı. İstem önbelleğe alma hakkında daha fazla bilgi.	Hayı
output_tokens	tamsayı	Çıkış belirteçlerinin sayısı.	Evet
output_tokens_details	nesne	Çıkış belirteçlerinin ayrıntılı dökümü.	Evet
└─ akıl yürütme_tokenlar	tamsayı	Akıl yürütme belirteçlerinin sayısı.	Hayı
total_tokens	tamsayı	Kullanılan toplam belirteç sayısı.	Evet

MemoryStoreSearchResponse

Bellek arama yanıtı.

İsim	Türü	Description	Gerekli	Varsayılan
Anıları	dizi	Arama işlemi sırasında bulunan ilgili bellek öğeleri.	Evet
search_id	String	Bu arama isteğinin benzersiz kimliği. Artımlı aramalar gerçekleştirmek için sonraki isteklerde previous_search_id olarak bu değeri kullanın.	Evet
usage	nesne	Bellek deposu işleminin kullanım istatistikleri.	Evet
└─ embedding_tokens	tamsayı	Ekleme belirteçlerinin sayısı.	Hayı
└─ girdi_simgeleri	tamsayı	Giriş belirteçlerinin sayısı.	Hayı
└─ giriş_jeton_detayları	nesne	Giriş belirteçlerinin ayrıntılı dökümü.	Hayı
└─ önbelleğe alınmış jetonlar	tamsayı	Önbellekten alınan belirteçlerin sayısı. İstem önbelleğe alma hakkında daha fazla bilgi.	Hayı
└─ çıkış_birimleri	tamsayı	Çıkış belirteçlerinin sayısı.	Hayı
└─ output_tokens_details	nesne	Çıkış belirteçlerinin ayrıntılı dökümü.	Hayı
└─ akıl yürütme_tokenlar	tamsayı	Akıl yürütme belirteçlerinin sayısı.	Hayı
└─ toplam_jetonlar	tamsayı	Kullanılan toplam belirteç sayısı.	Hayı

MemoryStoreUpdateCompletedResult

Bellek güncelleme sonucu.

İsim	Türü	Description	Gerekli	Varsayılan
memory_operations	dizi	Güncelleştirme sırasında gerçekleştirilen tek tek bellek işlemlerinin listesi.	Evet
usage	nesne	Bellek deposu işleminin kullanım istatistikleri.	Evet
└─ embedding_tokens	tamsayı	Ekleme belirteçlerinin sayısı.	Hayı
└─ girdi_simgeleri	tamsayı	Giriş belirteçlerinin sayısı.	Hayı
└─ giriş_jeton_detayları	nesne	Giriş belirteçlerinin ayrıntılı dökümü.	Hayı
└─ önbelleğe alınmış jetonlar	tamsayı	Önbellekten alınan belirteçlerin sayısı. İstem önbelleğe alma hakkında daha fazla bilgi.	Hayı
└─ çıkış_birimleri	tamsayı	Çıkış belirteçlerinin sayısı.	Hayı
└─ output_tokens_details	nesne	Çıkış belirteçlerinin ayrıntılı dökümü.	Hayı
└─ akıl yürütme_tokenlar	tamsayı	Akıl yürütme belirteçlerinin sayısı.	Hayı
└─ toplam_jetonlar	tamsayı	Kullanılan toplam belirteç sayısı.	Hayı

MemoryStoreUpdateResponse

Bellek deposu güncelleştirme işleminin durumunu sağlar.

İsim	Türü	Description	Gerekli	Varsayılan
hata	nesne		Hayı
└─ ekBilgi	nesne		Hayı
└─ kod	String		Hayı
└─ debugInfo	nesne		Hayı
└─ ayrıntılar	dizi		Hayı
└─ ileti	String		Hayı
└─ parametre	String		Hayı
└─ türü	String		Hayı
sonuç	nesne	Bellek güncelleme sonucu.	Hayı
└─ memory_operations	dizi	Güncelleştirme sırasında gerçekleştirilen tek tek bellek işlemlerinin listesi.	Hayı
└─ kullanımı	MemoryStoreOperationUsage	Bellek güncelleştirme işlemiyle ilişkili kullanım istatistikleri.	Hayı
durum	nesne	Bellek deposu güncelleştirme işleminin durumu.	Evet
superseded_by	String	İşlemin yerini aldığı update_id, durumun "yerine geçen" zamandır.	Hayı
update_id	String	Bu güncelleştirme isteğinin benzersiz kimliği. Artımlı güncelleştirmeler gerçekleştirmek için sonraki isteklerde bu değeri previous_update_id olarak kullanın.	Evet

MemoryStoreUpdateStatus

Bellek deposu güncelleştirme işleminin durumu.

Mülkiyet	Değer
Açıklama	Bellek deposu güncelleştirme işleminin durumu.
Türü	String
Değerler	queued in_progress completed failed superseded

MicrosoftFabricAgentTool

Aracıyı yapılandırmak için kullanılan Bir Microsoft Fabric aracının giriş tanımı bilgileri.

İsim	Türü	Description	Gerekli	Varsayılan
fabric_dataagent_preview	nesne	Yapı veri aracısı aracı parametreleri.	Evet
└─ project_connections	dizi	Bu araca bağlı proje bağlantıları. En fazla 1 bağlantı olabilir aracına bağlı kaynak.	Hayı
type	enum	Her zaman 'fabric_dataagent' olan nesne türü. Olası değerler: fabric_dataagent_preview	Evet

ModelDeployment

Model Dağıtım Tanımı

İsim	Türü	Description	Gerekli	Varsayılan
capabilities	nesne	Dağıtılan modelin yetenekleri	Evet
connectionName (bağlantıadı)	String	Dağıtımın geldiği bağlantının adı	Hayı
modelName	String	Dağıtılan modelin yayımcıya özgü adı	Evet
modelPublisher	String	Dağıtılan modelin yayımcısının adı	Evet
modelVersion	String	Dağıtılan modelin yayımcıya özgü sürümü	Evet
sku	nesne	Sku bilgileri	Evet
└─ kapasite	tamsayı	Sku kapasitesi	Hayı
└─ aile	String	Sku ailesi	Hayı
└─ ad	String	Sku adı	Hayı
└─ boyutu	String	Sku boyutu	Hayı
└─ katmanı	String	Sku katmanı	Hayı
type	enum	Dağıtımın türü Olası değerler: ModelDeployment	Evet

ModelÖrnekLemeParamları

Metin oluşturma sırasında dil modelinin örnekleme davranışını denetlemek için kullanılan bir parametre kümesini temsil eder.

İsim	Türü	Description	Gerekli	Varsayılan
max_completion_tokens	tamsayı	Tamamlanmada izin verilen en fazla belirteç sayısı.	Evet
seed	tamsayı	Yeniden üretilebilirlik için rastgele tohum.	Evet
sıcaklık	Numara	Örnekleme için sıcaklık parametresi.	Evet
top_p	Numara	Çekirdek örnekleme için top-p parametresi.	Evet

ModelSamplingParamsUpdate

Metin oluşturma sırasında dil modelinin örnekleme davranışını denetlemek için kullanılan bir parametre kümesini temsil eder.

İsim	Türü	Description	Gerekli	Varsayılan
max_completion_tokens	tamsayı	Tamamlanmada izin verilen en fazla belirteç sayısı.	Hayı
seed	tamsayı	Yeniden üretilebilirlik için rastgele tohum.	Hayı
sıcaklık	Numara	Örnekleme için sıcaklık parametresi.	Hayı
top_p	Numara	Çekirdek örnekleme için top-p parametresi.	Hayı

MonthlyRecurrenceSchedule

Aylık yinelenme zamanlaması.

İsim	Türü	Description	Gerekli	Varsayılan
daysOfMonth	dizi	Yinelenme zamanlaması için ayın günleri.	Evet
type	enum	Aylık yinelenme türü. Olası değerler: Monthly	Evet

NoAuthenticationCredentials

Kimlik doğrulaması gerektirmeyen kimlik bilgileri

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Kimlik bilgisi türü Olası değerler: None	Evet

OAuthConsentRequestItemResource

Hizmetten kullanıcının OAuth onayı gerçekleştirmesini isteyin.

İsim	Türü	Description	Gerekli	Varsayılan
consent_link	String	Kullanıcının OAuth onayı gerçekleştirmek için kullanabileceği bağlantı.	Evet
kimlik	String		Evet
sunucu etiketi	String	OAuth onay isteğinin sunucu etiketi.	Evet
type	enum	Olası değerler: oauth_consent_request	Evet

OneTimeTrigger

Tek seferlik tetikleyici.

İsim	Türü	Description	Gerekli	Varsayılan
timeZone	String	Tek seferlik tetikleyici için saat dilimi.	Hayı	UTC (Koordinatlı Evrensel Zaman)
triggerAt	String	ISO 8601 biçiminde tek seferlik tetikleyicinin tarih ve saati.	Evet
type	enum	Olası değerler: OneTime	Evet

OpenAI.Annotation

OpenAI.Annotation için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
file_citation	OpenAI.AnnotationFileCitation
url_citation	OpenAI.AnnotationUrlCitation
file_path	OpenAI.AnnotationFilePath

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.AnnotationType		Evet

OpenAI.AnnotationFileCitation

Bir dosyaya referans.

İsim	Türü	Description	Gerekli	Varsayılan
dosya_kimlik	String	Dosyanın kimliği.	Evet
filename	String	Belirtilen dosyanın dosya adı.	Evet
indeks	tamsayı	Dosya listesindeki dosyanın dizini.	Evet
type	enum	Dosya alıntısının türü. Her zaman file_citation. Olası değerler: file_citation	Evet

OpenAI.AnnotationFilePath

Bir dosyaya giden yol.

İsim	Türü	Description	Gerekli	Varsayılan
dosya_kimlik	String	Dosyanın kimliği.	Evet
indeks	tamsayı	Dosya listesindeki dosyanın dizini.	Evet
type	enum	Dosya yolunun türü. Her zaman file_path. Olası değerler: file_path	Evet

OpenAI.AnnotationType

Mülkiyet	Değer
Türü	String
Değerler	file_citation url_citation file_path container_file_citation

OpenAI.AnnotationUrlCitation

Model yanıtı oluşturmak için kullanılan bir web kaynağı alıntısı.

İsim	Türü	Description	Gerekli	Varsayılan
end_index	tamsayı	İletideki URL alıntısının son karakterinin dizini.	Evet
start_index	tamsayı	İletideki URL alıntısının ilk karakterinin dizini.	Evet
title	String	Web kaynağının başlığı.	Evet
type	enum	URL alıntısının türü. Her zaman url_citation. Olası değerler: url_citation	Evet
url	String	Web kaynağının URL'si.	Evet

OpenAI.YaklaşıkKonum

İsim	Türü	Description	Gerekli	Varsayılan
city	String		Hayı
country	String		Hayı
region	String		Hayı
timezone	String		Hayı
type	enum	Olası değerler: approximate	Evet

OpenAI Sohbet Tamamlama Aracı

Yanıt oluşturmak için kullanılabilecek bir işlev aracı.

İsim	Türü	Description	Gerekli	Varsayılan
function	OpenAI.FunctionObject		Evet
type	enum	Aracın türü. Şu anda yalnızca function desteklenmektedir. Olası değerler: function	Evet

OpenAI.CodeInterpreterOutput

OpenAI.CodeInterpreterOutput için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
image	OpenAI.CodeInterpreterOutputImage
logs	OpenAI.CodeInterpreterOutputLogs

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.CodeInterpreterOutputType		Evet

OpenAI.CodeInterpreterOutputImage

Kod yorumlayıcıdan görüntü çıkışı.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Çıktının türü. Her zaman 'resim'. Olası değerler: image	Evet
url	String	Kod yorumlayıcıdan görüntü çıkışının URL'si.	Evet

OpenAI.CodeInterpreterOutputLogs

Günlükler kod yorumlayıcıdan çıkar.

İsim	Türü	Description	Gerekli	Varsayılan
logs	String	Günlükler kod yorumlayıcıdan çıkar.	Evet
type	enum	Çıktının türü. Her zaman 'günlükler'. Olası değerler: logs	Evet

OpenAI.CodeInterpreterOutputType

Mülkiyet	Değer
Türü	String
Değerler	logs image

OpenAI.CodeInterpreterTool

Bir istem için yanıt oluşturmaya yardımcı olmak için Python kodu çalıştıran bir araç.

İsim	Türü	Description	Gerekli	Varsayılan
container	nesne	Kod yorumlayıcı kapsayıcısı için yapılandırma. İsteğe bağlı olarak kimlikleri belirtin Kodun çalıştırılacağı dosyaları seçin.	Evet
└─ dosya_kimlikleri	dizi	Kodunuz için kullanılabilir hale getirmek üzere yüklenen dosyaların isteğe bağlı bir listesi.	Hayı
└─ türü	enum	Her zaman auto. Olası değerler: auto	Hayı
type	enum	Kod yorumlayıcı aracının türü. Her zaman code_interpreter. Olası değerler: code_interpreter	Evet

OpenAI.CodeInterpreterToolAuto

Kod yorumlayıcı kapsayıcısı için yapılandırma. İsteğe bağlı olarak kodun çalıştırıldığı dosyaların kimliklerini belirtin.

İsim	Türü	Description	Gerekli	Varsayılan
dosya_kimlikleri	dizi	Kodunuz için kullanılabilir hale getirmek üzere yüklenen dosyaların isteğe bağlı bir listesi.	Hayı
type	enum	Her zaman auto. Olası değerler: auto	Evet

OpenAI.CodeInterpreterToolCallItemParam

Kodu çalıştırmak için bir araç çağrısı.

İsim	Türü	Description	Gerekli	Varsayılan
kod	String	Çalıştırılacak kod veya kullanılamıyorsa null.	Evet
container_id	String	Kodu çalıştırmak için kullanılan kapsayıcının kimliği.	Evet
Çıktılar	dizi	Günlükler veya görüntüler gibi kod yorumlayıcı tarafından oluşturulan çıkışlar. Kullanılabilir çıkış yoksa null olabilir.	Evet
type	enum	Olası değerler: code_interpreter_call	Evet

OpenAI.CodeInterpreterToolCallItemResource

Kodu çalıştırmak için bir araç çağrısı.

İsim	Türü	Description	Gerekli	Varsayılan
kod	String	Çalıştırılacak kod veya kullanılamıyorsa null.	Evet
container_id	String	Kodu çalıştırmak için kullanılan kapsayıcının kimliği.	Evet
Çıktılar	dizi	Günlükler veya görüntüler gibi kod yorumlayıcı tarafından oluşturulan çıkışlar. Kullanılabilir çıkış yoksa null olabilir.	Evet
durum	enum	Olası değerler: in_progress, completed, incomplete, interpreting, failed	Evet
type	enum	Olası değerler: code_interpreter_call	Evet

OpenAI.KıyaslamaFiltresi

Tanımlı bir karşılaştırma işlemi kullanarak belirtilen öznitelik anahtarını belirli bir değerle karşılaştırmak için kullanılan filtre.

İsim	Türü	Description	Gerekli	Varsayılan
key	String	Değerle karşılaştırmak için anahtar.	Evet
type	enum	Karşılaştırma işlecini belirtir: eq (eşittir), ne (eşit değil), gt (büyüktür), gte (büyüktür veya eşittir), lt (küçüktür), lte (küçük veya eşit). Olası değerler: eq, ne, gt, gte, , lt, lte	Evet
değer	dize veya sayı ya da boole değeri		Evet

OpenAI.CompoundFilter

and veya or kullanarak birden çok filtreyi birleştirin.

İsim	Türü	Description	Gerekli	Varsayılan
filters	dizi	Birleştirilecek filtreler dizisi. Öğeler ComparisonFilter veya CompoundFilter olabilir.	Evet
type	enum	İşlem türü: and veya or. Olası değerler: and, or	Evet

OpenAI.ComputerAction

OpenAI.ComputerAction için Ayrıştırıcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
click	OpenAI.ComputerActionClick
double_click	OpenAI.ComputerActionDoubleClick
drag	OpenAI.ComputerActionDrag
move	OpenAI.ComputerActionMove
screenshot	OpenAI.ComputerActionScreenshot
scroll	OpenAI.ComputerActionScroll
type	OpenAI.ComputerActionTypeKeys
wait	OpenAI.ComputerActionWait
keypress	OpenAI.ComputerActionKeyPress

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.ComputerActionType		Evet

OpenAI.ComputerActionClick

Tıklama eylemi.

İsim	Türü	Description	Gerekli	Varsayılan
düğme	enum	Tıklama sırasında hangi fare düğmesine basıldığını gösterir. left, right, wheel, back veya forward. Olası değerler: left, right, wheel, back, forward	Evet
type	enum	Olay türünü belirtir. Tıklama eylemi için bu özellik her zaman click olarak ayarlanır. Olası değerler: click	Evet
x	tamsayı	Tıklamanın gerçekleştiği x koordinatı.	Evet
y	tamsayı	Tıklamanın gerçekleştiği y koordinatı.	Evet

OpenAI.ComputerActionDoubleClick

Çift tıklama eylemi.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olay türünü belirtir. Çift tıklama eylemi için bu özellik her zaman double_click olarak ayarlanır. Olası değerler: double_click	Evet
x	tamsayı	Çift tıklamanın gerçekleştiği x koordinatı.	Evet
y	tamsayı	Çift tıklamanın gerçekleştiği y koordinatı.	Evet

OpenAI.ComputerActionDrag

Sürükleme eylemi.

İsim	Türü	Description	Gerekli	Varsayılan
path	dizi	Sürükleme eyleminin yolunu temsil eden koordinat dizisi. Koordinatlar bir dizi olarak görünür nesnelerin, örneğin <br>[<br> { x: 100, y: 200 },<br> { x: 200, y: 300 }<br>]<br>	Evet
type	enum	Olay türünü belirtir. Sürükleme eylemi için bu özellik her zaman drag olarak ayarlanır. Olası değerler: drag	Evet

OpenAI.ComputerActionKeyPress

Modelin gerçekleştirmek istediği tuş baskıları koleksiyonu.

İsim	Türü	Description	Gerekli	Varsayılan
keys	dizi	Modelin basılmasını istediği tuş kombinasyonu. Bu bir dize dizisi, her biri bir anahtarı temsil eder.	Evet
type	enum	Olay türünü belirtir. Bir tuş basıcı eylemi için bu özellik şu şekildedir: her zaman keypress olarak ayarlanır. Olası değerler: keypress	Evet

OpenAI.ComputerActionMove

Fare hareket ettirme eylemi.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olay türünü belirtir. Taşıma eylemi için bu özellik her zaman move olarak ayarlanır. Olası değerler: move	Evet
x	tamsayı	Taşınacak x koordinatı.	Evet
y	tamsayı	Taşınması gereken y koordinatı.	Evet

OpenAI.ComputerActionScreenshot

Ekran görüntüsü alma işlemi.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olay türünü belirtir. Ekran görüntüsü eylemi için bu özellik her zaman screenshot olarak ayarlanır. Olası değerler: screenshot	Evet

OpenAI.ComputerActionScroll

Kaydırma eylemi.

İsim	Türü	Description	Gerekli	Varsayılan
scroll_x	tamsayı	Yatay kaydırma uzaklığı.	Evet
scroll_y	tamsayı	Dikey kaydırma uzaklığı.	Evet
type	enum	Olay türünü belirtir. Kaydırma eylemi için bu özellik her zaman scroll olarak ayarlanır. Olası değerler: scroll	Evet
x	tamsayı	Kaydırmanın gerçekleştiği x koordinatı.	Evet
y	tamsayı	Kaydırmanın gerçekleştiği y koordinatı.	Evet

OpenAI.ComputerActionType

Mülkiyet	Değer
Türü	String
Değerler	screenshot click double_click scroll type wait keypress drag move

OpenAI.ComputerActionTypeKeys

Metin yazmak için bir eylem.

İsim	Türü	Description	Gerekli	Varsayılan
text	String	Yazılacak metin.	Evet
type	enum	Olay türünü belirtir. Tür eylemi için bu özellik her zaman type olarak ayarlanır. Olası değerler: type	Evet

OpenAI.ComputerActionWait

Bir bekleme eylemi.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olay türünü belirtir. Bir bekleme eylemi için bu özellik her zaman wait olarak ayarlanır. Olası değerler: wait	Evet

OpenAI.ComputerToolCallItemParam

Bilgisayar kullanım araçlarına bir araç komutu verme. Daha fazla bilgi için bilgisayar kullanım kılavuzuna bakın.

İsim	Türü	Description	Gerekli	Varsayılan
hareket	OpenAI.ComputerAction		Evet
call_id	String	Çıkış verisi ile araç çağrısına yanıt verirken kullanılan tanımlayıcı.	Evet
pending_safety_checks	dizi	Bilgisayar çağrısı için bekleyen güvenlik denetimleri.	Evet
type	enum	Olası değerler: computer_call	Evet

OpenAI.ComputerToolCallItemResource

Bilgisayar kullanım araçlarına bir araç komutu verme. Daha fazla bilgi için bilgisayar kullanım kılavuzuna bakın.

İsim	Türü	Description	Gerekli	Varsayılan
hareket	OpenAI.ComputerAction		Evet
call_id	String	Çıkış verisi ile araç çağrısına yanıt verirken kullanılan tanımlayıcı.	Evet
pending_safety_checks	dizi	Bilgisayar çağrısı için bekleyen güvenlik denetimleri.	Evet
durum	enum	Öğenin durumu. in_progress, completed, veya bunlardan biri incomplete. Öğeler API aracılığıyla döndürülürken doldurulur. Olası değerler: in_progress, completed, incomplete	Evet
type	enum	Olası değerler: computer_call	Evet

OpenAI.ComputerToolCallOutputItemOutput

OpenAI.ComputerToolCallOutputItemOutput için Ayırıcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
computer_screenshot	OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.ComputerToolCallOutputItemOutputType	Bilgisayar kullanım aracıyla kullanılan bir bilgisayar ekran görüntüsü.	Evet

OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot

İsim	Türü	Description	Gerekli	Varsayılan
dosya_kimlik	String		Hayı
image_url	String		Hayı
type	enum	Olası değerler: computer_screenshot	Evet

OpenAI.ComputerToolCallOutputItemOutputType

Bilgisayar kullanım aracıyla kullanılan bir bilgisayar ekran görüntüsü.

Mülkiyet	Değer
Açıklama	Bilgisayar kullanım aracıyla kullanılan bir bilgisayar ekran görüntüsü.
Türü	String
Değerler	computer_screenshot

OpenAI.ComputerToolCallOutputItemParam

Bir bilgisayar aracı çağrısının çıktısı.

İsim	Türü	Description	Gerekli	Varsayılan
acknowledged_safety_checks	dizi	API tarafından bildirilen ve kabul edilen güvenlik kontrolleri geliştirici.	Hayı
call_id	String	Çıktı üreten bilgisayar aracı çağrısının kimliği.	Evet
çıktı	OpenAI.ComputerToolCallOutputItemOutput		Evet
type	enum	Olası değerler: computer_call_output	Evet

OpenAI.ComputerToolCallOutputItemResource

Bir bilgisayar aracı çağrısının çıktısı.

İsim	Türü	Description	Gerekli	Varsayılan
acknowledged_safety_checks	dizi	API tarafından bildirilen ve kabul edilen güvenlik kontrolleri geliştirici.	Hayı
call_id	String	Çıktı üreten bilgisayar aracı çağrısının kimliği.	Evet
çıktı	OpenAI.ComputerToolCallOutputItemOutput		Evet
durum	enum	Öğenin durumu. in_progress, completed, veya bunlardan biri incomplete. Öğeler API aracılığıyla döndürülürken doldurulur. Olası değerler: in_progress, completed, incomplete	Evet
type	enum	Olası değerler: computer_call_output	Evet

OpenAI.ComputerToolCallSafetyCheck

Bilgisayar çağrısı için bekleyen bir güvenlik denetimi.

İsim	Türü	Description	Gerekli	Varsayılan
kod	String	Bekleyen güvenlik denetiminin türü.	Evet
kimlik	String	Bekleyen güvenlik denetiminin kimliği.	Evet
mesaj	String	Henüz gerçekleştirilmemiş güvenlik denetimi hakkındaki ayrıntılar.	Evet

OpenAI Bilgisayar Kullanımı Önizleme Aracı

Sanal bilgisayarı denetleyebilen bir araç.

İsim	Türü	Description	Gerekli	Varsayılan
görüntü yüksekliği	tamsayı	Bilgisayar ekranının yüksekliği.	Evet
görüntü genişliği	tamsayı	Bilgisayar ekranının genişliği.	Evet
environment	enum	Denetlenecek bilgisayar ortamının türü. Olası değerler: windows, mac, linux, ubuntu, browser	Evet
type	enum	Bilgisayar kullanım aracının türü. Her zaman computer_use_preview. Olası değerler: computer_use_preview	Evet

OpenAI.ConversationItemList

İsim	Türü	Description	Gerekli	Varsayılan
veriler	dizi		Evet
ilk_kimlik	String		Evet
daha_fazla	Boolean		Evet
son_kimlik	String		Evet
nesne	enum	Olası değerler: list	Evet

OpenAI.ConversationResource

İsim	Türü	Description	Gerekli	Varsayılan
oluşturulma_tarihi	tamsayı		Evet
kimlik	String	Konuşmanın benzersiz kimliği.	Evet
metadata	nesne	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Evet
nesne	enum	Her zaman 'konuşma' olan nesne türü. Olası değerler: conversation	Evet

OpenAI.Coordinate

X/y koordinat çifti, örneğin. { x: 100, y: 200 }

İsim	Türü	Description	Gerekli	Varsayılan
x	tamsayı	X koordinatı.	Evet
y	tamsayı	Y koordinatı.	Evet

OpenAI.CreateConversationRequest

Konuşma oluşturma

İsim	Türü	Description	Gerekli	Varsayılan
nesneler	dizi	Konuşma bağlamını içerecek ilk öğeler. Bir kerede en fazla 20 öğe ekleyebilirsiniz.	Hayı
metadata	nesne	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Hayı

OpenAI.CreateEvalCompletionsRunDataSource

Model örnekleme yapılandırmasını açıklayan CompletionsRunDataSource nesnesi.

İsim	Türü	Description	Gerekli	Varsayılan
input_mesajları	nesne		Hayı
└─ öğe_referansı	String		Hayı
└─ şablon	dizi		Hayı
└─ türü	enum	Olası değerler: item_reference	Hayı
model	String	Tamamlanmaları oluşturmak için kullanılacak modelin adı (örneğin, "o3-mini").	Hayı
Örnekleme_Parametreleri	OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams		Hayı
kaynak	nesne		Evet
└─ içerik	dizi	jsonl dosyasının içeriği.	Hayı
sonra_oluşturuldu	OpenAI.integer		Hayı
└─ önce oluşturulmuş	OpenAI.integer		Hayı
└─ kimlik	String	Dosyanın tanımlayıcısı.	Hayı
└─ sınırı	OpenAI.integer		Hayı
└─ meta veriler	OpenAI.Metadata	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Hayı
└─ modeli	String		Hayı
└─ türü	enum	Kaynak türü. Her zaman stored_completions. Olası değerler: stored_completions	Hayı
type	enum	Çalıştırma veri kaynağının türü. Her zaman completions. Olası değerler: completions	Evet

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference

İsim	Türü	Description	Gerekli	Varsayılan
item_reference	String		Evet
type	enum	Olası değerler: item_reference	Evet

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesTemplate

İsim	Türü	Description	Gerekli	Varsayılan
şablon	dizi		Evet
type	enum	Olası değerler: template	Evet

OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams

İsim	Türü	Description	Gerekli	Varsayılan
max_completion_tokens	OpenAI.integer		Hayı
akıl yürütme çabası	OpenAI.ReasoningEffort	Mantıp modelleri için mantık yürütme çabasını kısıtlar. Şu anda desteklenen değerler hiçbiri, en düşük, düşük, orta ve yüksek değerlerdir. 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 yok olur ve mantık yürütmez. gpt-5.1 için desteklenen mantık değerleri yok, düşük, orta ve yüksektir. Araç çağrıları gpt-5.1'deki tüm akıl yürütme değerleri için desteklenir. gpt-5.1'in önceki tüm modelleri varsayılan olarak orta düzeyde mantık yürütme eforu kullanır ve hiçbirini desteklemez. gpt-5-pro modeli varsayılan olarak yüksek mantık eforu kullanır (ve yalnızca destekler).	Hayı
yanıt formatı	nesne	Varsayılan yanıt biçimi. Metin yanıtları oluşturmak için kullanılır.	Hayı
└─ json_schema	nesne	Bir JSON Şeması da dahil olmak üzere Yapılandırılmış Çıkışlar yapılandırma seçenekleri.	Hayı
└─ açıklama	String	Model tarafından kullanılan yanıt biçiminin ne için olduğuna dair bir açıklama. Yanıt formatını nasıl belirleyeceğinizi öğrenin.	Hayı
└─ ad	String	Yanıt biçiminin adı. a-z, A-Z, 0-9 veya bunları içermelidir alt çizgi ve tirelerden oluşan, maksimum uzunluk 64 karakterdir.	Hayı
└─ şeması	nesne		Hayı
└─ katı	Boolean	Çıktı oluşturulurken sıkı şemaya bağlı kalınmasının etkinleştirilip etkinleştirilmeyileceği. True olarak ayarlanırsa, model her zaman tam olarak tanımlanan şemayı izler schema alanında. JSON Şemasının yalnızca bir alt kümesi desteklendiğinde strict, true'e eşittir. Daha fazla bilgi edinmek için Yapılandırılmış Çıkışlar'ı okuyun kılavuzuna bakın.	Hayı	Yanlış
└─ türü	enum	Tanımlanan yanıt biçiminin türü. Her zaman json_object. Olası değerler: json_object	Hayı
seed	nesne		Hayı
sıcaklık	nesne		Hayı
araçlar	dizi		Hayı
top_p	nesne		Hayı

OpenAI.CreateEvalCustomDataSourceConfig

Değerlendirme çalıştırmaları için kullanılan veri kaynağının şemasını tanımlayan customDataSourceConfig nesnesi. Bu şema, aşağıdaki verilerin şeklini tanımlamak için kullanılır:

• Test ölçütlerinizi tanımlamak için kullanılır ve
• Çalıştırma oluştururken hangi veriler gereklidir?

İsim	Türü	Description	Gerekli	Varsayılan
örnek_şema_dahil_et	Boolean	Değerlendirmenin örnek ad alanını doldurmanızı beklemesi gerekip gerekmediği (örneğin, veri kaynağınızdan yanıt oluşturarak)	Hayı
öğe şeması	nesne	Veri kaynağındaki her satır için json şeması.	Evet
type	enum	Veri kaynağının türü. Her zaman custom. Olası değerler: custom	Evet

OpenAI.CreateEvalJsonlRunDataSource

Değerlendirmeyle eşleşen JSONL dosyasını belirten bir JsonlRunDataSource nesnesi

İsim	Türü	Description	Gerekli	Varsayılan
kaynak	nesne		Evet
└─ içerik	dizi	jsonl dosyasının içeriği.	Hayı
└─ kimlik	String	Dosyanın tanımlayıcısı.	Hayı
└─ türü	enum	Jsonl kaynağının türü. Her zaman file_id. Olası değerler: file_id	Hayı
type	enum	Veri kaynağının türü. Her zaman jsonl. Olası değerler: jsonl	Evet

OpenAI.CreateEvalLogsDataSourceConfig

Günlükler sorgunuzun meta veri özelliğini belirten bir veri kaynağı yapılandırması. Bu genellikle usecase=chatbot, prompt-version=v2 gibi meta veridir vb.

İsim	Türü	Description	Gerekli	Varsayılan
metadata	nesne	Log veri kaynağı için meta veri filtreleri.	Hayı
type	enum	Veri kaynağının türü. Her zaman logs. Olası değerler: logs	Evet

OpenAI.CreateEvalResponsesRunDataSource

Model örnekleme yapılandırmasını açıklayan Bir ResponsesRunDataSource nesnesi.

İsim	Türü	Description	Gerekli	Varsayılan
input_mesajları	nesne		Hayı
└─ öğe_referansı	String		Hayı
└─ şablon	dizi		Hayı
└─ türü	enum	Olası değerler: item_reference	Hayı
model	String	Tamamlanmaları oluşturmak için kullanılacak modelin adı (örneğin, "o3-mini").	Hayı
Örnekleme_Parametreleri	OpenAI.CreateEvalResponsesRunDataSourceSamplingParams		Hayı
kaynak	nesne		Evet
└─ içerik	dizi	jsonl dosyasının içeriği.	Hayı
sonra_oluşturuldu	OpenAI.integer		Hayı
└─ önce oluşturulmuş	OpenAI.integer		Hayı
└─ kimlik	String	Dosyanın tanımlayıcısı.	Hayı
└─ talimatlar_arama	String		Hayı
└─ meta veriler	nesne		Hayı
└─ modeli	String		Hayı
└─ akıl yürütme çabası	OpenAI.ReasoningEffort	Mantıp modelleri için mantık yürütme çabasını kısıtlar. Şu anda desteklenen değerler hiçbiri, en düşük, düşük, orta ve yüksek değerlerdir. 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 yok olur ve mantık yürütmez. gpt-5.1 için desteklenen mantık değerleri yok, düşük, orta ve yüksektir. Araç çağrıları gpt-5.1'deki tüm akıl yürütme değerleri için desteklenir. gpt-5.1'in önceki tüm modelleri varsayılan olarak orta düzeyde mantık yürütme eforu kullanır ve hiçbirini desteklemez. gpt-5-pro modeli varsayılan olarak yüksek mantık eforu kullanır (ve yalnızca destekler).	Hayı
└─ sıcaklık	OpenAI.numeric		Hayı
└─ araçları	dizi		Hayı
└─ top_p	OpenAI.numeric		Hayı
└─ türü	enum	Çalıştırma veri kaynağının türü. Her zaman responses. Olası değerler: responses	Hayı
└─ kullanıcılar	dizi		Hayı
type	enum	Çalıştırma veri kaynağının türü. Her zaman responses. Olası değerler: responses	Evet

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference

İsim	Türü	Description	Gerekli	Varsayılan
item_reference	String		Evet
type	enum	Olası değerler: item_reference	Evet

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate

İsim	Türü	Description	Gerekli	Varsayılan
şablon	dizi		Evet
type	enum	Olası değerler: template	Evet

OpenAI.CreateEvalResponsesRunDataSourceSamplingParams

İsim	Türü	Description	Gerekli	Varsayılan
max_completion_tokens	OpenAI.integer		Hayı
akıl yürütme çabası	OpenAI.ReasoningEffort	Mantıp modelleri için mantık yürütme çabasını kısıtlar. Şu anda desteklenen değerler hiçbiri, en düşük, düşük, orta ve yüksek değerlerdir. 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 yok olur ve mantık yürütmez. gpt-5.1 için desteklenen mantık değerleri yok, düşük, orta ve yüksektir. Araç çağrıları gpt-5.1'deki tüm akıl yürütme değerleri için desteklenir. gpt-5.1'in önceki tüm modelleri varsayılan olarak orta düzeyde mantık yürütme eforu kullanır ve hiçbirini desteklemez. gpt-5-pro modeli varsayılan olarak yüksek mantık eforu kullanır (ve yalnızca destekler).	Hayı
seed	nesne		Hayı
sıcaklık	nesne		Hayı
text	OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText		Hayı
araçlar	dizi		Hayı
top_p	nesne		Hayı

OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText

İsim	Türü	Description	Gerekli	Varsayılan
format	OpenAI.TextResponseFormatConfiguration	Modelin çıkış yapması gereken biçimi belirten bir nesne. Yapılandırma { "type": "json_schema" } , Yapılandırılmış Çıkışları etkinleştirir, modelin sağlanan JSON şemanızla eşleşmesini sağlar. Daha fazla bilgi için Varsayılan biçim { "type": "text" } ek seçenek yoktur. *gpt-4o ve daha yeni modeller için önerilmez:** { "type": "json_object" } ayarı, eski JSON modunu etkinleştirir. modelin oluşturduğu iletinin geçerli JSON olduğundan emin olur. json_schema’ı kullanma Bu özelliği destekleyen modeller için tercih edilir.	Hayı

OpenAI.CreateEvalStoredCompletionsDataSourceConfig

LogsDataSourceConfig yerine kullanım dışı bırakıldı.

İsim	Türü	Description	Gerekli	Varsayılan
metadata	nesne	Depolanan tamamlamalar veri kaynağı için meta veri filtreleri.	Hayı
type	enum	Veri kaynağının türü. Her zaman stored_completions. Olası değerler: stored_completions	Evet

OpenAI.CreateFineTuningJobRequest

Geçerli modeller:

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

İsim	Türü	Description	Gerekli	Varsayılan
hiper parametreler	nesne	İnce ayar işi için kullanılan hiper parametreler. Bu değer artık yerine methodkullanım dışı bırakılmıştır ve parametresi altında method geçirilmelidir.	Hayı
└─ yığın boyutu	enum	Olası değerler: auto	Hayı
└─ öğrenme oranı çarpanı	enum	Olası değerler: auto	Hayı
└─ n_epochs	enum	Olası değerler: auto	Hayı
Entegrasyonlar	dizi	İnce ayar işiniz için etkinleştirecek tümleştirmelerin listesi.	Hayı
metadata	nesne	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Hayı
method	OpenAI.FineTuneMethod	İnce ayar için kullanılan yöntem.	Hayı
model	dize (aşağıdaki geçerli modellere bakın)	İnce ayar için modelin adı. Aşağıdakilerden birini seçebilirsiniz: desteklenen modeller.	Evet
seed	tamsayı	Tohum, işin yeniden üretilebilirliğini denetler. Aynı tohum ve iş parametrelerinin geçirilmesi aynı sonuçları vermelidir, ancak nadir durumlarda farklılık gösterebilir. Bir tohum belirtilmezse, sizin için bir tane oluşturulur.	Hayı
suffix	String	İnce ayarlı model adınıza eklenecek en fazla 64 karakterlik bir dize. Örneğin, suffix "özel model-adı" gibi bir model adı ft:gpt-4o-mini:openai:custom-model-name:7p4lURelüretir.	Hayı	Hiç kimse
eğitim_dosyası	String	Eğitim verilerini içeren karşıya yüklenen bir dosyanın kimliği. Veri kümeniz JSONL dosyası olarak biçimlendirilmelidir. Ayrıca, dosyanızı amacı fine-tuneile karşıya yüklemeniz gerekir. Dosyanın içeriği, modelin sohbet, tamamlanma biçimi veya ince ayar yönteminin tercih biçimini kullanıp kullanmama durumuna bağlı olarak farklılık göstermelidir. Daha fazla ayrıntı için ince ayar kılavuzuna bakın.	Evet
doğrulama_dosyası	String	Doğrulama verilerini içeren karşıya yüklenen bir dosyanın kimliği. Bu dosyayı sağlarsanız, veriler doğrulama oluşturmak için kullanılır ölçümlerini ince ayarlama sırasında düzenli aralıklarla gerçekleştirin. Bu ölçümler ince ayar sonuçları dosyası. Aynı veriler hem eğitme hem de doğrulama dosyalarında bulunmamalıdır. Veri kümeniz JSONL dosyası olarak biçimlendirilmelidir. Dosyanızı amacı fine-tuneile karşıya yüklemeniz gerekir. Daha fazla ayrıntı için ince ayar kılavuzuna bakın.	Hayı

OpenAI.CreateFineTuningJobRequestIntegration

OpenAI.CreateFineTuningJobRequestIntegration için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
wandb	OpenAI.CreateFineTuningJobRequestWandbIntegration

İsim	Türü	Description	Gerekli	Varsayılan
type	dize (aşağıdaki geçerli modellere bakın)		Evet

OpenAI.CreateFineTuningJobRequestWandbIntegration

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olası değerler: wandb	Evet
wandb	nesne		Evet
└─ varlık	String		Hayı
└─ ad	String		Hayı
└─ projesi	String		Hayı
└─ etiketleri	dizi		Hayı

OpenAI.CreateResponse

İsim	Türü	Description	Gerekli	Varsayılan
ajan	nesne		Hayı
└─ ad	String	Aracının adı.	Hayı
└─ türü	enum	Olası değerler: agent_reference	Hayı
└─ sürümü	String	Aracının sürüm tanımlayıcısı.	Hayı
arka plan	Boolean	Model yanıtının arka planda çalıştırılıp çalıştırılmayacağı. Arka plan yanıtları hakkında daha fazla bilgi edinin.	Hayı	Yanlış
konuşma	nesne		Hayı
└─ kimlik	String		Hayı
include	dizi	Model yanıtına eklenecek ek çıktı verilerini belirtin. Şu anda desteklenen değerler şunlardır: - code_interpreter_call.outputs: Python kod yürütme çıktılarını içerir kod yorumlayıcı aracı çağrı öğeleri. - computer_call_output.output.image_url: Bilgisayar çağrısı çıkışından görüntü URL'lerini ekleyin. - file_search_call.results: Arama sonuçlarını ekleyin: dosya arama aracı çağrısı. - message.input_image.image_url: Giriş iletisinden görüntü URL'lerini ekleyin. - message.output_text.logprobs: Yardımcı iletilerine logprobs ekleyin. - reasoning.encrypted_content: Mantığın şifrelenmiş bir sürümünü içerir akıl yürütme öğe çıkışlarındaki belirteçler. Bu, mantık öğelerinin kullanılmasına olanak sağlar. Yanıtlar API'sini durum bilgisi olmayan bir şekilde kullanırken çok aşamalı konuşmalar (örneğin when the store parameter is set to false, or when an organization is store parametresi false olarak ayarlandığında veya bir kuruluş olduğunda sıfır veri saklama programına kaydedilir).	Hayı
girdi	dize veya dizi		Hayı
instructions	String	Modelin bağlamı içine eklenen bir sistem (veya geliştirici) iletisi. previous_response_id ile birlikte kullanırken, önceki yönergelerden gelen talimatlar yanıt bir sonraki yanıta aktarılmaz. Bu, basit olmasını sağlar yeni yanıtlarda sistem (veya geliştirici) iletilerini değiştirmek için.	Hayı
max_output_tokens	tamsayı	Görünür çıkış belirteçleri ve muhakeme belirteçleri de dahil olmak üzere yanıt için oluşturulabilecek belirteç sayısı için üst sınır.	Hayı
max_tool_calls	tamsayı	Bir yanıtta işlenebilen yerleşik araçlara yapılan toplam çağrı sayısı üst sınırı. Bu maksimum sayı, tek tek araç başına değil, tüm yerleşik araç çağrıları için geçerlidir. Model tarafından bir aracı çağırmaya yönelik diğer girişimler yoksayılır.	Hayı
metadata	nesne	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Hayı
model	String	Bu yanıtın oluşturulması için kullanılacak model dağıtımı.	Hayı
paralel araç çağrıları	Boolean	Modelin araç çağrılarını paralel olarak çalıştırmasına izin verilip verilmeyeceği.	Hayı	Doğru
previous_response_id	String	Modele önceki yanıtın benzersiz kimliği. Bunu şunu yapmak için kullanın: çok aşamalı konuşmalar oluşturun. Hakkında daha fazla bilgi edinin konuşma durumunu yönetme.	Hayı
prompt	nesne	bir istem şablonuna ve değişkenlerine başvuru. Daha fazla bilgi edinin.	Hayı
└─ kimlik	String	Kullanılacak istem şablonunun benzersiz tanımlayıcısı.	Hayı
└─ değişkenler	OpenAI.ResponsePromptVariables	içindeki değişkenlerin yerine kullanılacak isteğe bağlı değer eşlemesi Istemi. Değiştirme değerleri dizeler veya başka bir değer olabilir Görüntüler veya dosyalar gibi yanıt giriş türleri.	Hayı
└─ sürümü	String	İstem şablonunun isteğe bağlı sürümü.	Hayı
reasoning	nesne	yalnızca o serisi modeller Mantık modelleri için yapılandırma seçenekleri.	Hayı
└─ çaba	OpenAI.ReasoningEffort	Mantıp modelleri için mantık yürütme çabasını kısıtlar. Şu anda desteklenen değerler hiçbiri, en düşük, düşük, orta ve yüksek değerlerdir. 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 yok olur ve mantık yürütmez. gpt-5.1 için desteklenen mantık değerleri yok, düşük, orta ve yüksektir. Araç çağrıları gpt-5.1'deki tüm akıl yürütme değerleri için desteklenir. gpt-5.1'in önceki tüm modelleri varsayılan olarak orta düzeyde mantık yürütme eforu kullanır ve hiçbirini desteklemez. gpt-5-pro modeli varsayılan olarak yüksek mantık eforu kullanır (ve yalnızca destekler).	Hayı
└─ özet oluştur	enum	Kullanım dışı: bunun yerine kullanın summary . Model tarafından gerçekleştirilen mantığın özeti. Bu, hata ayıklama ve modelin akıl yürütme işlemini anlamak için yararlı olabilir. auto, conciseveya detailed. Olası değerler: auto, concise, detailed	Hayı
└─ özeti	enum	Model tarafından gerçekleştirilen mantığın özeti. Bu, hata ayıklamak ve modelin akıl yürütme işlemini anlamak için kullanışlıdır. auto, conciseveya detailed. Olası değerler: auto, concise, detailed	Hayı
hizmet seviyesi	nesne	İsteğin sunulması için kullanılan işleme türünü belirtir. * 'otomatik' olarak ayarlanırsa istek hizmet katmanıyla işlenir proje ayarlarında yapılandırılır. Aksi yapılandırılmadığı sürece, Project 'default' kullanır. * 'varsayılan' olarak ayarlanırsa, istek standartla işlenir fiyatlandırma ve seçilen model için performans. * 'flex' olarak ayarlanırsa veya 'öncelik', ardından istek ilgili hizmetle işlenir Katmanı. Öncelik işleme hakkında daha fazla bilgi edinmek için satış ekibiyle iletişime geçin. * Ayarlanmadığında, varsayılan davranış 'auto' şeklindedir. service_tier Parametresi ayarlandığında, yanıt gövdesiservice_tier değeri, aslında isteğe hizmet etmek için kullanılan işleme modunu temel alır. Bu yanıt değeri parametresinde ayarlanan değerden farklı olabilir.	Hayı
store	Boolean	Oluşturulan model yanıtının daha sonra almak üzere belirli bir yolla (aracılığıyla) depolanıp depolanmayacağı API	Hayı	Doğru
veri akışı	Boolean	True olarak ayarlanırsa model yanıt verileri istemciye akışla aktarılır sunucu tarafından gönderilen olaylar kullanılarak oluşturulur. daha fazla bilgi için.	Hayı	Yanlış
structured_inputs	nesne	Yanıta, istem şablonu değiştirme veya araç bağımsız değişkeni bağlamalarına katılabilen yapılandırılmış girişler.	Hayı
sıcaklık	Numara	0 ile 2 arasında hangi örnekleme sıcaklığının kullanılacağı. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir. Genellikle bunu değiştirmenizi öneririz top_p ancak ikisini birden değiştirmemenizi öneririz.	Hayı	1
text	nesne	Modelden metin yanıtı için yapılandırma seçenekleri. Düz olabilir metin veya yapılandırılmış JSON verileri. Bkz . Metin girişleri ve çıkışları ve Yapılandırılmış Çıkışlar	Hayı
└─ biçimi	OpenAI.ResponseTextFormatConfiguration		Hayı
tool_choice	nesne	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 bir ileti oluşturması veya birini araması anlamına gelir. daha fazla araç. required modelin bir veya daha fazla araç çağırması gerektiği anlamına gelir.	Hayı
└─ türü	OpenAI.ToolChoiceObjectType	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.	Hayı
araçlar	dizi	Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Sen parametresini ayarlayarak tool_choice hangi aracın kullanılacağını belirtebilir. Modeli sağlayabileceğiniz iki araç kategorisi şunlardır: - Yerleşik araçlar: OpenAI tarafından sağlanan ve işlevselliği genişleten araçlar dosya arama gibi modelin özellikleri. - İşlev çağrıları (özel araçlar): Sizin tanımladığınız işlevler, Modelin kendi yazdığınız kodu çağırmasını sağlama.	Hayı
top_logprobs	tamsayı	Her biri ilişkili günlük olasılığına sahip her belirteç konumunda döndürülecek en olası belirteç sayısını belirten 0 ile 20 arasında bir tamsayı.	Hayı
top_p	Numara	Sıcaklıkla örneklemeye alternatif olarak çekirdek örneklemesi adı verilir, burada model, belirteçlerin sonuçlarını top_p olasılıkla değerlendirir kütle. Yani 0,1 yalnızca ilk 10% olasılık kütlesini oluşturan belirteçler anlamına gelir dikkate alınır. Genellikle bunu değiştirmenizi öneririz temperature ancak ikisini birden değiştirmemenizi öneririz.	Hayı	1
truncation	enum	Model yanıtı için kullanılacak kesme stratejisi. - auto: Bu yanıtın bağlamı ve önceki yanıtlar aşarsa modelin bağlam penceresi boyutu, modelin yanıtı bağlam penceresine uydurmak için giriş öğelerini düşürerek konuşmanın ortasında. - disabled (varsayılan): Model yanıtı bağlam penceresini aşarsa Bir model için boyut yanlış girilirse, istek 400 hatasıyla başarısız olur. Olası değerler: auto, disabled	Hayı
user	String	En iyi güvenlik uygulamaları hakkında daha fazla bilgi edinin.	Hayı

OpenAI.DeletedConversationResource

İsim	Türü	Description	Gerekli	Varsayılan
silindi	Boolean		Evet
kimlik	String		Evet
nesne	enum	Olası değerler: conversation.deleted	Evet

OpenAI.EasyInputMessage

İsim	Türü	Description	Gerekli	Varsayılan
içerik	dize veya dizi		Evet
role	String		Evet

OpenAI.Error

İsim	Türü	Description	Gerekli	Varsayılan
ek bilgi	nesne		Hayı
kod	String		Evet
hata ayıklama bilgisi	nesne		Hayı
details	dizi		Hayı
mesaj	String		Evet
param	String		Evet
type	String		Evet

OpenAI.EvalApiError

Değerlendirme API'sinden bir hata yanıtını temsil eden nesne.

İsim	Türü	Description	Gerekli	Varsayılan
kod	String	Hata kodu.	Evet
mesaj	String	Hata iletisi.	Evet

OpenAI.EvalGraderLabelModel

İsim	Türü	Description	Gerekli	Varsayılan
girdi	dizi		Evet
labels	dizi	Değerlendirmedeki her öğeye atanacak etiketler.	Evet
model	String	Değerlendirme için kullanılacak model. Yapılandırılmış çıktıları destekleme zorunluluğu vardır.	Evet
name	String	Değerlendiricinin adı.	Evet
geçen etiketler	dizi	Geçen sonucu belirten etiketler. Etiketlerin bir alt kümesi olmalıdır.	Evet
type	enum	Her zaman label_modelolan nesne türü. Olası değerler: label_model	Evet

OpenAI.EvalGraderPython

İsim	Türü	Description	Gerekli	Varsayılan
image_tag	String	Python betiği için kullanılacak görüntü etiketi.	Hayı
name	String	Değerlendiricinin adı.	Evet
eşik_geçiş	nesne		Hayı
kaynak	String	Python betiğinin kaynak kodu.	Evet
type	enum	Her zaman pythonolan nesne türü. Olası değerler: python	Evet

OpenAI.EvalGraderScoreModel

İsim	Türü	Description	Gerekli	Varsayılan
girdi	dizi	Giriş metni. Bu, şablon dizelerini içerebilir.	Evet
model	String	Değerlendirme için kullanılacak model.	Evet
name	String	Değerlendiricinin adı.	Evet
eşik_geçiş	nesne		Hayı
menzil	dizi	Puan aralığı. Varsayılan olarak [0, 1] değerini alır.	Hayı
Örnekleme_Parametreleri	nesne		Hayı
└─ max_completions_tokens	OpenAI.integer		Hayı
└─ akıl yürütme çabası	OpenAI.ReasoningEffort	Mantıp modelleri için mantık yürütme çabasını kısıtlar. Şu anda desteklenen değerler hiçbiri, en düşük, düşük, orta ve yüksek değerlerdir. 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 yok olur ve mantık yürütmez. gpt-5.1 için desteklenen mantık değerleri yok, düşük, orta ve yüksektir. Araç çağrıları gpt-5.1'deki tüm akıl yürütme değerleri için desteklenir. gpt-5.1'in önceki tüm modelleri varsayılan olarak orta düzeyde mantık yürütme eforu kullanır ve hiçbirini desteklemez. gpt-5-pro modeli varsayılan olarak yüksek mantık eforu kullanır (ve yalnızca destekler).	Hayı
└─ tohum	OpenAI.integer		Hayı
└─ sıcaklık	OpenAI.numeric		Hayı
└─ top_p	OpenAI.numeric		Hayı
type	enum	Her zaman score_modelolan nesne türü. Olası değerler: score_model	Evet

OpenAI.EvalGraderScoreModelSamplingParams

İsim	Türü	Description	Gerekli	Varsayılan
max_completions_tokens	nesne		Hayı
akıl yürütme çabası	OpenAI.ReasoningEffort	Mantıp modelleri için mantık yürütme çabasını kısıtlar. Şu anda desteklenen değerler hiçbiri, en düşük, düşük, orta ve yüksek değerlerdir. 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 yok olur ve mantık yürütmez. gpt-5.1 için desteklenen mantık değerleri yok, düşük, orta ve yüksektir. Araç çağrıları gpt-5.1'deki tüm akıl yürütme değerleri için desteklenir. gpt-5.1'in önceki tüm modelleri varsayılan olarak orta düzeyde mantık yürütme eforu kullanır ve hiçbirini desteklemez. gpt-5-pro modeli varsayılan olarak yüksek mantık eforu kullanır (ve yalnızca destekler).	Hayı
seed	nesne		Hayı
sıcaklık	nesne		Hayı
top_p	nesne		Hayı

OpenAI.EvalGraderStringCheck

İsim	Türü	Description	Gerekli	Varsayılan
girdi	String	Giriş metni. Bu, şablon dizelerini içerebilir.	Evet
name	String	Değerlendiricinin adı.	Evet
Operasyon	enum	Gerçekleştirilecek dize denetimi işlemi. eq, ne, like veya ilike. Olası değerler: eq, ne, like, ilike	Evet
referans	String	Başvuru metni. Bu, şablon dizelerini içerebilir.	Evet
type	enum	Her zaman string_checkolan nesne türü. Olası değerler: string_check	Evet

OpenAI.EvalGraderTextSimilarity

İsim	Türü	Description	Gerekli	Varsayılan
değerlendirme ölçütü	enum	Kullanılacak değerlendirme ölçümü. cosine, , fuzzy_match, bleu, gleu, meteor, rouge_1, , rouge_2, rouge_3, rouge_4, rouge_5, veya rouge_l. Olası değerler: cosine, fuzzy_match, bleu, , gleu, meteor, , rouge_1, rouge_2rouge_3, rouge_4rouge_5,rouge_l	Evet
girdi	String	Notlanan metin.	Evet
name	String	Değerlendiricinin adı.	Evet
eşik_geçiş	nesne		Evet
referans	String	Değerlendirmenin yapıldığı metin.	Evet
type	enum	Not verenin türü. Olası değerler: text_similarity	Evet

OpenAI.EvalItem

Modele, hiyerarşiyi izleyen yönergeyi belirten bir rol içeren bir ileti girişi. developer veya system rolüyle verilen yönergeler, user rolüyle verilen yönergelerden önceliklidir. assistant rolüne sahip iletilerin, önceki etkileşimlerde model tarafından oluşturulduğu varsayılır.

İsim	Türü	Description	Gerekli	Varsayılan
içerik	nesne	Modele metin girişi.	Evet
└─ veri	String	Base64 ile kodlanmış ses verileri.	Hayı
└─ ayrıntı	String		Hayı
└─ biçimi	enum	Ses verilerinin biçimi. Şu anda desteklenen biçimler şunlardır mp3 : ve wav. Olası değerler: mp3, wav	Hayı
└─ image_url (görsel URL'si)	String		Hayı
└─ metin	String		Hayı
└─ türü	enum	Giriş öğesinin türü. Her zaman input_audio. Olası değerler: input_audio	Hayı
role	enum	İleti girişinin rolü. user, assistant, system'den biri developer. Olası değerler: user, assistant, system, developer	Evet
type	enum	İleti girişinin türü. Her zaman message. Olası değerler: message	Hayı

OpenAI.EvalItemContentInputImage

İsim	Türü	Description	Gerekli	Varsayılan
detail	String		Hayı
image_url	String		Evet
type	enum	Olası değerler: input_image	Evet

OpenAI.EvalItemContentOutputText

İsim	Türü	Description	Gerekli	Varsayılan
text	String		Evet
type	enum	Olası değerler: output_text	Evet

OpenAI.EvalJsonlFileContentSource

İsim	Türü	Description	Gerekli	Varsayılan
içerik	dizi	jsonl dosyasının içeriği.	Evet
type	enum	Jsonl kaynağının türü. Her zaman file_content. Olası değerler: file_content	Evet

OpenAI.EvalJsonlFileContentSourceContent

İsim	Türü	Description	Gerekli	Varsayılan
öğe	nesne		Evet
örnek	nesne		Hayı

OpenAI.EvalJsonlFileIdSource

İsim	Türü	Description	Gerekli	Varsayılan
kimlik	String	Dosyanın tanımlayıcısı.	Evet
type	enum	Jsonl kaynağının türü. Her zaman file_id. Olası değerler: file_id	Evet

OpenAI.EvalResponsesSource

Çalıştırma veri kaynağı yapılandırmasını açıklayan bir EvalResponsesSource nesnesi.

İsim	Türü	Description	Gerekli	Varsayılan
oluşturulma_tarihi_sonrası	nesne		Hayı
önceden oluşturulmuş	nesne		Hayı
instructions_search	String		Hayı
metadata	nesne		Hayı
model	String		Hayı
akıl yürütme çabası	nesne	Mantıp modelleri için mantık yürütme çabasını kısıtlar. Şu anda desteklenen değerler hiçbiri, en düşük, düşük, orta ve yüksek değerlerdir. 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 yok olur ve mantık yürütmez. gpt-5.1 için desteklenen mantık değerleri yok, düşük, orta ve yüksektir. Araç çağrıları gpt-5.1'deki tüm akıl yürütme değerleri için desteklenir. gpt-5.1'in önceki tüm modelleri varsayılan olarak orta düzeyde mantık yürütme eforu kullanır ve hiçbirini desteklemez. gpt-5-pro modeli varsayılan olarak yüksek mantık eforu kullanır (ve yalnızca destekler).	Hayı
sıcaklık	nesne		Hayı
araçlar	dizi		Hayı
top_p	nesne		Hayı
type	enum	Çalıştırma veri kaynağının türü. Her zaman responses. Olası değerler: responses	Evet
users	dizi		Hayı

OpenAI.EvalRunOutputItemSample

İsim	Türü	Description	Gerekli	Varsayılan
hata	OpenAI.EvalApiError	Değerlendirme API'sinden bir hata yanıtını temsil eden nesne.	Evet
bitiş_nedeni	String		Evet
girdi	dizi		Evet
max_completion_tokens	OpenAI.integer		Evet
model	String		Evet
çıktı	dizi		Evet
seed	OpenAI.integer		Evet
sıcaklık	OpenAI.numeric		Evet
top_p	OpenAI.numeric		Evet
usage	OpenAI.EvalRunOutputItemSampleUsage		Evet

OpenAI.EvalRunOutputItemSampleInput

İsim	Türü	Description	Gerekli	Varsayılan
içerik	String		Evet
role	String		Evet

OpenAI.EvalRunOutputItemSampleOutput

İsim	Türü	Description	Gerekli	Varsayılan
içerik	String		Hayı
role	String		Hayı

OpenAI.EvalRunOutputItemSampleUsage

İsim	Türü	Description	Gerekli	Varsayılan
cached_tokens	OpenAI.integer		Evet
completion_tokens	OpenAI.integer		Evet
prompt_tokens	OpenAI.integer		Evet
total_tokens	OpenAI.integer		Evet

OpenAI.EvalRunPerModelUsage

İsim	Türü	Description	Gerekli	Varsayılan
cached_tokens	OpenAI.integer		Evet
completion_tokens	OpenAI.integer		Evet
invocation_count	OpenAI.integer		Evet
model_name	String		Evet
prompt_tokens	OpenAI.integer		Evet
total_tokens	OpenAI.integer		Evet

OpenAI.EvalRunPerTestingCriteriaResults

İsim	Türü	Description	Gerekli	Varsayılan
başarısız	OpenAI.integer		Evet
Geçirilen	OpenAI.integer		Evet
test kriterleri	String		Evet

OpenAI.EvalRunResultCounts

İsim	Türü	Description	Gerekli	Varsayılan
hata oluştu	OpenAI.integer		Evet
başarısız	OpenAI.integer		Evet
Geçirilen	OpenAI.integer		Evet
toplam	OpenAI.integer		Evet

OpenAI.EvalStoredCompletionsSource

Bir filtre kümesini açıklayan StoredCompletionsRunDataSource yapılandırması

İsim	Türü	Description	Gerekli	Varsayılan
oluşturulma_tarihi_sonrası	nesne		Hayı
önceden oluşturulmuş	nesne		Hayı
limit	nesne		Hayı
metadata	OpenAI.Metadata	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Hayı
model	String		Hayı
type	enum	Kaynak türü. Her zaman stored_completions. Olası değerler: stored_completions	Evet

OpenAI.FileSearchTool

Yüklenen dosyalardan ilgili içeriği arayan bir araç.

İsim	Türü	Description	Gerekli	Varsayılan
filters	nesne		Hayı
maks_sonuç_sayısı	tamsayı	Döndürülecek en fazla sonuç sayısı. Bu sayı 1 ile 50 (dahil) arasında olmalıdır.	Hayı
Sıralama_seçenekleri	nesne		Hayı
└─ sıralama yapıcı	enum	Dosya araması için kullanılacak dereceleyici. Olası değerler: auto, default-2024-11-15	Hayı
└─ skor_eşiği	Numara	Dosya araması için puan eşiği, 0 ile 1 arasında bir sayı. 1'e yakın sayılar yalnızca en uygun sonuçları döndürmeye çalışır, ancak daha az sonuç döndürebilir.	Hayı
type	enum	Dosya arama aracının türü. Her zaman file_search. Olası değerler: file_search	Evet
vector_store_ids	dizi	Aranacak vektör depolarının kimlikleri.	Evet

OpenAI.FileSearchToolCallItemParam

Dosya arama aracı çağrısının sonuçları. Daha fazla bilgi için dosya arama kılavuzuna bakın.

İsim	Türü	Description	Gerekli	Varsayılan
queries	dizi	Dosyaları aramak için kullanılan sorgular.	Evet
results	dizi	Dosya arama aracı çağrısının sonuçları.	Hayı
type	enum	Olası değerler: file_search_call	Evet

OpenAI.FileSearchToolCallItemResource

Dosya arama aracı çağrısının sonuçları. Daha fazla bilgi için dosya arama kılavuzuna bakın.

İsim	Türü	Description	Gerekli	Varsayılan
queries	dizi	Dosyaları aramak için kullanılan sorgular.	Evet
results	dizi	Dosya arama aracı çağrısının sonuçları.	Hayı
durum	enum	Dosya arama aracı çağrısının durumu. Bunlardan biri in_progress searching, incomplete veya failed, Olası değerler: in_progress, searching, completed, incomplete, failed	Evet
type	enum	Olası değerler: file_search_call	Evet

OpenAI.Filters

İsim	Türü	Description	Gerekli	Varsayılan
filters	dizi	Birleştirilecek filtreler dizisi. Öğeler ComparisonFilter veya CompoundFilter olabilir.	Evet
key	String	Değerle karşılaştırmak için anahtar.	Evet
type	enum	İşlem türü: and veya or. Olası değerler: and, or	Evet
değer	dize veya sayı ya da boole değeri	Öznitelik anahtarıyla karşılaştıracak değer; dize, sayı veya boole türlerini destekler.	Evet

OpenAI.FineTuneDPOHyperparameters

DPO hassas ayarlama işi için kullanılan hiper parametreler.

İsim	Türü	Description	Gerekli	Varsayılan
küme_boyutu	enum	Olası değerler: auto	Hayı
beta	enum	Olası değerler: auto	Hayı
öğrenme oranı çarpanı	enum	Olası değerler: auto	Hayı
n_devir	enum	Olası değerler: auto	Hayı

OpenAI.FineTuneDPOMethod

DPO ince ayarlama yöntemi için yapılandırma.

İsim	Türü	Description	Gerekli	Varsayılan
hiper parametreler	OpenAI.FineTuneDPOHyperparameters	DPO hassas ayarlama işi için kullanılan hiper parametreler.	Hayı

OpenAI.FineTuneMethod

İnce ayar için kullanılan yöntem.

İsim	Türü	Description	Gerekli	Varsayılan
dpo	OpenAI.FineTuneDPOMethod	DPO ince ayarlama yöntemi için yapılandırma.	Hayı
Takviye	OpenAI.FineTuneReinforcementMethod	Pekiştirici ince ayar yöntemi için yapılandırma.	Hayı
Denetimli	OpenAI.FineTuneSupervisedMethod	Denetimli ince ayar yöntemi için yapılandırma.	Hayı
type	enum	Yöntemin türü. supervised, dpoveya reinforcementşeklindedir. Olası değerler: supervised, dpo, reinforcement	Evet

OpenAI.FineTuneReinforcementHyperparameters

Pekiştirici ince ayarlama işi için kullanılan hiper parametreler.

İsim	Türü	Description	Gerekli	Varsayılan
küme_boyutu	enum	Olası değerler: auto	Hayı
compute_multiplier	enum	Olası değerler: auto	Hayı
eval_interval	enum	Olası değerler: auto	Hayı
eval_samples	enum	Olası değerler: auto	Hayı
öğrenme oranı çarpanı	enum	Olası değerler: auto	Hayı
n_devir	enum	Olası değerler: auto	Hayı
akıl yürütme çabası	enum	Akıl yürütme çabası düzeyi. Olası değerler: default, low, medium, high	Hayı

OpenAI.FineTuneReinforcementMethod

Pekiştirici ince ayar yöntemi için yapılandırma.

İsim	Türü	Description	Gerekli	Varsayılan
Greyder	nesne	Belirtilen işlemi kullanarak giriş ve başvuru arasında dize karşılaştırması gerçekleştiren bir StringCheckGrader nesnesi.	Evet
└─ çıktıyı_hesapla	String	Not veren sonuçlarına göre çıkışı hesaplamak için bir formül.	Hayı
└─ değerlendirme_metriği	enum	Kullanılacak değerlendirme ölçümü. cosine, , fuzzy_match, bleu, gleu, meteor, rouge_1, , rouge_2, rouge_3, rouge_4, rouge_5, veya rouge_l. Olası değerler: cosine, fuzzy_match, bleu, , gleu, meteor, , rouge_1, rouge_2rouge_3, rouge_4rouge_5,rouge_l	Hayı
└─ greyderler	OpenAI.GraderStringCheck veya OpenAI.GraderTextSimilarity veya OpenAI.GraderPython veya OpenAI.GraderScoreModel veya OpenAI.GraderLabelModel	Belirtilen işlemi kullanarak giriş ve başvuru arasında dize karşılaştırması gerçekleştiren bir StringCheckGrader nesnesi.	Hayı
└─ görsel_etiketi	String	Python betiği için kullanılacak görüntü etiketi.	Hayı
└─ giriş	dizi	Giriş metni. Bu, şablon dizelerini içerebilir.	Hayı
└─ modeli	String	Değerlendirme için kullanılacak model.	Hayı
└─ ad	String	Değerlendiricinin adı.	Hayı
└─ işlem	enum	Gerçekleştirilecek dize denetimi işlemi. eq, ne, like veya ilike. Olası değerler: eq, ne, like, ilike	Hayı
└─ aralığı	dizi	Puan aralığı. Varsayılan olarak [0, 1] değerini alır.	Hayı
└─ başvuru	String	Değerlendirmenin yapıldığı metin.	Hayı
└─ örnekleme_parametreleri	OpenAI.EvalGraderScoreModelSamplingParams	Modelin örnekleme parametreleri.	Hayı
└─ kaynak	String	Python betiğinin kaynak kodu.	Hayı
└─ türü	enum	Her zaman multiolan nesne türü. Olası değerler: multi	Hayı
hiper parametreler	OpenAI.FineTuneReinforcementHyperparameters	Pekiştirici ince ayarlama işi için kullanılan hiper parametreler.	Hayı

OpenAI.FineTuneSupervisedHyperparameters

İnce ayar işi için kullanılan hiper parametreler.

İsim	Türü	Description	Gerekli	Varsayılan
küme_boyutu	enum	Olası değerler: auto	Hayı
öğrenme oranı çarpanı	enum	Olası değerler: auto	Hayı
n_devir	enum	Olası değerler: auto	Hayı

OpenAI.FineTuneSupervisedMethod

Denetimli ince ayar yöntemi için yapılandırma.

İsim	Türü	Description	Gerekli	Varsayılan
hiper parametreler	OpenAI.FineTuneSupervisedHyperparameters	İnce ayar işi için kullanılan hiper parametreler.	Hayı

OpenAI.FineTuningIntegration

OpenAI.FineTuningIntegration için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
wandb	OpenAI.FineTuningIntegrationWandb

İsim	Türü	Description	Gerekli	Varsayılan
type	dize (aşağıdaki geçerli modellere bakın)		Evet

OpenAI.FineTuningIntegrationWandb

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	İnce ayar işi için etkinleştirilen tümleştirmenin türü Olası değerler: wandb	Evet
wandb	nesne	Weights ve Biases ile tümleştirme ayarları. Bu yük, ölçümler adresine gönderilir. İsteğe bağlı olarak, çalıştırmanız için açık bir görünen ad ayarlayabilir, etiketler ekleyebilirsiniz öğesini seçin ve çalıştırmanızla ilişkilendirilecek varsayılan varlığı (ekip, kullanıcı adı vb.) ayarlayın.	Evet
└─ varlık	String	Çalıştırma için kullanılacak varlık. Bu sayede WandB kullanıcısının ekibini veya kullanıcı adını ayarlayabilirsiniz. çalıştırmayla ilişkili gibi. Ayarlanmadıysa, kayıtlı WandB API anahtarı için varsayılan varlık kullanılır.	Hayı
└─ ad	String	Çalıştırma için ayarlanacağı görünen ad. Ayarlanmadıysa, ad olarak İş Kimliği'ni kullanacağız.	Hayı
└─ projesi	String	Yeni çalıştırmanın oluşturulacağı projenin adı.	Hayı
└─ etiketleri	dizi	Yeni oluşturulan çalıştırmaya eklenecek etiketlerin listesi. Bu etiketler doğrudan WandB'ye geçirilir. Some varsayılan etiketler OpenAI tarafından oluşturulur: "openai/finetune", "openai/{base-model}", "openai/{ftjob-abcdef}".	Hayı

OpenAI.FineTuningJob

nesnesi, fine_tuning.job API aracılığıyla oluşturulmuş bir ince ayar işini temsil eder.

İsim	Türü	Description	Gerekli	Varsayılan
oluşturulma_tarihi	tamsayı	hassas ayarlama işinin oluşturulduğu zaman için Unix zaman damgası (saniye olarak).	Evet
hata	nesne	olan failedişlerde ince ayar yapmak için bu, hatanın nedeni hakkında daha fazla bilgi içerir.	Evet
└─ kod	String	Makine tarafından okunabilir bir hata kodu.	Hayı
└─ ileti	String	İnsan tarafından okunabilir bir hata iletisi.	Hayı
└─ parametre	String	Genellikle veya training_filegeçersiz validation_file olan parametre. Hata parametreye özgü değilse bu alan null olur.	Hayı
tahmini_bitiş	tamsayı	unix zaman damgası (saniye cinsinden) için ince ayarlama işinin ne zaman bitmek üzere tahmin edilir. İnce ayar işi çalışmıyorsa değer null olur.	Hayı
fine_tuned_model	String	Oluşturulan ince ayarlı modelin adı. İnce ayar işi hala çalışıyorsa değer null olur.	Evet
tamamlandı	tamsayı	hassas ayarlama işinin ne zaman bittiğine ilişkin Unix zaman damgası (saniye olarak). İnce ayar işi hala çalışıyorsa değer null olur.	Evet
hiper parametreler	nesne	İnce ayar işi için kullanılan hiper parametreler. Bu değer yalnızca işler çalıştırılırken supervised döndürülür.	Evet
└─ yığın boyutu	enum	Olası değerler: auto	Hayı
└─ öğrenme oranı çarpanı	enum	Olası değerler: auto	Hayı
└─ n_epochs	enum	Olası değerler: auto	Hayı
kimlik	String	API uç noktalarına başvurulabilen nesne tanımlayıcısı.	Evet
Entegrasyonlar	dizi	Bu ince ayar işi için etkinleştirecek tümleştirmelerin listesi.	Hayı
metadata	nesne	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Evet
method	OpenAI.FineTuneMethod	İnce ayar için kullanılan yöntem.	Hayı
model	String	İnce ayar yapılan temel model.	Evet
nesne	enum	Her zaman "fine_tuning.job" olan nesne türü. Olası değerler: fine_tuning.job	Evet
organization_id	String	İnce ayar işinin sahibi olan kuruluş.	Evet
sonuç_dosyaları	dizi	İnce ayar işi için derlenmiş sonuç dosyası kimlikleri. Sonuçları Dosyalar API'siyle alabilirsiniz.	Evet
seed	tamsayı	İnce ayar işi için kullanılan tohum.	Evet
durum	enum	, veya validating_filesolabilirqueuedrunningsucceededfailed, ince ayarlama işinin cancelledgeçerli durumu. Olası değerler: validating_files, queued, running, succeeded, , failed, cancelled	Evet
eğitilmiş_jetonlar	tamsayı	Bu ince ayar işi tarafından işlenen faturalanabilir belirteçlerin toplam sayısı. İnce ayar işi hala çalışıyorsa değer null olur.	Evet
eğitim_dosyası	String	Eğitim için kullanılan dosya kimliği. Eğitim verilerini Dosyalar API'siyle alabilirsiniz.	Evet
user_provided_suffix	String	İş oluşturma isteğinde belirtildiği gibi işe uygulanan açıklayıcı sonek.	Hayı
doğrulama_dosyası	String	Doğrulama için kullanılan dosya kimliği. Doğrulama sonuçlarını Dosyalar API'siyle alabilirsiniz.	Evet

OpenAI.FineTuningJobCheckpoint

fine_tuning.job.checkpoint nesnesi, kullanıma hazır bir ince ayar işi için model denetim noktasını temsil eder.

İsim	Türü	Description	Gerekli	Varsayılan
oluşturulma_tarihi	tamsayı	Denetim noktasının oluşturulduğu zaman için Unix zaman damgası (saniye olarak).	Evet
ince_ayarlı_model_kontrol_noktası	String	Oluşturulan hassas denetim noktası modelinin adı.	Evet
ince_ayarlama_iş_id	String	Bu denetim noktasının oluşturulduğu ince ayar işinin adı.	Evet
kimlik	String	API uç noktalarında başvurulabilen denetim noktası tanımlayıcısı.	Evet
metrics	nesne	İnce ayar işi sırasında adım numarasındaki ölçümler.	Evet
tam doğrulama kaybı (full_valid_loss)	Numara		Hayı
└─ tam_geçerli_ortalama_token_doğruluğu	Numara		Hayı
└─ adım	Numara		Hayı
└─ eğitim kaybı	Numara		Hayı
└─ eğitim_ortalama_token_dogrulugu	Numara		Hayı
└─ doğrulama_kaybı	Numara		Hayı
└─ geçerli_ortalama_öğe_doğruluğu	Numara		Hayı
nesne	enum	Her zaman "fine_tuning.job.checkpoint" olan nesne türü. Olası değerler: fine_tuning.job.checkpoint	Evet
adım_numarası	tamsayı	Denetim noktasının oluşturulduğu adım numarası.	Evet

OpenAI.FineTuningJobEvent

İş olayı nesnesine ince ayar

İsim	Türü	Description	Gerekli	Varsayılan
oluşturulma_tarihi	tamsayı	hassas ayarlama işinin oluşturulduğu zaman için Unix zaman damgası (saniye olarak).	Evet
veriler		Olayla ilişkili veriler.	Hayı
kimlik	String	Nesne tanımlayıcısı.	Evet
seviye	enum	Olayın günlük düzeyi. Olası değerler: info, warn, error	Evet
mesaj	String	Olayın iletisi.	Evet
nesne	enum	Her zaman "fine_tuning.job.event" olan nesne türü. Olası değerler: fine_tuning.job.event	Evet
type	enum	Olayın türü. Olası değerler: message, metrics	Hayı

OpenAI.FunctionObject

İsim	Türü	Description	Gerekli	Varsayılan
açıklama	String	İşlevin ne zaman ve nasıl çağrıldığını seçmek için model tarafından kullanılan işlevin ne yaptığının açıklaması.	Hayı
name	String	Çağrılacak işlevin adı. En fazla uzunluğu 64 olan a-z, A-Z, 0-9 veya alt çizgi ve kısa çizgi içermelidir.	Evet
parameters		İşlevlerin kabullediği, JSON Şeması nesnesi olarak tanımlanan parametreler. Örnekler için kılavuza ve biçimle ilgili belgeler için JSON Şeması başvurusuna bakın. Atlama parameters , boş parametre listesi olan bir işlevi tanımlar.	Hayı
Sıkı	Boolean	İşlev çağrısı oluşturulurken sıkı şemaya bağlı kalınmasının etkinleştirilip etkinleştirilmeyileceği. True olarak ayarlanırsa, model alanda tanımlanan şemayı parameters tam olarak izler. strict trueolduğunda yalnızca bir JSON Şeması alt kümesi desteklenir. Yapılandırılmış Çıkışlar hakkında daha fazla bilgi edinmek için	Hayı	Yanlış

OpenAI.FunctionTool

Modelin çağırmayı seçebileceği kendi kodunuzda bir işlev tanımlar.

İsim	Türü	Description	Gerekli	Varsayılan
açıklama	String	İşlevin açıklaması. İşlevin çağrılıp çağrılmayacağını belirlemek için model tarafından kullanılır.	Hayı
name	String	Çağrılacak işlevin adı.	Evet
parameters		İşlevin parametrelerini açıklayan bir JSON şema nesnesi.	Evet
Sıkı	Boolean	Katı parametre doğrulamasının zorunlu kılınıp uygulanmayacağı. Varsayılan true.	Evet
type	enum	İşlev aracının türü. Her zaman function. Olası değerler: function	Evet

OpenAI.FunctionToolCallItemParam

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.

İsim	Türü	Description	Gerekli	Varsayılan
arguments	String	İşleve geçirecek bağımsız değişkenlerin JSON dizesi.	Evet
call_id	String	Model tarafından oluşturulan işlev aracı çağrısının benzersiz kimliği.	Evet
name	String	Çalıştırılacak işlevin adı.	Evet
type	enum	Olası değerler: function_call	Evet

OpenAI.FunctionToolCallItemResource

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.

İsim	Türü	Description	Gerekli	Varsayılan
arguments	String	İşleve geçirecek bağımsız değişkenlerin JSON dizesi.	Evet
call_id	String	Model tarafından oluşturulan işlev aracı çağrısının benzersiz kimliği.	Evet
name	String	Çalıştırılacak işlevin adı.	Evet
durum	enum	Öğenin durumu. in_progress, completed, veya bunlardan biri incomplete. Öğeler API aracılığıyla döndürülürken doldurulur. Olası değerler: in_progress, completed, incomplete	Evet
type	enum	Olası değerler: function_call	Evet

OpenAI.FunctionToolCallOutputItemParam

İşlev aracı çağrısının çıktısı.

İsim	Türü	Description	Gerekli	Varsayılan
call_id	String	Model tarafından oluşturulan işlev aracı çağrısının benzersiz kimliği.	Evet
çıktı	String	İşlev aracı çağrısının çıkışının JSON dizesi.	Evet
type	enum	Olası değerler: function_call_output	Evet

OpenAI.FunctionToolCallOutputItemResource

İşlev aracı çağrısının çıktısı.

İsim	Türü	Description	Gerekli	Varsayılan
call_id	String	Model tarafından oluşturulan işlev aracı çağrısının benzersiz kimliği.	Evet
çıktı	String	İşlev aracı çağrısının çıkışının JSON dizesi.	Evet
durum	enum	Öğenin durumu. in_progress, completed, veya bunlardan biri incomplete. Öğeler API aracılığıyla döndürülürken doldurulur. Olası değerler: in_progress, completed, incomplete	Evet
type	enum	Olası değerler: function_call_output	Evet

OpenAI.GraderLabelModel

Değerlendirmedeki her öğeye etiket atamak için model kullanan bir LabelModelGrader nesnesi.

İsim	Türü	Description	Gerekli	Varsayılan
girdi	dizi		Evet
labels	dizi	Değerlendirmedeki her öğeye atanacak etiketler.	Evet
model	String	Değerlendirme için kullanılacak model. Yapılandırılmış çıktıları destekleme zorunluluğu vardır.	Evet
name	String	Değerlendiricinin adı.	Evet
geçen etiketler	dizi	Geçen sonucu belirten etiketler. Etiketlerin bir alt kümesi olmalıdır.	Evet
type	enum	Her zaman label_modelolan nesne türü. Olası değerler: label_model	Evet

OpenAI.GraderMulti

MultiGrader nesnesi, tek bir puan oluşturmak için birden çok not verenin çıkışını birleştirir.

İsim	Türü	Description	Gerekli	Varsayılan
calculate_output	String	Not veren sonuçlarına göre çıkışı hesaplamak için bir formül.	Evet
Greyder	nesne	Belirtilen işlemi kullanarak giriş ve başvuru arasında dize karşılaştırması gerçekleştiren bir StringCheckGrader nesnesi.	Evet
└─ değerlendirme_metriği	enum	Kullanılacak değerlendirme ölçümü. cosine, , fuzzy_match, bleu, gleu, meteor, rouge_1, , rouge_2, rouge_3, rouge_4, rouge_5, veya rouge_l. Olası değerler: cosine, fuzzy_match, bleu, , gleu, meteor, , rouge_1, rouge_2rouge_3, rouge_4rouge_5,rouge_l	Hayı
└─ görsel_etiketi	String	Python betiği için kullanılacak görüntü etiketi.	Hayı
└─ giriş	dizi		Hayı
└─ etiketler	dizi	Değerlendirmedeki her öğeye atanacak etiketler.	Hayı
└─ modeli	String	Değerlendirme için kullanılacak model. Yapılandırılmış çıktıları destekleme zorunluluğu vardır.	Hayı
└─ ad	String	Değerlendiricinin adı.	Hayı
└─ işlem	enum	Gerçekleştirilecek dize denetimi işlemi. eq, ne, like veya ilike. Olası değerler: eq, ne, like, ilike	Hayı
└─ passing_labels	dizi	Geçen sonucu belirten etiketler. Etiketlerin bir alt kümesi olmalıdır.	Hayı
└─ aralığı	dizi	Puan aralığı. Varsayılan olarak [0, 1] değerini alır.	Hayı
└─ başvuru	String	Değerlendirmenin yapıldığı metin.	Hayı
└─ örnekleme_parametreleri	OpenAI.EvalGraderScoreModelSamplingParams	Modelin örnekleme parametreleri.	Hayı
└─ kaynak	String	Python betiğinin kaynak kodu.	Hayı
└─ türü	enum	Her zaman label_modelolan nesne türü. Olası değerler: label_model	Hayı
name	String	Değerlendiricinin adı.	Evet
type	enum	Her zaman multiolan nesne türü. Olası değerler: multi	Evet

OpenAI.GraderPython

Girişte python betiği çalıştıran bir PythonGrader nesnesi.

İsim	Türü	Description	Gerekli	Varsayılan
image_tag	String	Python betiği için kullanılacak görüntü etiketi.	Hayı
name	String	Değerlendiricinin adı.	Evet
kaynak	String	Python betiğinin kaynak kodu.	Evet
type	enum	Her zaman pythonolan nesne türü. Olası değerler: python	Evet

OpenAI.GraderScoreModel

Girişe puan atamak için model kullanan scoreModelGrader nesnesi.

İsim	Türü	Description	Gerekli	Varsayılan
girdi	dizi	Giriş metni. Bu, şablon dizelerini içerebilir.	Evet
model	String	Değerlendirme için kullanılacak model.	Evet
name	String	Değerlendiricinin adı.	Evet
menzil	dizi	Puan aralığı. Varsayılan olarak [0, 1] değerini alır.	Hayı
Örnekleme_Parametreleri	nesne		Hayı
└─ max_completions_tokens	OpenAI.integer		Hayı
└─ akıl yürütme çabası	OpenAI.ReasoningEffort	Mantıp modelleri için mantık yürütme çabasını kısıtlar. Şu anda desteklenen değerler hiçbiri, en düşük, düşük, orta ve yüksek değerlerdir. 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 yok olur ve mantık yürütmez. gpt-5.1 için desteklenen mantık değerleri yok, düşük, orta ve yüksektir. Araç çağrıları gpt-5.1'deki tüm akıl yürütme değerleri için desteklenir. gpt-5.1'in önceki tüm modelleri varsayılan olarak orta düzeyde mantık yürütme eforu kullanır ve hiçbirini desteklemez. gpt-5-pro modeli varsayılan olarak yüksek mantık eforu kullanır (ve yalnızca destekler).	Hayı
└─ tohum	OpenAI.integer		Hayı
└─ sıcaklık	OpenAI.numeric		Hayı
└─ top_p	OpenAI.numeric		Hayı
type	enum	Her zaman score_modelolan nesne türü. Olası değerler: score_model	Evet

OpenAI.GraderStringCheck

Belirtilen işlemi kullanarak giriş ve başvuru arasında dize karşılaştırması gerçekleştiren bir StringCheckGrader nesnesi.

İsim	Türü	Description	Gerekli	Varsayılan
girdi	String	Giriş metni. Bu, şablon dizelerini içerebilir.	Evet
name	String	Değerlendiricinin adı.	Evet
Operasyon	enum	Gerçekleştirilecek dize denetimi işlemi. eq, ne, like veya ilike. Olası değerler: eq, ne, like, ilike	Evet
referans	String	Başvuru metni. Bu, şablon dizelerini içerebilir.	Evet
type	enum	Her zaman string_checkolan nesne türü. Olası değerler: string_check	Evet

OpenAI.GraderTextSimilarity

Metinleri benzerlik ölçümlerine göre notlayan textSimilarityGrader nesnesi.

İsim	Türü	Description	Gerekli	Varsayılan
değerlendirme ölçütü	enum	Kullanılacak değerlendirme ölçümü. cosine, , fuzzy_match, bleu, gleu, meteor, rouge_1, , rouge_2, rouge_3, rouge_4, rouge_5, veya rouge_l. Olası değerler: cosine, fuzzy_match, bleu, , gleu, meteor, , rouge_1, rouge_2rouge_3, rouge_4rouge_5,rouge_l	Evet
girdi	String	Notlanan metin.	Evet
name	String	Değerlendiricinin adı.	Evet
referans	String	Değerlendirmenin yapıldığı metin.	Evet
type	enum	Not verenin türü. Olası değerler: text_similarity	Evet

OpenAI.ImageGenTool

gibi gpt-image-1bir model kullanarak görüntü oluşturan bir araç.

İsim	Türü	Description	Gerekli	Varsayılan
arka plan	enum	Oluşturulan görüntünün arka plan türü. Bunlardan biri transparent opaqueveya auto. Varsayılan: auto. Olası değerler: transparent, opaque, auto	Hayı
girdi_görüntü_maskesi	nesne	Boyanma için isteğe bağlı maske. image_url içerir (dize, isteğe bağlı) ve file_id (dize, isteğe bağlı).	Hayı
└─ dosya_kimliği	String	Maske görüntüsünün dosya kimliği.	Hayı
└─ image_url (görsel URL'si)	String	Base64 ile kodlanmış maske görüntüsü.	Hayı
model	enum	Kullanılacak görüntü oluşturma modeli. Varsayılan: gpt-image-1. Olası değerler: gpt-image-1	Hayı
moderation	enum	Oluşturulan görüntü için denetim düzeyi. Varsayılan: auto. Olası değerler: auto, low	Hayı
çıktı sıkıştırma	tamsayı	Çıkış görüntüsü için sıkıştırma düzeyi. Varsayılan: 100.	Hayı	100
çıkış formatı	enum	Oluşturulan görüntünün çıkış biçimi. png, webp, veya bunlardan biri jpeg. Varsayılan: png. Olası değerler: png, webp, jpeg	Hayı
kısmi_görüntüler	tamsayı	Akış modunda 0 'dan (varsayılan değer) 3'e kadar oluşturulacak kısmi görüntü sayısı.	Hayı	0
nitelik	enum	Oluşturulan görüntünün kalitesi. low, , medium, high, veya auto. Varsayılan: auto. Olası değerler: low, medium, high, auto	Hayı
boyut	enum	Oluşturulan görüntünün boyutu. , , 1024x1024' lerden 1024x1536biri 1536x1024veya auto. Varsayılan: auto. Olası değerler: 1024x1024, 1024x1536, 1536x1024, auto	Hayı
type	enum	Görüntü oluşturma aracının türü. Her zaman image_generation. Olası değerler: image_generation	Evet

OpenAI.ImageGenToolCallItemParam

Model tarafından yapılan bir görüntü oluşturma isteği.

İsim	Türü	Description	Gerekli	Varsayılan
sonuç	String	Oluşturulan görüntü base64'te kodlanmış.	Evet
type	enum	Olası değerler: image_generation_call	Evet

OpenAI.ImageGenToolCallItemResource

Model tarafından yapılan bir görüntü oluşturma isteği.

İsim	Türü	Description	Gerekli	Varsayılan
sonuç	String	Oluşturulan görüntü base64'te kodlanmış.	Evet
durum	enum	Olası değerler: in_progress, completed, generating, failed	Evet
type	enum	Olası değerler: image_generation_call	Evet

OpenAI.Includable

Model yanıtına eklenecek ek çıktı verilerini belirtin. Şu anda desteklenen değerler şunlardır:

• code_interpreter_call.outputs: Kod yorumlayıcı aracı çağrı öğelerinde python kod yürütme çıktılarını içerir.
• computer_call_output.output.image_url: Bilgisayar çağrısı çıkışından görüntü URL'lerini ekleyin.
• file_search_call.results: Dosya arama aracı çağrısının arama sonuçlarını ekleyin.
• message.input_image.image_url: Giriş iletisinden görüntü URL'lerini ekleyin.
• message.output_text.logprobs: Yardımcı iletilerine logprobs ekleyin.
• reasoning.encrypted_content: Akıl yürütme öğesi çıkışlarında akıl yürütme belirteçlerinin şifrelenmiş bir sürümünü içerir. Bu, Yanıtlar API'sini durum bilgisi olmadan kullanırken (örneğin, store parametresi false olarak ayarlandığında veya bir kuruluş sıfır veri saklama programına kaydedildiğinde) akıl yürütme öğelerinin çok aşamalı konuşmalarda kullanılmasını sağlar.

Mülkiyet	Değer
Açıklama	Model yanıtına eklenecek ek çıktı verilerini belirtin. Şu anda desteklenen değerler şunlardır: - code_interpreter_call.outputs: Python kod yürütme çıktılarını içerir kod yorumlayıcı aracı çağrı öğeleri. - computer_call_output.output.image_url: Bilgisayar çağrısı çıkışından görüntü URL'lerini ekleyin. - file_search_call.results: Arama sonuçlarını ekleyin: dosya arama aracı çağrısı. - message.input_image.image_url: Giriş iletisinden görüntü URL'lerini ekleyin. - message.output_text.logprobs: Yardımcı iletilerine logprobs ekleyin. - reasoning.encrypted_content: Mantığın şifrelenmiş bir sürümünü içerir akıl yürütme öğe çıkışlarındaki belirteçler. Bu, mantık öğelerinin kullanılmasına olanak sağlar. Yanıtlar API'sini durum bilgisi olmayan bir şekilde kullanırken çok aşamalı konuşmalar (örneğin when the store parameter is set to false, or when an organization is store parametresi false olarak ayarlandığında veya bir kuruluş olduğunda sıfır veri saklama programına kaydedilir).
Türü	String
Değerler	code_interpreter_call.outputs computer_call_output.output.image_url file_search_call.results message.input_image.image_url message.output_text.logprobs reasoning.encrypted_content web_search_call.results web_search_call.action.sources memory_search_call.results

OpenAI.ItemContent

OpenAI.ItemContent için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
input_audio	OpenAI.ItemContentInputAudio
output_audio	OpenAI.ItemContentOutputAudio
refusal	OpenAI.ItemContentRefusal
input_text	OpenAI.ItemContentInputText
input_image	OpenAI.ItemContentInputImage
input_file	OpenAI.ItemContentInputFile
output_text	OpenAI.ItemContentOutputText

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.ItemContentType	Çok modlu giriş ve çıkış içeriği.	Evet

OpenAI.ItemContentInputAudio

Modele ses girişi.

İsim	Türü	Description	Gerekli	Varsayılan
veriler	String	Base64 ile kodlanmış ses verileri.	Evet
format	enum	Ses verilerinin biçimi. Şu anda desteklenen biçimler şunlardır mp3 : ve wav. Olası değerler: mp3, wav	Evet
type	enum	Giriş öğesinin türü. Her zaman input_audio. Olası değerler: input_audio	Evet

OpenAI.ItemContentInputFile

Modele bir dosya girişi.

İsim	Türü	Description	Gerekli	Varsayılan
file_data	String	Modele gönderilecek dosyanın içeriği.	Hayı
dosya_kimlik	String	Modele gönderilecek dosyanın kimliği.	Hayı
filename	String	Modele gönderilecek dosyanın adı.	Hayı
type	enum	Giriş öğesinin türü. Her zaman input_file. Olası değerler: input_file	Evet

OpenAI.ItemContentInputImage

Modele bir görüntü girişi. Görüntü girişleri hakkında bilgi edinin.

İsim	Türü	Description	Gerekli	Varsayılan
detail	enum	Modele gönderilecek görüntünün ayrıntı düzeyi. high, lowveya auto. Varsayılan olarak auto değerini alır. Olası değerler: low, high, auto	Hayı
dosya_kimlik	String	Modele gönderilecek dosyanın kimliği.	Hayı
image_url	String	Modele gönderilecek görüntünün URL'si. Tam bir URL veya veri URL'sinde base64 kodlanmış görüntü.	Hayı
type	enum	Giriş öğesinin türü. Her zaman input_image. Olası değerler: input_image	Evet

OpenAI.ItemContentInputText

Modele metin girişi.

İsim	Türü	Description	Gerekli	Varsayılan
text	String	Modele metin girişi.	Evet
type	enum	Giriş öğesinin türü. Her zaman input_text. Olası değerler: input_text	Evet

OpenAI.ItemContentOutputAudio

Modelden gelen bir ses çıkışı.

İsim	Türü	Description	Gerekli	Varsayılan
veriler	String	Modelden alınan Base64 ile kodlanmış ses verileri.	Evet
transcript	String	Modeldeki ses verilerinin dökümü.	Evet
type	enum	Çıkış sesinin türü. Her zaman output_audio. Olası değerler: output_audio	Evet

OpenAI.ItemContentOutputText

Modelden bir metin çıktısı.

İsim	Türü	Description	Gerekli	Varsayılan
Açıklamalar	dizi	Metin çıkışının ek açıklamaları.	Evet
logprobs	dizi		Hayı
text	String	Modelden metin çıkışı.	Evet
type	enum	Çıkış metninin türü. Her zaman output_text. Olası değerler: output_text	Evet

OpenAI.ItemContentRefusal

Model tarafından reddedilme.

İsim	Türü	Description	Gerekli	Varsayılan
Ret	String	Modelden gelen reddetme açıklaması.	Evet
type	enum	Reddetmenin türü. Her zaman refusal. Olası değerler: refusal	Evet

OpenAI.ItemContentType

Çok modlu giriş ve çıkış içeriği.

Mülkiyet	Değer
Açıklama	Çok modlu giriş ve çıkış içeriği.
Türü	String
Değerler	input_text input_audio input_image input_file output_text output_audio refusal

OpenAI.ItemParam

Yanıt oluşturmak için kullanılan içerik öğesi.

OpenAI.ItemParam için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
message	OpenAI.ResponsesMessageItemParam
function_call_output	OpenAI.FunctionToolCallOutputItemParam
file_search_call	OpenAI.FileSearchToolCallItemParam
computer_call	OpenAI.ComputerToolCallItemParam
computer_call_output	OpenAI.ComputerToolCallOutputItemParam
web_search_call	OpenAI.WebSearchToolCallItemParam
function_call	OpenAI.FunctionToolCallItemParam
reasoning	OpenAI.ReasoningItemParam
item_reference	OpenAI.ItemReferenceItemParam
image_generation_call	OpenAI.ImageGenToolCallItemParam
code_interpreter_call	OpenAI.CodeInterpreterToolCallItemParam
local_shell_call	OpenAI.LocalShellToolCallItemParam
local_shell_call_output	OpenAI.LocalShellToolCallOutputItemParam
mcp_list_tools	OpenAI.MCPListToolsItemParam
mcp_approval_request	OpenAI.MCPApprovalRequestItemParam
mcp_approval_response	OpenAI.MCPApprovalResponseItemParam
mcp_call	OpenAI.MCPCallItemParam
memory_search_call	MemorySearchToolCallItemParam

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.ItemType		Evet

OpenAI.ItemReferenceItemParam

Başvurulacak bir öğenin iç tanımlayıcısı.

İsim	Türü	Description	Gerekli	Varsayılan
kimlik	String	Daha önce oluşturulmuş ve referans alınan yanıt öğesinin servis kaynaklı kimliği.	Evet
type	enum	Olası değerler: item_reference	Evet

OpenAI.ItemResource

Yanıt oluşturmak için kullanılan içerik öğesi.

OpenAI.ItemResource için Ayrıştırıcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
structured_outputs	StructuredOutputsItemResource
workflow_action	WorkflowActionOutputItemResource
oauth_consent_request	OAuthConsentRequestItemResource
message	OpenAI.ResponsesMessageItemResource
computer_call_output	OpenAI.ComputerToolCallOutputItemResource
function_call	OpenAI.FunctionToolCallItemResource
function_call_output	OpenAI.FunctionToolCallOutputItemResource
mcp_approval_response	OpenAI.MCPApprovalResponseItemResource
file_search_call	OpenAI.FileSearchToolCallItemResource
computer_call	OpenAI.ComputerToolCallItemResource
web_search_call	OpenAI.WebSearchToolCallItemResource
reasoning	OpenAI.ReasoningItemResource
image_generation_call	OpenAI.ImageGenToolCallItemResource
code_interpreter_call	OpenAI.CodeInterpreterToolCallItemResource
local_shell_call	OpenAI.LocalShellToolCallItemResource
local_shell_call_output	OpenAI.LocalShellToolCallOutputItemResource
mcp_list_tools	OpenAI.MCPListToolsItemResource
mcp_approval_request	OpenAI.MCPApprovalRequestItemResource
mcp_call	OpenAI.MCPCallItemResource
memory_search_call	MemorySearchToolCallItemResource

İsim	Türü	Description	Gerekli	Varsayılan
Oluşturan	nesne		Hayı
└─ aracısı	AgentId	Öğeyi oluşturan aracı.	Hayı
└─ response_id	String	Öğenin oluşturulduğu yanıt.	Hayı
kimlik	String		Evet
type	OpenAI.ItemType		Evet

OpenAI.ItemType

Mülkiyet	Değer
Türü	String
Değerler	message file_search_call function_call function_call_output computer_call computer_call_output web_search_call reasoning item_reference image_generation_call code_interpreter_call local_shell_call local_shell_call_output mcp_list_tools mcp_approval_request mcp_approval_response mcp_call structured_outputs workflow_action memory_search_call oauth_consent_request

OpenAI.ListFineTuningJobCheckpointsResponse

İsim	Türü	Description	Gerekli	Varsayılan
veriler	dizi		Evet
ilk_kimlik	String		Hayı
daha_fazla	Boolean		Evet
son_kimlik	String		Hayı
nesne	enum	Olası değerler: list	Evet

OpenAI.ListFineTuningJobEventsResponse

İsim	Türü	Description	Gerekli	Varsayılan
veriler	dizi		Evet
daha_fazla	Boolean		Evet
nesne	enum	Olası değerler: list	Evet

OpenAI.ListPaginatedFineTuningJobsResponse

İsim	Türü	Description	Gerekli	Varsayılan
veriler	dizi		Evet
daha_fazla	Boolean		Evet
nesne	enum	Olası değerler: list	Evet

OpenAI.LocalShellExecAction

Sunucuda bir kabuk komutu yürütür.

İsim	Türü	Description	Gerekli	Varsayılan
komut	dizi	Çalıştırılacak komut.	Evet
env	nesne	Komutu için ayarlanacağı ortam değişkenleri.	Evet
zaman_aşımı_ms	tamsayı	komutu için milisaniye cinsinden isteğe bağlı zaman aşımı.	Hayı
type	enum	Yerel kabuk eyleminin türü. Her zaman exec. Olası değerler: exec	Evet
user	String	komutu olarak çalıştırmak için isteğe bağlı kullanıcı.	Hayı
working_directory	String	komutun çalıştırılacak isteğe bağlı çalışma dizini.	Hayı

OpenAI.LocalShellTool

Modelin yerel bir ortamda kabuk komutlarını yürütmesine izin veren bir araç.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Yerel kabuk aracının türü. Her zaman local_shell. Olası değerler: local_shell	Evet

OpenAI.LocalShellToolCallItemParam

Yerel kabukta komut çalıştırmak için bir araç çağrısı.

İsim	Türü	Description	Gerekli	Varsayılan
hareket	OpenAI.LocalShellExecAction	Sunucuda bir kabuk komutu yürütür.	Evet
call_id	String	Model tarafından oluşturulan yerel kabuk aracı çağrısının benzersiz kimliği.	Evet
type	enum	Olası değerler: local_shell_call	Evet

OpenAI.LocalShellToolCallItemResource

Yerel kabukta komut çalıştırmak için bir araç çağrısı.

İsim	Türü	Description	Gerekli	Varsayılan
hareket	OpenAI.LocalShellExecAction	Sunucuda bir kabuk komutu yürütür.	Evet
call_id	String	Model tarafından oluşturulan yerel kabuk aracı çağrısının benzersiz kimliği.	Evet
durum	enum	Olası değerler: in_progress, completed, incomplete	Evet
type	enum	Olası değerler: local_shell_call	Evet

OpenAI.LocalShellToolCallOutputItemParam

Yerel kabuk aracı çağrısının çıktısı.

İsim	Türü	Description	Gerekli	Varsayılan
çıktı	String	Yerel kabuk aracı çağrısının çıkışının JSON dizesi.	Evet
type	enum	Olası değerler: local_shell_call_output	Evet

OpenAI.LocalShellToolCallOutputItemResource

Yerel kabuk aracı çağrısının çıktısı.

İsim	Türü	Description	Gerekli	Varsayılan
çıktı	String	Yerel kabuk aracı çağrısının çıkışının JSON dizesi.	Evet
durum	enum	Olası değerler: in_progress, completed, incomplete	Evet
type	enum	Olası değerler: local_shell_call_output	Evet

OpenAI.Location

OpenAI.Location için Ayırt Edici

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
approximate	OpenAI.ApproximateLocation

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.LocationType		Evet

OpenAI.LokasyonTürü

Mülkiyet	Değer
Türü	String
Değerler	approximate

OpenAI.LogProb

Belirtecin günlük olasılığı.

İsim	Türü	Description	Gerekli	Varsayılan
bytes	dizi		Evet
logprob	Numara		Evet
token	String		Evet
top_logprobs	dizi		Evet

OpenAI.MCPApprovalRequestItemParam

Bir araç çağrısı işlemi için insan onayı isteği.

İsim	Türü	Description	Gerekli	Varsayılan
arguments	String	Araç için bir JSON bağımsız değişken dizesi.	Evet
name	String	Çalıştırılacak aracın adı.	Evet
sunucu etiketi	String	İsteği yapan MCP sunucusunun etiketi.	Evet
type	enum	Olası değerler: mcp_approval_request	Evet

OpenAI.MCPApprovalRequestItemResource

Bir araç çağrısı işlemi için insan onayı isteği.

İsim	Türü	Description	Gerekli	Varsayılan
arguments	String	Araç için bir JSON bağımsız değişken dizesi.	Evet
name	String	Çalıştırılacak aracın adı.	Evet
sunucu etiketi	String	İsteği yapan MCP sunucusunun etiketi.	Evet
type	enum	Olası değerler: mcp_approval_request	Evet

OpenAI.MCPApprovalResponseItemParam

MCP onay isteğine yanıt.

İsim	Türü	Description	Gerekli	Varsayılan
approval_request_id	String	Yanıtlanan onay isteğinin ID'si.	Evet
approve	Boolean	İsteğin onaylanıp onaylanmadı.	Evet
sebep	String	Karar için isteğe bağlı neden.	Hayı
type	enum	Olası değerler: mcp_approval_response	Evet

OpenAI.MCPApprovalResponseItemResource

MCP onay isteğine yanıt.

İsim	Türü	Description	Gerekli	Varsayılan
approval_request_id	String	Yanıtlanan onay isteğinin ID'si.	Evet
approve	Boolean	İsteğin onaylanıp onaylanmadı.	Evet
sebep	String	Karar için isteğe bağlı neden.	Hayı
type	enum	Olası değerler: mcp_approval_response	Evet

OpenAI.MCPCallItemParam

MCP sunucusundaki bir aracın çağrılması.

İsim	Türü	Description	Gerekli	Varsayılan
arguments	String	Araca geçirilen bağımsız değişkenlerin JSON dizesi.	Evet
hata	String	Araç çağrısından gelen bir hata varsa.	Hayı
name	String	Çalıştırılan aracın adı.	Evet
çıktı	String	Araç çağrısının çıktısı.	Hayı
sunucu etiketi	String	Aracı çalıştıran MCP sunucusunun etiketi.	Evet
type	enum	Olası değerler: mcp_call	Evet

OpenAI.MCPCallItemResource

MCP sunucusundaki bir aracın çağrılması.

İsim	Türü	Description	Gerekli	Varsayılan
arguments	String	Araca geçirilen bağımsız değişkenlerin JSON dizesi.	Evet
hata	String	Araç çağrısından gelen bir hata varsa.	Hayı
name	String	Çalıştırılan aracın adı.	Evet
çıktı	String	Araç çağrısının çıktısı.	Hayı
sunucu etiketi	String	Aracı çalıştıran MCP sunucusunun etiketi.	Evet
type	enum	Olası değerler: mcp_call	Evet

OpenAI.MCPListToolsItemParam

MCP sunucusunda kullanılabilen araçların listesi.

İsim	Türü	Description	Gerekli	Varsayılan
hata	String	Sunucu araçları listeleyemediyse hata iletisi.	Hayı
sunucu etiketi	String	MCP sunucusunun etiketi.	Evet
araçlar	dizi	Sunucuda bulunan araçlar.	Evet
type	enum	Olası değerler: mcp_list_tools	Evet

OpenAI.MCPListToolsItemResource

MCP sunucusunda kullanılabilen araçların listesi.

İsim	Türü	Description	Gerekli	Varsayılan
hata	String	Sunucu araçları listeleyemediyse hata iletisi.	Hayı
sunucu etiketi	String	MCP sunucusunun etiketi.	Evet
araçlar	dizi	Sunucuda bulunan araçlar.	Evet
type	enum	Olası değerler: mcp_list_tools	Evet

OpenAI.MCPListToolsTool

MCP sunucusunda kullanılabilen bir araç.

İsim	Türü	Description	Gerekli	Varsayılan
Açıklamalar		Araç hakkında ek açıklamalar.	Hayı
açıklama	String	Araç Açıklaması	Hayı
input_schema		Aracın girişini açıklayan JSON şeması.	Evet
name	String	Araç adı.	Evet

OpenAI.MCPTool

Modele uzak Model Bağlam Protokolü (MCP) sunucuları aracılığıyla ek araçlara erişim verin. MCP hakkında daha fazla bilgi edinin.

İsim	Türü	Description	Gerekli	Varsayılan
izin verilen araçlar	nesne		Hayı
└─ araç_adları	dizi	İzin verilen araç adlarının listesi.	Hayı
headers	nesne	MCP sunucusuna gönderilecek isteğe bağlı HTTP üst bilgileri. Kimlik doğrulaması için kullanma veya başka amaçlarla.	Hayı
project_connection_id	String	MCP sunucusu için projedeki bağlantı kimliği. Bağlantı, MCP sunucusuna bağlanmak için gereken kimlik doğrulamasını ve diğer bağlantı ayrıntılarını saklar.	Hayı
onay_gerektir	object (aşağıdaki geçerli modellere bakın)	Hangi MCP sunucusunun araçlarının onay gerektirdiğini belirtin.	Hayı
sunucu etiketi	String	Bu MCP sunucusu için araç çağrılarında tanımlamak için kullanılan bir etiket.	Evet
sunucu_url	String	MCP sunucusunun URL'si.	Evet
type	enum	MCP aracının türü. Her zaman mcp. Olası değerler: mcp	Evet

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

bir istem şablonuna ve değişkenlerine başvuru. Daha fazla bilgi edinin.

İsim	Türü	Description	Gerekli	Varsayılan
kimlik	String	Kullanılacak istem şablonunun benzersiz tanımlayıcısı.	Evet
değişkenler	nesne	içindeki değişkenlerin yerine kullanılacak isteğe bağlı değer eşlemesi Istemi. Değiştirme değerleri dizeler veya başka bir değer olabilir Görüntüler veya dosyalar gibi yanıt giriş türleri.	Hayı
version	String	İstem şablonunun isteğe bağlı sürümü.	Hayı

OpenAI.RankingOptions

İsim	Türü	Description	Gerekli	Varsayılan
sıralayıcı	enum	Dosya araması için kullanılacak dereceleyici. Olası değerler: auto, default-2024-11-15	Hayı
puan_eşik_değeri	Numara	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ı

OpenAI.Reasoning

yalnızca o serisi modeller

Mantık modelleri için yapılandırma seçenekleri.

İsim	Türü	Description	Gerekli	Varsayılan
effort	nesne	Mantıp modelleri için mantık yürütme çabasını kısıtlar. Şu anda desteklenen değerler hiçbiri, en düşük, düşük, orta ve yüksek değerlerdir. 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 yok olur ve mantık yürütmez. gpt-5.1 için desteklenen mantık değerleri yok, düşük, orta ve yüksektir. Araç çağrıları gpt-5.1'deki tüm akıl yürütme değerleri için desteklenir. gpt-5.1'in önceki tüm modelleri varsayılan olarak orta düzeyde mantık yürütme eforu kullanır ve hiçbirini desteklemez. gpt-5-pro modeli varsayılan olarak yüksek mantık eforu kullanır (ve yalnızca destekler).	Hayı
generate_summary	enum	Kullanım dışı: bunun yerine kullanın summary . Model tarafından gerçekleştirilen mantığın özeti. Bu, hata ayıklama ve modelin akıl yürütme işlemini anlamak için yararlı olabilir. auto, conciseveya detailed. Olası değerler: auto, concise, detailed	Hayı
summary	enum	Model tarafından gerçekleştirilen mantığın özeti. Bu, hata ayıklamak ve modelin akıl yürütme işlemini anlamak için kullanışlıdır. auto, conciseveya detailed. Olası değerler: auto, concise, detailed	Hayı

OpenAI.ReasoningEffort

Mantıp modelleri için mantık yürütme çabasını kısıtlar.

Şu anda desteklenen değerler hiçbiri, en düşük, düşük, orta ve yüksek değerlerdir.

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 yok olur ve mantık yürütmez. gpt-5.1 için desteklenen mantık değerleri yok, düşük, orta ve yüksektir. Araç çağrıları gpt-5.1'deki tüm akıl yürütme değerleri için desteklenir.

gpt-5.1'in önceki tüm modelleri varsayılan olarak orta düzeyde mantık yürütme eforu kullanır ve hiçbirini desteklemez.

gpt-5-pro modeli varsayılan olarak yüksek mantık eforu kullanır (ve yalnızca destekler).

Mülkiyet	Değer
Açıklama	Mantıp modelleri için mantık yürütme çabasını kısıtlar. Şu anda desteklenen değerler hiçbiri, en düşük, düşük, orta ve yüksek değerlerdir. 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 yok olur ve mantık yürütmez. gpt-5.1 için desteklenen mantık değerleri yok, düşük, orta ve yüksektir. Araç çağrıları gpt-5.1'deki tüm akıl yürütme değerleri için desteklenir. gpt-5.1'in önceki tüm modelleri varsayılan olarak orta düzeyde mantık yürütme eforu kullanır ve hiçbirini desteklemez. gpt-5-pro modeli varsayılan olarak yüksek mantık eforu kullanır (ve yalnızca destekler).
Türü	String
Değerler	none minimal low medium high

OpenAI.ReasoningItemParam

Bir yanıt oluştururken bir akıl yürütme modeli tarafından kullanılan düşünce zincirinin açıklaması. input, bir görüşmenin sonraki dönüşleri için bu öğeleri Yanıtlar API'sine eklediğinizden emin olun.

İsim	Türü	Description	Gerekli	Varsayılan
encrypted_content	String	Muhakeme öğesinin şifrelenmiş içeriği - yanıt verildiğinde doldurulur reasoning.encrypted_content, include parametresinde oluşturulur.	Hayı
summary	dizi	Metin içeriğini muhakeme etme.	Evet
type	enum	Olası değerler: reasoning	Evet

OpenAI.ReasoningItemResource

Bir yanıt oluştururken bir akıl yürütme modeli tarafından kullanılan düşünce zincirinin açıklaması. input, bir görüşmenin sonraki dönüşleri için bu öğeleri Yanıtlar API'sine eklediğinizden emin olun.

İsim	Türü	Description	Gerekli	Varsayılan
encrypted_content	String	Muhakeme öğesinin şifrelenmiş içeriği - yanıt verildiğinde doldurulur reasoning.encrypted_content, include parametresinde oluşturulur.	Hayı
summary	dizi	Metin içeriğini muhakeme etme.	Evet
type	enum	Olası değerler: reasoning	Evet

OpenAI.ReasoningItemSummaryPart

OpenAI.ReasoningItemSummaryPart için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
summary_text	OpenAI.ReasoningItemSummaryTextPart

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.ReasoningItemSummaryPartType		Evet

OpenAI.ReasoningItemSummaryPartType

Mülkiyet	Değer
Türü	String
Değerler	summary_text

OpenAI.ReasoningItemSummaryTextPart

İsim	Türü	Description	Gerekli	Varsayılan
text	String		Evet
type	enum	Olası değerler: summary_text	Evet

OpenAI.Response

İsim	Türü	Description	Gerekli	Varsayılan
ajan	nesne		Hayı
└─ ad	String	Aracının adı.	Hayı
└─ türü	enum	Olası değerler: agent_id	Hayı
└─ sürümü	String	Aracının sürüm tanımlayıcısı.	Hayı
arka plan	Boolean	Model yanıtının arka planda çalıştırılıp çalıştırılmayacağı. Arka plan yanıtları hakkında daha fazla bilgi edinin.	Hayı	Yanlış
konuşma	nesne		Evet
└─ kimlik	String		Hayı
oluşturulma_tarihi	tamsayı	Bu Yanıtın oluşturulduğu unix zaman damgası (saniye).	Evet
hata	nesne	Model yanıt oluşturamadığında döndürülen bir hata nesnesi.	Evet
└─ kod	OpenAI.ResponseErrorCode	Yanıtın hata kodu.	Hayı
└─ ileti	String	Hatanın insan tarafından okunabilen açıklaması.	Hayı
kimlik	String	Bu Yanıt için benzersiz tanımlayıcı.	Evet
incomplete_details	nesne	Yanıtın neden eksik olduğuna ilişkin ayrıntılar.	Evet
└─ neden	enum	Yanıtın tamamlanmamış olmasının nedeni. Olası değerler: max_output_tokens, content_filter	Hayı
instructions	dize veya dizi		Evet
max_output_tokens	tamsayı	Görünür çıkış belirteçleri ve muhakeme belirteçleri de dahil olmak üzere yanıt için oluşturulabilecek belirteç sayısı için üst sınır.	Hayı
max_tool_calls	tamsayı	Bir yanıtta işlenebilen yerleşik araçlara yapılan toplam çağrı sayısı üst sınırı. Bu maksimum sayı, tek tek araç başına değil, tüm yerleşik araç çağrıları için geçerlidir. Model tarafından bir aracı çağırmaya yönelik diğer girişimler yoksayılır.	Hayı
metadata	nesne	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Evet
model	String	Bu yanıtın oluşturulması için kullanılacak model dağıtımı.	Hayı
nesne	enum	Bu kaynağın nesne türü - her zaman response olarak ayarlanır. Olası değerler: response	Evet
çıktı	dizi	Model tarafından oluşturulan içerik öğeleri dizisi. - Dizideki output öğelerin uzunluğu ve sırası bağlıdır modelin yanıtı üzerinde. - Dizideki output ilk öğeye erişmek yerine ve tarafından oluşturulan içeriğe sahip bir assistant ileti olduğunu varsayarsak modeli dikkate alarak output_text özelliğini kullanmayı düşünebilirsiniz. SDK'larda desteklenir.	Evet
output_text	String	Toplanan metin çıkışını içeren yalnızca SDK kolaylık özelliği Dizideki output_text öğelerin tümünden, eğer varsa. Python ve JavaScript SDK'larında desteklenir.	Hayı
paralel araç çağrıları	Boolean	Modelin araç çağrılarını paralel olarak çalıştırmasına izin verilip verilmeyeceği.	Evet	Doğru
previous_response_id	String	Modele önceki yanıtın benzersiz kimliği. Bunu şunu yapmak için kullanın: çok aşamalı konuşmalar oluşturun. Hakkında daha fazla bilgi edinin konuşma durumunu yönetme.	Hayı
prompt	nesne	bir istem şablonuna ve değişkenlerine başvuru. Daha fazla bilgi edinin.	Hayı
└─ kimlik	String	Kullanılacak istem şablonunun benzersiz tanımlayıcısı.	Hayı
└─ değişkenler	OpenAI.ResponsePromptVariables	içindeki değişkenlerin yerine kullanılacak isteğe bağlı değer eşlemesi Istemi. Değiştirme değerleri dizeler veya başka bir değer olabilir Görüntüler veya dosyalar gibi yanıt giriş türleri.	Hayı
└─ sürümü	String	İstem şablonunun isteğe bağlı sürümü.	Hayı
reasoning	nesne	yalnızca o serisi modeller Mantık modelleri için yapılandırma seçenekleri.	Hayı
└─ çaba	OpenAI.ReasoningEffort	Mantıp modelleri için mantık yürütme çabasını kısıtlar. Şu anda desteklenen değerler hiçbiri, en düşük, düşük, orta ve yüksek değerlerdir. 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 yok olur ve mantık yürütmez. gpt-5.1 için desteklenen mantık değerleri yok, düşük, orta ve yüksektir. Araç çağrıları gpt-5.1'deki tüm akıl yürütme değerleri için desteklenir. gpt-5.1'in önceki tüm modelleri varsayılan olarak orta düzeyde mantık yürütme eforu kullanır ve hiçbirini desteklemez. gpt-5-pro modeli varsayılan olarak yüksek mantık eforu kullanır (ve yalnızca destekler).	Hayı
└─ özet oluştur	enum	Kullanım dışı: bunun yerine kullanın summary . Model tarafından gerçekleştirilen mantığın özeti. Bu, hata ayıklama ve modelin akıl yürütme işlemini anlamak için yararlı olabilir. auto, conciseveya detailed. Olası değerler: auto, concise, detailed	Hayı
└─ özeti	enum	Model tarafından gerçekleştirilen mantığın özeti. Bu, hata ayıklamak ve modelin akıl yürütme işlemini anlamak için kullanışlıdır. auto, conciseveya detailed. Olası değerler: auto, concise, detailed	Hayı
hizmet seviyesi	nesne	İsteğin sunulması için kullanılan işleme türünü belirtir. * 'otomatik' olarak ayarlanırsa istek hizmet katmanıyla işlenir proje ayarlarında yapılandırılır. Aksi yapılandırılmadığı sürece, Project 'default' kullanır. * 'varsayılan' olarak ayarlanırsa, istek standartla işlenir fiyatlandırma ve seçilen model için performans. * 'flex' olarak ayarlanırsa veya 'öncelik', ardından istek ilgili hizmetle işlenir Katmanı. Öncelik işleme hakkında daha fazla bilgi edinmek için satış ekibiyle iletişime geçin. * Ayarlanmadığında, varsayılan davranış 'auto' şeklindedir. service_tier Parametresi ayarlandığında, yanıt gövdesiservice_tier değeri, aslında isteğe hizmet etmek için kullanılan işleme modunu temel alır. Bu yanıt değeri parametresinde ayarlanan değerden farklı olabilir.	Hayı
durum	enum	Yanıt oluşturma durumu. , , completed' lerden failedbiri in_progress, cancelled, queued veya incomplete. Olası değerler: completed, failed, in_progress, cancelled, , queued, incomplete	Hayı
structured_inputs	nesne	Yanıta, istem şablonu değiştirme veya araç bağımsız değişkeni bağlamalarına katılabilen yapılandırılmış girişler.	Hayı
sıcaklık	Numara	0 ile 2 arasında hangi örnekleme sıcaklığının kullanılacağı. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir. Genellikle bunu değiştirmenizi öneririz top_p ancak ikisini birden değiştirmemenizi öneririz.	Evet
text	nesne	Modelden metin yanıtı için yapılandırma seçenekleri. Düz olabilir metin veya yapılandırılmış JSON verileri. Bkz . Metin girişleri ve çıkışları ve Yapılandırılmış Çıkışlar	Hayı
└─ biçimi	OpenAI.ResponseTextFormatConfiguration		Hayı
tool_choice	nesne	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 bir ileti oluşturması veya birini araması anlamına gelir. daha fazla araç. required modelin bir veya daha fazla araç çağırması gerektiği anlamına gelir.	Hayı
└─ türü	OpenAI.ToolChoiceObjectType	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.	Hayı
araçlar	dizi	Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Siz parametresini ayarlayarak tool_choice hangi aracın kullanılacağını belirtebilir. Modeli sağlayabileceğiniz iki araç kategorisi şunlardır: * Yerleşik araçlar: OpenAI tarafından sağlanan ve işlevselliği genişleten araçlar modelin web araması gibi özellikleri veya dosya arama. Hakkında daha fazla bilgi edinin yerleşik araçlar. * İşlev çağrıları (özel araçlar): Sizin tanımladığınız işlevler, Modelin kendi yazdığınız kodu çağırmasını sağlama. Hakkında daha fazla bilgi edinin işlev çağrısı.	Hayı
top_logprobs	tamsayı	Her biri ilişkili günlük olasılığına sahip her belirteç konumunda döndürülecek en olası belirteç sayısını belirten 0 ile 20 arasında bir tamsayı.	Hayı
top_p	Numara	Sıcaklıkla örneklemeye alternatif olarak çekirdek örneklemesi adı verilir, burada model, belirteçlerin sonuçlarını top_p olasılıkla değerlendirir kütle. Yani 0,1 yalnızca ilk 10% olasılık kütlesini oluşturan belirteçler anlamına gelir dikkate alınır. Genellikle bunu değiştirmenizi öneririz temperature ancak ikisini birden değiştirmemenizi öneririz.	Evet
truncation	enum	Model yanıtı için kullanılacak kesme stratejisi. - auto: Bu yanıtın bağlamı ve önceki yanıtlar aşarsa modelin bağlam penceresi boyutu, modelin yanıtı bağlam penceresine uydurmak için giriş öğelerini düşürerek konuşmanın ortasında. - disabled (varsayılan): Model yanıtı bağlam penceresini aşarsa Bir model için boyut yanlış girilirse, istek 400 hatasıyla başarısız olur. Olası değerler: auto, disabled	Hayı
usage	OpenAI.ResponseUsage	Giriş belirteçleri, çıkış belirteçleri dahil olmak üzere belirteç kullanım ayrıntılarını temsil eder. çıkış belirteçlerinin ve kullanılan toplam belirteçlerin dökümü.	Hayı
user	String	En iyi güvenlik uygulamaları hakkında daha fazla bilgi edinin.	Evet

OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent

Kısmi kod parçacığı kod yorumlayıcı tarafından akışa alındığında yayılır.

İsim	Türü	Description	Gerekli	Varsayılan
delta	String	Kod yorumlayıcı tarafından akışı yapılan kısmi kod parçacığı.	Evet
item_id	String	Kod yorumlayıcı aracı çağrı öğesinin benzersiz tanımlayıcısı.	Evet
output_index	tamsayı	Kodun akışa alındığı yanıttaki çıkış öğesinin dizini.	Evet
type	enum	Olayın türü. Her zaman response.code_interpreter_call_code.delta. Olası değerler: response.code_interpreter_call_code.delta	Evet

OpenAI.ResponseCodeInterpreterCallCodeDoneEvent

Kod parçacığı kod yorumlayıcı tarafından sonlandırıldığında yayılır.

İsim	Türü	Description	Gerekli	Varsayılan
kod	String	Kod yorumlayıcısı tarafından son kod parçacığı çıkışı.	Evet
item_id	String	Kod yorumlayıcı aracı çağrı öğesinin benzersiz tanımlayıcısı.	Evet
output_index	tamsayı	Kodun sonlandırıldığı yanıttaki çıkış öğesinin dizini.	Evet
type	enum	Olayın türü. Her zaman response.code_interpreter_call_code.done. Olası değerler: response.code_interpreter_call_code.done	Evet

OpenAI.ResponseCodeInterpreterCallCompletedEvent

Kod yorumlayıcı çağrısı tamamlandığında gönderilir.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	Kod yorumlayıcı aracı çağrı öğesinin benzersiz tanımlayıcısı.	Evet
output_index	tamsayı	Kod yorumlayıcı çağrısının tamamlandığı yanıttaki çıkış öğesinin dizini.	Evet
type	enum	Olayın türü. Her zaman response.code_interpreter_call.completed. Olası değerler: response.code_interpreter_call.completed	Evet

OpenAI.ResponseCodeInterpreterCallInProgressEvent

Bir kod yorumlayıcı çağrısı sırasında tetiklenir.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	Kod yorumlayıcı aracı çağrı öğesinin benzersiz tanımlayıcısı.	Evet
output_index	tamsayı	Kod yorumlayıcı çağrısının devam ettiği yanıttaki çıkış öğesinin dizini.	Evet
type	enum	Olayın türü. Her zaman response.code_interpreter_call.in_progress. Olası değerler: response.code_interpreter_call.in_progress	Evet

OpenAI.ResponseCodeInterpreterCallInterpretingEvent

Kod yorumlayıcısı kod parçacığını etkin bir şekilde yorumladığında yayılır.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	Kod yorumlayıcı aracı çağrı öğesinin benzersiz tanımlayıcısı.	Evet
output_index	tamsayı	Kod yorumlayıcının kodu yorumladığı yanıttaki çıkış öğesinin dizini.	Evet
type	enum	Olayın türü. Her zaman response.code_interpreter_call.interpreting. Olası değerler: response.code_interpreter_call.interpreting	Evet

OpenAI.ResponseCompletedEvent

Model yanıtı tamamlandığında gönderilir.

İsim	Türü	Description	Gerekli	Varsayılan
yanıt	nesne		Evet
└─ aracısı	AgentId	Bu yanıt için kullanılan aracı	Hayı
└─ arka plan	Boolean	Model yanıtının arka planda çalıştırılıp çalıştırılmayacağı. Arka plan yanıtları hakkında daha fazla bilgi edinin.	Hayı	Yanlış
└─ konuşma	nesne		Hayı
└─ kimlik	String		Hayı
└─ oluşturulma_tarihi	tamsayı	Bu Yanıtın oluşturulduğu unix zaman damgası (saniye).	Hayı
└─ hata	OpenAI.ResponseError	Model yanıt oluşturamadığında döndürülen bir hata nesnesi.	Hayı
└─ kimlik	String	Bu Yanıt için benzersiz tanımlayıcı.	Hayı
└─ eksik_bilgiler	nesne	Yanıtın neden eksik olduğuna ilişkin ayrıntılar.	Hayı
└─ neden	enum	Yanıtın tamamlanmamış olmasının nedeni. Olası değerler: max_output_tokens, content_filter	Hayı
└─ yönerge	dize veya dizi	Modelin bağlamı içine eklenen bir sistem (veya geliştirici) iletisi. previous_response_id ile birlikte kullanırken, önceki yönergelerden gelen talimatlar yanıt bir sonraki yanıta aktarılmaz. Bu, basit olmasını sağlar yeni yanıtlarda sistem (veya geliştirici) iletilerini değiştirmek için.	Hayı
└─ maksimum_çıkış_jetonları	tamsayı	Görünür çıkış belirteçleri ve muhakeme belirteçleri de dahil olmak üzere yanıt için oluşturulabilecek belirteç sayısı için üst sınır.	Hayı
└─ maksimum araç çağrıları	tamsayı	Bir yanıtta işlenebilen yerleşik araçlara yapılan toplam çağrı sayısı üst sınırı. Bu maksimum sayı, tek tek araç başına değil, tüm yerleşik araç çağrıları için geçerlidir. Model tarafından bir aracı çağırmaya yönelik diğer girişimler yoksayılır.	Hayı
└─ meta veriler	nesne	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Hayı
└─ modeli	String	Bu yanıtın oluşturulması için kullanılacak model dağıtımı.	Hayı
└─ nesne	enum	Bu kaynağın nesne türü - her zaman response olarak ayarlanır. Olası değerler: response	Hayı
└─ çıkış	dizi	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.	Hayı
└─ çıktı_metin	String	Toplanan metin çıkışını içeren yalnızca SDK kolaylık özelliği Dizideki output_text öğelerin tümünden, eğer varsa. Python ve JavaScript SDK'larında desteklenir.	Hayı
└─ paralel_arac_cagrilari	Boolean	Modelin araç çağrılarını paralel olarak çalıştırmasına izin verilip verilmeyeceği.	Hayı	Doğru
└─ önceki_cevap_id	String	Modele önceki yanıtın benzersiz kimliği. Bunu şunu yapmak için kullanın: çok aşamalı konuşmalar oluşturun. Hakkında daha fazla bilgi edinin konuşma durumunu yönetme.	Hayı
└─ istemi	OpenAI.Prompt	bir istem şablonuna ve değişkenlerine başvuru. Daha fazla bilgi edinin.	Hayı
└─ akıl yürütme	OpenAI.Reasoning	yalnızca o serisi modeller Mantık modelleri için yapılandırma seçenekleri.	Hayı
└─ service_tier	OpenAI.ServiceTier	Not: service_tier Azure OpenAI için geçerli değildir.	Hayı
└─ durumu	enum	Yanıt oluşturma durumu. , , completed' lerden failedbiri in_progress, cancelled, queued veya incomplete. Olası değerler: completed, failed, in_progress, cancelled, , queued, incomplete	Hayı
└─ structured_inputs	nesne	Yanıta, istem şablonu değiştirme veya araç bağımsız değişkeni bağlamalarına katılabilen yapılandırılmış girişler.	Hayı
└─ sıcaklık	Numara	0 ile 2 arasında hangi örnekleme sıcaklığının kullanılacağı. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir. Genellikle bunu değiştirmenizi öneririz top_p ancak ikisini birden değiştirmemenizi öneririz.	Hayı
└─ metin	nesne	Modelden metin yanıtı için yapılandırma seçenekleri. Düz olabilir metin veya yapılandırılmış JSON verileri. Bkz . Metin girişleri ve çıkışları ve Yapılandırılmış Çıkışlar	Hayı
└─ biçimi	OpenAI.ResponseTextFormatConfiguration		Hayı
└─ araç seçimi	OpenAI.ToolChoiceOptions veya OpenAI.ToolChoiceObject	Model, oluştururken kullanılacak aracı (veya araçları) nasıl seçmelidir? bir cevap tools Hangi araçların nasıl belirtileceğini görmek için parametresine bakın modeli çağırabilir.	Hayı
└─ araçları	dizi	Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Siz parametresini ayarlayarak tool_choice hangi aracın kullanılacağını belirtebilir. Modeli sağlayabileceğiniz iki araç kategorisi şunlardır: * Yerleşik araçlar: OpenAI tarafından sağlanan ve işlevselliği genişleten araçlar modelin web araması gibi özellikleri veya dosya arama. Hakkında daha fazla bilgi edinin yerleşik araçlar. * İşlev çağrıları (özel araçlar): Sizin tanımladığınız işlevler, Modelin kendi yazdığınız kodu çağırmasını sağlama. Hakkında daha fazla bilgi edinin işlev çağrısı.	Hayı
└─ top_logprobs	tamsayı	Her biri ilişkili günlük olasılığına sahip her belirteç konumunda döndürülecek en olası belirteç sayısını belirten 0 ile 20 arasında bir tamsayı.	Hayı
└─ top_p	Numara	Sıcaklıkla örneklemeye alternatif olarak çekirdek örneklemesi adı verilir, burada model, belirteçlerin sonuçlarını top_p olasılıkla değerlendirir kütle. Yani 0,1 yalnızca ilk 10% olasılık kütlesini oluşturan belirteçler anlamına gelir dikkate alınır. Genellikle bunu değiştirmenizi öneririz temperature ancak ikisini birden değiştirmemenizi öneririz.	Hayı
└─ kısaltma	enum	Model yanıtı için kullanılacak kesme stratejisi. - auto: Bu yanıtın bağlamı ve önceki yanıtlar aşarsa modelin bağlam penceresi boyutu, modelin yanıtı bağlam penceresine uydurmak için giriş öğelerini düşürerek konuşmanın ortasında. - disabled (varsayılan): Model yanıtı bağlam penceresini aşarsa Bir model için boyut yanlış girilirse, istek 400 hatasıyla başarısız olur. Olası değerler: auto, disabled	Hayı
└─ kullanımı	OpenAI.ResponseUsage	Giriş belirteçleri, çıkış belirteçleri dahil olmak üzere belirteç kullanım ayrıntılarını temsil eder. çıkış belirteçlerinin ve kullanılan toplam belirteçlerin dökümü.	Hayı
└─ kullanıcı	String	En iyi güvenlik uygulamaları hakkında daha fazla bilgi edinin.	Hayı
type	enum	Olayın türü. Her zaman response.completed. Olası değerler: response.completed	Evet

OpenAI.ResponseContentPartAddedEvent

Yeni bir içerik bölümü eklendiğinde gönderilir.

İsim	Türü	Description	Gerekli	Varsayılan
content_index	tamsayı	Eklenen içerik bölümünün dizini.	Evet
item_id	String	İçerik bölümünün eklendiği çıkış öğesinin kimliği.	Evet
output_index	tamsayı	İçerik bölümünün eklendiği çıkış öğesinin dizini.	Evet
parça	nesne		Evet
└─ türü	OpenAI.ItemContentType	Çok modlu giriş ve çıkış içeriği.	Hayı
type	enum	Olayın türü. Her zaman response.content_part.added. Olası değerler: response.content_part.added	Evet

OpenAI.ResponseContentPartDoneEvent

İçerik bölümü tamamlandığında gönderilir.

İsim	Türü	Description	Gerekli	Varsayılan
content_index	tamsayı	Tamamlanan içerik bölümünün dizini.	Evet
item_id	String	İçerik bölümünün eklendiği çıkış öğesinin kimliği.	Evet
output_index	tamsayı	İçerik bölümünün eklendiği çıkış öğesinin dizini.	Evet
parça	nesne		Evet
└─ türü	OpenAI.ItemContentType	Çok modlu giriş ve çıkış içeriği.	Hayı
type	enum	Olayın türü. Her zaman response.content_part.done. Olası değerler: response.content_part.done	Evet

OpenAI.ResponseCreatedEvent

Bir yanıt oluşturulduğunda yayılan bir olay.

İsim	Türü	Description	Gerekli	Varsayılan
yanıt	nesne		Evet
└─ aracısı	AgentId	Bu yanıt için kullanılan aracı	Hayı
└─ arka plan	Boolean	Model yanıtının arka planda çalıştırılıp çalıştırılmayacağı. Arka plan yanıtları hakkında daha fazla bilgi edinin.	Hayı	Yanlış
└─ konuşma	nesne		Hayı
└─ kimlik	String		Hayı
└─ oluşturulma_tarihi	tamsayı	Bu Yanıtın oluşturulduğu unix zaman damgası (saniye).	Hayı
└─ hata	OpenAI.ResponseError	Model yanıt oluşturamadığında döndürülen bir hata nesnesi.	Hayı
└─ kimlik	String	Bu Yanıt için benzersiz tanımlayıcı.	Hayı
└─ eksik_bilgiler	nesne	Yanıtın neden eksik olduğuna ilişkin ayrıntılar.	Hayı
└─ neden	enum	Yanıtın tamamlanmamış olmasının nedeni. Olası değerler: max_output_tokens, content_filter	Hayı
└─ yönerge	dize veya dizi	Modelin bağlamı içine eklenen bir sistem (veya geliştirici) iletisi. previous_response_id ile birlikte kullanırken, önceki yönergelerden gelen talimatlar yanıt bir sonraki yanıta aktarılmaz. Bu, basit olmasını sağlar yeni yanıtlarda sistem (veya geliştirici) iletilerini değiştirmek için.	Hayı
└─ maksimum_çıkış_jetonları	tamsayı	Görünür çıkış belirteçleri ve muhakeme belirteçleri de dahil olmak üzere yanıt için oluşturulabilecek belirteç sayısı için üst sınır.	Hayı
└─ maksimum araç çağrıları	tamsayı	Bir yanıtta işlenebilen yerleşik araçlara yapılan toplam çağrı sayısı üst sınırı. Bu maksimum sayı, tek tek araç başına değil, tüm yerleşik araç çağrıları için geçerlidir. Model tarafından bir aracı çağırmaya yönelik diğer girişimler yoksayılır.	Hayı
└─ meta veriler	nesne	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Hayı
└─ modeli	String	Bu yanıtın oluşturulması için kullanılacak model dağıtımı.	Hayı
└─ nesne	enum	Bu kaynağın nesne türü - her zaman response olarak ayarlanır. Olası değerler: response	Hayı
└─ çıkış	dizi	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.	Hayı
└─ çıktı_metin	String	Toplanan metin çıkışını içeren yalnızca SDK kolaylık özelliği Dizideki output_text öğelerin tümünden, eğer varsa. Python ve JavaScript SDK'larında desteklenir.	Hayı
└─ paralel_arac_cagrilari	Boolean	Modelin araç çağrılarını paralel olarak çalıştırmasına izin verilip verilmeyeceği.	Hayı	Doğru
└─ önceki_cevap_id	String	Modele önceki yanıtın benzersiz kimliği. Bunu şunu yapmak için kullanın: çok aşamalı konuşmalar oluşturun. Hakkında daha fazla bilgi edinin konuşma durumunu yönetme.	Hayı
└─ istemi	OpenAI.Prompt	bir istem şablonuna ve değişkenlerine başvuru. Daha fazla bilgi edinin.	Hayı
└─ akıl yürütme	OpenAI.Reasoning	yalnızca o serisi modeller Mantık modelleri için yapılandırma seçenekleri.	Hayı
└─ service_tier	OpenAI.ServiceTier	Not: service_tier Azure OpenAI için geçerli değildir.	Hayı
└─ durumu	enum	Yanıt oluşturma durumu. , , completed' lerden failedbiri in_progress, cancelled, queued veya incomplete. Olası değerler: completed, failed, in_progress, cancelled, , queued, incomplete	Hayı
└─ structured_inputs	nesne	Yanıta, istem şablonu değiştirme veya araç bağımsız değişkeni bağlamalarına katılabilen yapılandırılmış girişler.	Hayı
└─ sıcaklık	Numara	0 ile 2 arasında hangi örnekleme sıcaklığının kullanılacağı. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir. Genellikle bunu değiştirmenizi öneririz top_p ancak ikisini birden değiştirmemenizi öneririz.	Hayı
└─ metin	nesne	Modelden metin yanıtı için yapılandırma seçenekleri. Düz olabilir metin veya yapılandırılmış JSON verileri. Bkz . Metin girişleri ve çıkışları ve Yapılandırılmış Çıkışlar	Hayı
└─ biçimi	OpenAI.ResponseTextFormatConfiguration		Hayı
└─ araç seçimi	OpenAI.ToolChoiceOptions veya OpenAI.ToolChoiceObject	Model, oluştururken kullanılacak aracı (veya araçları) nasıl seçmelidir? bir cevap tools Hangi araçların nasıl belirtileceğini görmek için parametresine bakın modeli çağırabilir.	Hayı
└─ araçları	dizi	Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Siz parametresini ayarlayarak tool_choice hangi aracın kullanılacağını belirtebilir. Modeli sağlayabileceğiniz iki araç kategorisi şunlardır: * Yerleşik araçlar: OpenAI tarafından sağlanan ve işlevselliği genişleten araçlar modelin web araması gibi özellikleri veya dosya arama. Hakkında daha fazla bilgi edinin yerleşik araçlar. * İşlev çağrıları (özel araçlar): Sizin tanımladığınız işlevler, Modelin kendi yazdığınız kodu çağırmasını sağlama. Hakkında daha fazla bilgi edinin işlev çağrısı.	Hayı
└─ top_logprobs	tamsayı	Her biri ilişkili günlük olasılığına sahip her belirteç konumunda döndürülecek en olası belirteç sayısını belirten 0 ile 20 arasında bir tamsayı.	Hayı
└─ top_p	Numara	Sıcaklıkla örneklemeye alternatif olarak çekirdek örneklemesi adı verilir, burada model, belirteçlerin sonuçlarını top_p olasılıkla değerlendirir kütle. Yani 0,1 yalnızca ilk 10% olasılık kütlesini oluşturan belirteçler anlamına gelir dikkate alınır. Genellikle bunu değiştirmenizi öneririz temperature ancak ikisini birden değiştirmemenizi öneririz.	Hayı
└─ kısaltma	enum	Model yanıtı için kullanılacak kesme stratejisi. - auto: Bu yanıtın bağlamı ve önceki yanıtlar aşarsa modelin bağlam penceresi boyutu, modelin yanıtı bağlam penceresine uydurmak için giriş öğelerini düşürerek konuşmanın ortasında. - disabled (varsayılan): Model yanıtı bağlam penceresini aşarsa Bir model için boyut yanlış girilirse, istek 400 hatasıyla başarısız olur. Olası değerler: auto, disabled	Hayı
└─ kullanımı	OpenAI.ResponseUsage	Giriş belirteçleri, çıkış belirteçleri dahil olmak üzere belirteç kullanım ayrıntılarını temsil eder. çıkış belirteçlerinin ve kullanılan toplam belirteçlerin dökümü.	Hayı
└─ kullanıcı	String	En iyi güvenlik uygulamaları hakkında daha fazla bilgi edinin.	Hayı
type	enum	Olayın türü. Her zaman response.created. Olası değerler: response.created	Evet

OpenAI.ResponseError

Model yanıt oluşturamadığında döndürülen bir hata nesnesi.

İsim	Türü	Description	Gerekli	Varsayılan
kod	OpenAI.ResponseErrorCode	Yanıtın hata kodu.	Evet
mesaj	String	Hatanın insan tarafından okunabilen açıklaması.	Evet

OpenAI.ResponseErrorCode

Yanıtın hata kodu.

Mülkiyet	Değer
Açıklama	Yanıtın hata kodu.
Türü	String
Değerler	server_error rate_limit_exceeded invalid_prompt vector_store_timeout invalid_image invalid_image_format invalid_base64_image invalid_image_url image_too_large image_too_small image_parse_error image_content_policy_violation invalid_image_mode image_file_too_large unsupported_image_media_type empty_image_file failed_to_download_image image_file_not_found

OpenAI.ResponseErrorEvent

Bir hata oluştuğunda yayılır.

İsim	Türü	Description	Gerekli	Varsayılan
kod	String	Hata kodu.	Evet
mesaj	String	Hata iletisi.	Evet
param	String	Hata parametresi.	Evet
type	enum	Olayın türü. Her zaman error. Olası değerler: error	Evet

OpenAI.ResponseFailedEvent

Yanıt başarısız olduğunda yayılan bir olay.

İsim	Türü	Description	Gerekli	Varsayılan
yanıt	nesne		Evet
└─ aracısı	AgentId	Bu yanıt için kullanılan aracı	Hayı
└─ arka plan	Boolean	Model yanıtının arka planda çalıştırılıp çalıştırılmayacağı. Arka plan yanıtları hakkında daha fazla bilgi edinin.	Hayı	Yanlış
└─ konuşma	nesne		Hayı
└─ kimlik	String		Hayı
└─ oluşturulma_tarihi	tamsayı	Bu Yanıtın oluşturulduğu unix zaman damgası (saniye).	Hayı
└─ hata	OpenAI.ResponseError	Model yanıt oluşturamadığında döndürülen bir hata nesnesi.	Hayı
└─ kimlik	String	Bu Yanıt için benzersiz tanımlayıcı.	Hayı
└─ eksik_bilgiler	nesne	Yanıtın neden eksik olduğuna ilişkin ayrıntılar.	Hayı
└─ neden	enum	Yanıtın tamamlanmamış olmasının nedeni. Olası değerler: max_output_tokens, content_filter	Hayı
└─ yönerge	dize veya dizi	Modelin bağlamı içine eklenen bir sistem (veya geliştirici) iletisi. previous_response_id ile birlikte kullanırken, önceki yönergelerden gelen talimatlar yanıt bir sonraki yanıta aktarılmaz. Bu, basit olmasını sağlar yeni yanıtlarda sistem (veya geliştirici) iletilerini değiştirmek için.	Hayı
└─ maksimum_çıkış_jetonları	tamsayı	Görünür çıkış belirteçleri ve muhakeme belirteçleri de dahil olmak üzere yanıt için oluşturulabilecek belirteç sayısı için üst sınır.	Hayı
└─ maksimum araç çağrıları	tamsayı	Bir yanıtta işlenebilen yerleşik araçlara yapılan toplam çağrı sayısı üst sınırı. Bu maksimum sayı, tek tek araç başına değil, tüm yerleşik araç çağrıları için geçerlidir. Model tarafından bir aracı çağırmaya yönelik diğer girişimler yoksayılır.	Hayı
└─ meta veriler	nesne	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Hayı
└─ modeli	String	Bu yanıtın oluşturulması için kullanılacak model dağıtımı.	Hayı
└─ nesne	enum	Bu kaynağın nesne türü - her zaman response olarak ayarlanır. Olası değerler: response	Hayı
└─ çıkış	dizi	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.	Hayı
└─ çıktı_metin	String	Toplanan metin çıkışını içeren yalnızca SDK kolaylık özelliği Dizideki output_text öğelerin tümünden, eğer varsa. Python ve JavaScript SDK'larında desteklenir.	Hayı
└─ paralel_arac_cagrilari	Boolean	Modelin araç çağrılarını paralel olarak çalıştırmasına izin verilip verilmeyeceği.	Hayı	Doğru
└─ önceki_cevap_id	String	Modele önceki yanıtın benzersiz kimliği. Bunu şunu yapmak için kullanın: çok aşamalı konuşmalar oluşturun. Hakkında daha fazla bilgi edinin konuşma durumunu yönetme.	Hayı
└─ istemi	OpenAI.Prompt	bir istem şablonuna ve değişkenlerine başvuru. Daha fazla bilgi edinin.	Hayı
└─ akıl yürütme	OpenAI.Reasoning	yalnızca o serisi modeller Mantık modelleri için yapılandırma seçenekleri.	Hayı
└─ service_tier	OpenAI.ServiceTier	Not: service_tier Azure OpenAI için geçerli değildir.	Hayı
└─ durumu	enum	Yanıt oluşturma durumu. , , completed' lerden failedbiri in_progress, cancelled, queued veya incomplete. Olası değerler: completed, failed, in_progress, cancelled, , queued, incomplete	Hayı
└─ structured_inputs	nesne	Yanıta, istem şablonu değiştirme veya araç bağımsız değişkeni bağlamalarına katılabilen yapılandırılmış girişler.	Hayı
└─ sıcaklık	Numara	0 ile 2 arasında hangi örnekleme sıcaklığının kullanılacağı. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir. Genellikle bunu değiştirmenizi öneririz top_p ancak ikisini birden değiştirmemenizi öneririz.	Hayı
└─ metin	nesne	Modelden metin yanıtı için yapılandırma seçenekleri. Düz olabilir metin veya yapılandırılmış JSON verileri. Bkz . Metin girişleri ve çıkışları ve Yapılandırılmış Çıkışlar	Hayı
└─ biçimi	OpenAI.ResponseTextFormatConfiguration		Hayı
└─ araç seçimi	OpenAI.ToolChoiceOptions veya OpenAI.ToolChoiceObject	Model, oluştururken kullanılacak aracı (veya araçları) nasıl seçmelidir? bir cevap tools Hangi araçların nasıl belirtileceğini görmek için parametresine bakın modeli çağırabilir.	Hayı
└─ araçları	dizi	Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Siz parametresini ayarlayarak tool_choice hangi aracın kullanılacağını belirtebilir. Modeli sağlayabileceğiniz iki araç kategorisi şunlardır: * Yerleşik araçlar: OpenAI tarafından sağlanan ve işlevselliği genişleten araçlar modelin web araması gibi özellikleri veya dosya arama. Hakkında daha fazla bilgi edinin yerleşik araçlar. * İşlev çağrıları (özel araçlar): Sizin tanımladığınız işlevler, Modelin kendi yazdığınız kodu çağırmasını sağlama. Hakkında daha fazla bilgi edinin işlev çağrısı.	Hayı
└─ top_logprobs	tamsayı	Her biri ilişkili günlük olasılığına sahip her belirteç konumunda döndürülecek en olası belirteç sayısını belirten 0 ile 20 arasında bir tamsayı.	Hayı
└─ top_p	Numara	Sıcaklıkla örneklemeye alternatif olarak çekirdek örneklemesi adı verilir, burada model, belirteçlerin sonuçlarını top_p olasılıkla değerlendirir kütle. Yani 0,1 yalnızca ilk 10% olasılık kütlesini oluşturan belirteçler anlamına gelir dikkate alınır. Genellikle bunu değiştirmenizi öneririz temperature ancak ikisini birden değiştirmemenizi öneririz.	Hayı
└─ kısaltma	enum	Model yanıtı için kullanılacak kesme stratejisi. - auto: Bu yanıtın bağlamı ve önceki yanıtlar aşarsa modelin bağlam penceresi boyutu, modelin yanıtı bağlam penceresine uydurmak için giriş öğelerini düşürerek konuşmanın ortasında. - disabled (varsayılan): Model yanıtı bağlam penceresini aşarsa Bir model için boyut yanlış girilirse, istek 400 hatasıyla başarısız olur. Olası değerler: auto, disabled	Hayı
└─ kullanımı	OpenAI.ResponseUsage	Giriş belirteçleri, çıkış belirteçleri dahil olmak üzere belirteç kullanım ayrıntılarını temsil eder. çıkış belirteçlerinin ve kullanılan toplam belirteçlerin dökümü.	Hayı
└─ kullanıcı	String	En iyi güvenlik uygulamaları hakkında daha fazla bilgi edinin.	Hayı
type	enum	Olayın türü. Her zaman response.failed. Olası değerler: response.failed	Evet

OpenAI.ResponseFileSearchCallCompletedEvent

Bir dosya arama çağrısı tamamlandığında (sonuçlar bulundu) yayılır.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	Dosya arama çağrısının başlatıldığı çıkış öğesinin kimliği.	Evet
output_index	tamsayı	Dosya arama çağrısının başlatıldığı çıkış öğesinin dizini.	Evet
type	enum	Olayın türü. Her zaman response.file_search_call.completed. Olası değerler: response.file_search_call.completed	Evet

OpenAI.ResponseFileSearchCallInProgressEvent

Bir dosya arama çağrısı başlatıldığında gönderilir.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	Dosya arama çağrısının başlatıldığı çıkış öğesinin kimliği.	Evet
output_index	tamsayı	Dosya arama çağrısının başlatıldığı çıkış öğesinin dizini.	Evet
type	enum	Olayın türü. Her zaman response.file_search_call.in_progress. Olası değerler: response.file_search_call.in_progress	Evet

OpenAI.ResponseFileSearchCallSearchingEvent

Bir dosya araması sırasında arama yapıldığında tetiklenir.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	Dosya arama çağrısının başlatıldığı çıkış öğesinin kimliği.	Evet
output_index	tamsayı	Dosya arama çağrısının arama yaptığı çıkış öğesinin dizini.	Evet
type	enum	Olayın türü. Her zaman response.file_search_call.searching. Olası değerler: response.file_search_call.searching	Evet

OpenAI.ResponseFormat

OpenAI.ResponseFormat için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
json_object	OpenAI.ResponseFormatJsonObject
json_schema	OpenAI.ResponseFormatJsonSchema

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olası değerler: text, json_object, json_schema	Evet

OpenAI.ResponseFormatJsonObject

JSON nesne yanıt biçimi. JSON yanıtları oluşturmanın eski bir yöntemi. Bunu destekleyen modeller için kullanılması json_schema önerilir. Modelin bir sistem veya kullanıcı iletisi olmadan JSON oluşturmayacağını unutmayın.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Tanımlanan yanıt biçiminin türü. Her zaman json_object. Olası değerler: json_object	Evet

OpenAI.ResponseFormatJsonSchema

JSON Şeması nesnesi olarak tanımlanan yanıt biçimi şeması. JSON şemaları oluşturmayı buradan öğrenin. JSON Şeması yanıt biçimi. Yapılandırılmış JSON yanıtları oluşturmak için kullanılır. Yapılandırılmış Çıkışlar hakkında daha fazla bilgi edinin.

İsim	Türü	Description	Gerekli	Varsayılan
json şeması	nesne	Bir JSON Şeması da dahil olmak üzere Yapılandırılmış Çıkışlar yapılandırma seçenekleri.	Evet
└─ açıklama	String	Model tarafından kullanılan yanıt biçiminin ne için olduğuna dair bir açıklama. Yanıt formatını nasıl belirleyeceğinizi öğrenin.	Hayı
└─ ad	String	Yanıt biçiminin adı. a-z, A-Z, 0-9 veya bunları içermelidir alt çizgi ve tirelerden oluşan, maksimum uzunluk 64 karakterdir.	Hayı
└─ şeması	nesne		Hayı
└─ katı	Boolean	Çıktı oluşturulurken sıkı şemaya bağlı kalınmasının etkinleştirilip etkinleştirilmeyileceği. True olarak ayarlanırsa, model her zaman tam olarak tanımlanan şemayı izler schema alanında. JSON Şemasının yalnızca bir alt kümesi desteklendiğinde strict, true'e eşittir. Daha fazla bilgi edinmek için Yapılandırılmış Çıkışlar'ı okuyun kılavuzuna bakın.	Hayı	Yanlış
type	enum	Tanımlanan yanıt biçiminin türü. Her zaman json_schema. Olası değerler: json_schema	Evet

OpenAI.ResponseFormatText

Varsayılan yanıt biçimi. Metin yanıtları oluşturmak için kullanılır.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Tanımlanan yanıt biçiminin türü. Her zaman text. Olası değerler: text	Evet

OpenAI.ResponseFunctionCallArgumentsDeltaEvent

Kısmi işlev çağrısı bağımsız değişkenleri delta olduğunda yayılır.

İsim	Türü	Description	Gerekli	Varsayılan
delta	String	Fonksiyon çağrısı argümanlarına eklenen delta.	Evet
item_id	String	delta işlev çağrısı bağımsız değişkenlerinin eklendiği çıkış öğesinin kimliği.	Evet
output_index	tamsayı	İşlev çağrısı bağımsız değişkenlerinin delta'sının toplandığı çıkış öğesinin dizini.	Evet
type	enum	Olayın türü. Her zaman response.function_call_arguments.delta. Olası değerler: response.function_call_arguments.delta	Evet

OpenAI.ResponseFunctionCallArgumentsDoneEvent

İşlev çağrısı bağımsız değişkenleri sonlandırıldığında verilir.

İsim	Türü	Description	Gerekli	Varsayılan
arguments	String	İşlev çağrısı için argümanlar.	Evet
item_id	String	Öğenin kimliği.	Evet
output_index	tamsayı	Çıkış öğesinin dizini.	Evet
type	enum	Olası değerler: response.function_call_arguments.done	Evet

OpenAI.ResponseImageGenCallCompletedEvent

Görüntü oluşturma aracı çağrısı tamamlandığında ve son görüntü kullanılabilir olduğunda yayılır.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	İşlenmekte olan görüntü oluşturma öğesinin benzersiz tanımlayıcısı.	Evet
output_index	tamsayı	Yanıtın çıkış dizisindeki çıkış öğesinin dizini.	Evet
type	enum	Olayın türü. Her zaman 'response.image_generation_call.completed' şeklinde. Olası değerler: response.image_generation_call.completed	Evet

OpenAI.ResponseImageGenCallGeneratingEvent

Görüntü oluşturma aracı çağrısı (ara durum) etkin bir şekilde görüntü oluştururken tetiklenir.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	İşlenmekte olan görüntü oluşturma öğesinin benzersiz tanımlayıcısı.	Evet
output_index	tamsayı	Yanıtın çıkış dizisindeki çıkış öğesinin dizini.	Evet
type	enum	Olayın türü. Her zaman 'response.image_generation_call.generating'. Olası değerler: response.image_generation_call.generating	Evet

OpenAI.ResponseImageGenCallInProgressEvent

Görüntü oluşturma aracı çağrısı devam ederken bir bildirim gönderilir.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	İşlenmekte olan görüntü oluşturma öğesinin benzersiz tanımlayıcısı.	Evet
output_index	tamsayı	Yanıtın çıkış dizisindeki çıkış öğesinin dizini.	Evet
type	enum	Olayın türü. Her zaman 'response.image_generation_call.in_progress'. Olası değerler: response.image_generation_call.in_progress	Evet

OpenAI.ResponseImageGenCallPartialImageEvent

Görüntü oluşturma akışı sırasında kısmi bir görüntü kullanılabilir olduğunda emit edilir.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	İşlenmekte olan görüntü oluşturma öğesinin benzersiz tanımlayıcısı.	Evet
output_index	tamsayı	Yanıtın çıkış dizisindeki çıkış öğesinin dizini.	Evet
partial_image_b64	String	Base64 ile kodlanmış kısmi görüntü verileri, görüntü olarak işleme için uygundur.	Evet
partial_image_index	tamsayı	Kısmi görüntü için 0 tabanlı dizin (arka uç 1 tabanlıdır, ancak bu kullanıcı için 0 tabanlıdır).	Evet
type	enum	Olayın türü. Her zaman 'response.image_generation_call.partial_image'. Olası değerler: response.image_generation_call.partial_image	Evet

OpenAI.ResponseInProgressEvent

Yanıt devam ederken gönderilir.

İsim	Türü	Description	Gerekli	Varsayılan
yanıt	nesne		Evet
└─ aracısı	AgentId	Bu yanıt için kullanılan aracı	Hayı
└─ arka plan	Boolean	Model yanıtının arka planda çalıştırılıp çalıştırılmayacağı. Arka plan yanıtları hakkında daha fazla bilgi edinin.	Hayı	Yanlış
└─ konuşma	nesne		Hayı
└─ kimlik	String		Hayı
└─ oluşturulma_tarihi	tamsayı	Bu Yanıtın oluşturulduğu unix zaman damgası (saniye).	Hayı
└─ hata	OpenAI.ResponseError	Model yanıt oluşturamadığında döndürülen bir hata nesnesi.	Hayı
└─ kimlik	String	Bu Yanıt için benzersiz tanımlayıcı.	Hayı
└─ eksik_bilgiler	nesne	Yanıtın neden eksik olduğuna ilişkin ayrıntılar.	Hayı
└─ neden	enum	Yanıtın tamamlanmamış olmasının nedeni. Olası değerler: max_output_tokens, content_filter	Hayı
└─ yönerge	dize veya dizi	Modelin bağlamı içine eklenen bir sistem (veya geliştirici) iletisi. previous_response_id ile birlikte kullanırken, önceki yönergelerden gelen talimatlar yanıt bir sonraki yanıta aktarılmaz. Bu, basit olmasını sağlar yeni yanıtlarda sistem (veya geliştirici) iletilerini değiştirmek için.	Hayı
└─ maksimum_çıkış_jetonları	tamsayı	Görünür çıkış belirteçleri ve muhakeme belirteçleri de dahil olmak üzere yanıt için oluşturulabilecek belirteç sayısı için üst sınır.	Hayı
└─ maksimum araç çağrıları	tamsayı	Bir yanıtta işlenebilen yerleşik araçlara yapılan toplam çağrı sayısı üst sınırı. Bu maksimum sayı, tek tek araç başına değil, tüm yerleşik araç çağrıları için geçerlidir. Model tarafından bir aracı çağırmaya yönelik diğer girişimler yoksayılır.	Hayı
└─ meta veriler	nesne	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Hayı
└─ modeli	String	Bu yanıtın oluşturulması için kullanılacak model dağıtımı.	Hayı
└─ nesne	enum	Bu kaynağın nesne türü - her zaman response olarak ayarlanır. Olası değerler: response	Hayı
└─ çıkış	dizi	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.	Hayı
└─ çıktı_metin	String	Toplanan metin çıkışını içeren yalnızca SDK kolaylık özelliği Dizideki output_text öğelerin tümünden, eğer varsa. Python ve JavaScript SDK'larında desteklenir.	Hayı
└─ paralel_arac_cagrilari	Boolean	Modelin araç çağrılarını paralel olarak çalıştırmasına izin verilip verilmeyeceği.	Hayı	Doğru
└─ önceki_cevap_id	String	Modele önceki yanıtın benzersiz kimliği. Bunu şunu yapmak için kullanın: çok aşamalı konuşmalar oluşturun. Hakkında daha fazla bilgi edinin konuşma durumunu yönetme.	Hayı
└─ istemi	OpenAI.Prompt	bir istem şablonuna ve değişkenlerine başvuru. Daha fazla bilgi edinin.	Hayı
└─ akıl yürütme	OpenAI.Reasoning	yalnızca o serisi modeller Mantık modelleri için yapılandırma seçenekleri.	Hayı
└─ service_tier	OpenAI.ServiceTier	Not: service_tier Azure OpenAI için geçerli değildir.	Hayı
└─ durumu	enum	Yanıt oluşturma durumu. , , completed' lerden failedbiri in_progress, cancelled, queued veya incomplete. Olası değerler: completed, failed, in_progress, cancelled, , queued, incomplete	Hayı
└─ structured_inputs	nesne	Yanıta, istem şablonu değiştirme veya araç bağımsız değişkeni bağlamalarına katılabilen yapılandırılmış girişler.	Hayı
└─ sıcaklık	Numara	0 ile 2 arasında hangi örnekleme sıcaklığının kullanılacağı. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir. Genellikle bunu değiştirmenizi öneririz top_p ancak ikisini birden değiştirmemenizi öneririz.	Hayı
└─ metin	nesne	Modelden metin yanıtı için yapılandırma seçenekleri. Düz olabilir metin veya yapılandırılmış JSON verileri. Bkz . Metin girişleri ve çıkışları ve Yapılandırılmış Çıkışlar	Hayı
└─ biçimi	OpenAI.ResponseTextFormatConfiguration		Hayı
└─ araç seçimi	OpenAI.ToolChoiceOptions veya OpenAI.ToolChoiceObject	Model, oluştururken kullanılacak aracı (veya araçları) nasıl seçmelidir? bir cevap tools Hangi araçların nasıl belirtileceğini görmek için parametresine bakın modeli çağırabilir.	Hayı
└─ araçları	dizi	Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Siz parametresini ayarlayarak tool_choice hangi aracın kullanılacağını belirtebilir. Modeli sağlayabileceğiniz iki araç kategorisi şunlardır: * Yerleşik araçlar: OpenAI tarafından sağlanan ve işlevselliği genişleten araçlar modelin web araması gibi özellikleri veya dosya arama. Hakkında daha fazla bilgi edinin yerleşik araçlar. * İşlev çağrıları (özel araçlar): Sizin tanımladığınız işlevler, Modelin kendi yazdığınız kodu çağırmasını sağlama. Hakkında daha fazla bilgi edinin işlev çağrısı.	Hayı
└─ top_logprobs	tamsayı	Her biri ilişkili günlük olasılığına sahip her belirteç konumunda döndürülecek en olası belirteç sayısını belirten 0 ile 20 arasında bir tamsayı.	Hayı
└─ top_p	Numara	Sıcaklıkla örneklemeye alternatif olarak çekirdek örneklemesi adı verilir, burada model, belirteçlerin sonuçlarını top_p olasılıkla değerlendirir kütle. Yani 0,1 yalnızca ilk 10% olasılık kütlesini oluşturan belirteçler anlamına gelir dikkate alınır. Genellikle bunu değiştirmenizi öneririz temperature ancak ikisini birden değiştirmemenizi öneririz.	Hayı
└─ kısaltma	enum	Model yanıtı için kullanılacak kesme stratejisi. - auto: Bu yanıtın bağlamı ve önceki yanıtlar aşarsa modelin bağlam penceresi boyutu, modelin yanıtı bağlam penceresine uydurmak için giriş öğelerini düşürerek konuşmanın ortasında. - disabled (varsayılan): Model yanıtı bağlam penceresini aşarsa Bir model için boyut yanlış girilirse, istek 400 hatasıyla başarısız olur. Olası değerler: auto, disabled	Hayı
└─ kullanımı	OpenAI.ResponseUsage	Giriş belirteçleri, çıkış belirteçleri dahil olmak üzere belirteç kullanım ayrıntılarını temsil eder. çıkış belirteçlerinin ve kullanılan toplam belirteçlerin dökümü.	Hayı
└─ kullanıcı	String	En iyi güvenlik uygulamaları hakkında daha fazla bilgi edinin.	Hayı
type	enum	Olayın türü. Her zaman response.in_progress. Olası değerler: response.in_progress	Evet

OpenAI.ResponseIncompleteEvent

Yanıt eksik olduğunda yayılan bir olay.

İsim	Türü	Description	Gerekli	Varsayılan
yanıt	nesne		Evet
└─ aracısı	AgentId	Bu yanıt için kullanılan aracı	Hayı
└─ arka plan	Boolean	Model yanıtının arka planda çalıştırılıp çalıştırılmayacağı. Arka plan yanıtları hakkında daha fazla bilgi edinin.	Hayı	Yanlış
└─ konuşma	nesne		Hayı
└─ kimlik	String		Hayı
└─ oluşturulma_tarihi	tamsayı	Bu Yanıtın oluşturulduğu unix zaman damgası (saniye).	Hayı
└─ hata	OpenAI.ResponseError	Model yanıt oluşturamadığında döndürülen bir hata nesnesi.	Hayı
└─ kimlik	String	Bu Yanıt için benzersiz tanımlayıcı.	Hayı
└─ eksik_bilgiler	nesne	Yanıtın neden eksik olduğuna ilişkin ayrıntılar.	Hayı
└─ neden	enum	Yanıtın tamamlanmamış olmasının nedeni. Olası değerler: max_output_tokens, content_filter	Hayı
└─ yönerge	dize veya dizi	Modelin bağlamı içine eklenen bir sistem (veya geliştirici) iletisi. previous_response_id ile birlikte kullanırken, önceki yönergelerden gelen talimatlar yanıt bir sonraki yanıta aktarılmaz. Bu, basit olmasını sağlar yeni yanıtlarda sistem (veya geliştirici) iletilerini değiştirmek için.	Hayı
└─ maksimum_çıkış_jetonları	tamsayı	Görünür çıkış belirteçleri ve muhakeme belirteçleri de dahil olmak üzere yanıt için oluşturulabilecek belirteç sayısı için üst sınır.	Hayı
└─ maksimum araç çağrıları	tamsayı	Bir yanıtta işlenebilen yerleşik araçlara yapılan toplam çağrı sayısı üst sınırı. Bu maksimum sayı, tek tek araç başına değil, tüm yerleşik araç çağrıları için geçerlidir. Model tarafından bir aracı çağırmaya yönelik diğer girişimler yoksayılır.	Hayı
└─ meta veriler	nesne	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Hayı
└─ modeli	String	Bu yanıtın oluşturulması için kullanılacak model dağıtımı.	Hayı
└─ nesne	enum	Bu kaynağın nesne türü - her zaman response olarak ayarlanır. Olası değerler: response	Hayı
└─ çıkış	dizi	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.	Hayı
└─ çıktı_metin	String	Toplanan metin çıkışını içeren yalnızca SDK kolaylık özelliği Dizideki output_text öğelerin tümünden, eğer varsa. Python ve JavaScript SDK'larında desteklenir.	Hayı
└─ paralel_arac_cagrilari	Boolean	Modelin araç çağrılarını paralel olarak çalıştırmasına izin verilip verilmeyeceği.	Hayı	Doğru
└─ önceki_cevap_id	String	Modele önceki yanıtın benzersiz kimliği. Bunu şunu yapmak için kullanın: çok aşamalı konuşmalar oluşturun. Hakkında daha fazla bilgi edinin konuşma durumunu yönetme.	Hayı
└─ istemi	OpenAI.Prompt	bir istem şablonuna ve değişkenlerine başvuru. Daha fazla bilgi edinin.	Hayı
└─ akıl yürütme	OpenAI.Reasoning	yalnızca o serisi modeller Mantık modelleri için yapılandırma seçenekleri.	Hayı
└─ service_tier	OpenAI.ServiceTier	Not: service_tier Azure OpenAI için geçerli değildir.	Hayı
└─ durumu	enum	Yanıt oluşturma durumu. , , completed' lerden failedbiri in_progress, cancelled, queued veya incomplete. Olası değerler: completed, failed, in_progress, cancelled, , queued, incomplete	Hayı
└─ structured_inputs	nesne	Yanıta, istem şablonu değiştirme veya araç bağımsız değişkeni bağlamalarına katılabilen yapılandırılmış girişler.	Hayı
└─ sıcaklık	Numara	0 ile 2 arasında hangi örnekleme sıcaklığının kullanılacağı. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir. Genellikle bunu değiştirmenizi öneririz top_p ancak ikisini birden değiştirmemenizi öneririz.	Hayı
└─ metin	nesne	Modelden metin yanıtı için yapılandırma seçenekleri. Düz olabilir metin veya yapılandırılmış JSON verileri. Bkz . Metin girişleri ve çıkışları ve Yapılandırılmış Çıkışlar	Hayı
└─ biçimi	OpenAI.ResponseTextFormatConfiguration		Hayı
└─ araç seçimi	OpenAI.ToolChoiceOptions veya OpenAI.ToolChoiceObject	Model, oluştururken kullanılacak aracı (veya araçları) nasıl seçmelidir? bir cevap tools Hangi araçların nasıl belirtileceğini görmek için parametresine bakın modeli çağırabilir.	Hayı
└─ araçları	dizi	Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Siz parametresini ayarlayarak tool_choice hangi aracın kullanılacağını belirtebilir. Modeli sağlayabileceğiniz iki araç kategorisi şunlardır: * Yerleşik araçlar: OpenAI tarafından sağlanan ve işlevselliği genişleten araçlar modelin web araması gibi özellikleri veya dosya arama. Hakkında daha fazla bilgi edinin yerleşik araçlar. * İşlev çağrıları (özel araçlar): Sizin tanımladığınız işlevler, Modelin kendi yazdığınız kodu çağırmasını sağlama. Hakkında daha fazla bilgi edinin işlev çağrısı.	Hayı
└─ top_logprobs	tamsayı	Her biri ilişkili günlük olasılığına sahip her belirteç konumunda döndürülecek en olası belirteç sayısını belirten 0 ile 20 arasında bir tamsayı.	Hayı
└─ top_p	Numara	Sıcaklıkla örneklemeye alternatif olarak çekirdek örneklemesi adı verilir, burada model, belirteçlerin sonuçlarını top_p olasılıkla değerlendirir kütle. Yani 0,1 yalnızca ilk 10% olasılık kütlesini oluşturan belirteçler anlamına gelir dikkate alınır. Genellikle bunu değiştirmenizi öneririz temperature ancak ikisini birden değiştirmemenizi öneririz.	Hayı
└─ kısaltma	enum	Model yanıtı için kullanılacak kesme stratejisi. - auto: Bu yanıtın bağlamı ve önceki yanıtlar aşarsa modelin bağlam penceresi boyutu, modelin yanıtı bağlam penceresine uydurmak için giriş öğelerini düşürerek konuşmanın ortasında. - disabled (varsayılan): Model yanıtı bağlam penceresini aşarsa Bir model için boyut yanlış girilirse, istek 400 hatasıyla başarısız olur. Olası değerler: auto, disabled	Hayı
└─ kullanımı	OpenAI.ResponseUsage	Giriş belirteçleri, çıkış belirteçleri dahil olmak üzere belirteç kullanım ayrıntılarını temsil eder. çıkış belirteçlerinin ve kullanılan toplam belirteçlerin dökümü.	Hayı
└─ kullanıcı	String	En iyi güvenlik uygulamaları hakkında daha fazla bilgi edinin.	Hayı
type	enum	Olayın türü. Her zaman response.incomplete. Olası değerler: response.incomplete	Evet

OpenAI.ResponseMCPCallArgumentsDeltaEvent

MCP araç çağrısının bağımsız değişkenlerinde delta (kısmi güncelleştirme) olduğunda gerçekleşir.

İsim	Türü	Description	Gerekli	Varsayılan
delta		MCP aracı çağrısı için bağımsız değişkenlerin kısmî güncelleştirmesi.	Evet
item_id	String	İşlenen MCP aracı çağrı öğesinin benzersiz tanımlayıcısı.	Evet
output_index	tamsayı	Yanıtın çıkış dizisindeki çıkış öğesinin dizini.	Evet
type	enum	Olayın türü. Her zaman 'response.mcp_call.arguments_delta'. Olası değerler: response.mcp_call.arguments_delta	Evet

OpenAI.ResponseMCPCallArgumentsDoneEvent

Bir MCP araç çağrısı için bağımsız değişkenler sonlandırıldığında oluşur.

İsim	Türü	Description	Gerekli	Varsayılan
arguments		MCP araç çağrısı için son haline getirilmiş bağımsız değişkenler.	Evet
item_id	String	İşlenen MCP aracı çağrı öğesinin benzersiz tanımlayıcısı.	Evet
output_index	tamsayı	Yanıtın çıkış dizisindeki çıkış öğesinin dizini.	Evet
type	enum	Olayın türü. Her zaman 'response.mcp_call.arguments_done'. Olası değerler: response.mcp_call.arguments_done	Evet

OpenAI.ResponseMCPCallCompletedEvent

BIR MCP araç çağrısı başarıyla tamamlandığında yayılır.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olayın türü. Her zaman 'response.mcp_call.completed'. Olası değerler: response.mcp_call.completed	Evet

OpenAI.ResponseMCPCallFailedEvent

Bir MCP aracı çağrısının başarısız olması durumunda yayımlanır.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olayın türü. 'sonuç her zaman 'response.mcp_call.failed' olur. Olası değerler: response.mcp_call.failed	Evet

OpenAI.ResponseMCPCallInProgressEvent

Bir MCP araç çağrısı devam ederken tetiklenir.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	İşlenen MCP aracı çağrı öğesinin benzersiz tanımlayıcısı.	Evet
output_index	tamsayı	Yanıtın çıkış dizisindeki çıkış öğesinin dizini.	Evet
type	enum	Olayın türü. Her zaman 'response.mcp_call.in_progress'. Olası değerler: response.mcp_call.in_progress	Evet

OpenAI.ResponseMCPListToolsCompletedEvent

Kullanılabilir MCP araçlarının listesi başarıyla alındığında tetiklenir.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olayın türü. Her zaman 'response.mcp_list_tools.completed'. Olası değerler: response.mcp_list_tools.completed	Evet

OpenAI.ResponseMCPListToolsFailedEvent

Kullanılabilir MCP araçlarını listeleme girişimi başarısız olduğunda ortaya çıkar.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olayın türü. Her zaman 'response.mcp_list_tools.başarısız'. Olası değerler: response.mcp_list_tools.failed	Evet

OpenAI.ResponseMCPListToolsInProgressEvent

Sistem, kullanılabilir MCP araçlarının listesini alırken tetiklenir.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olayın türü. Her zaman 'response.mcp_list_tools.in_progress'. Olası değerler: response.mcp_list_tools.in_progress	Evet

OpenAI.ResponseOutputItemAddedEvent

Yeni bir çıkış öğesi eklendiğinde gönderilir.

İsim	Türü	Description	Gerekli	Varsayılan
öğe	nesne	Yanıt oluşturmak için kullanılan içerik öğesi.	Evet
└─ created_by	Oluşturan	Öğenin oluşturucusu hakkındaki bilgiler	Hayı
└─ kimlik	String		Hayı
└─ türü	OpenAI.ItemType		Hayı
output_index	tamsayı	Eklenen çıkış öğesinin dizini.	Evet
type	enum	Olayın türü. Her zaman response.output_item.added. Olası değerler: response.output_item.added	Evet

OpenAI.ResponseOutputItemDoneEvent

Çıktı öğesi tamamlandı olarak işaretlendiğinde yayılır.

İsim	Türü	Description	Gerekli	Varsayılan
öğe	nesne	Yanıt oluşturmak için kullanılan içerik öğesi.	Evet
└─ created_by	Oluşturan	Öğenin oluşturucusu hakkındaki bilgiler	Hayı
└─ kimlik	String		Hayı
└─ türü	OpenAI.ItemType		Hayı
output_index	tamsayı	Bitti olarak işaretlenen çıkış öğesinin dizini.	Evet
type	enum	Olayın türü. Her zaman response.output_item.done. Olası değerler: response.output_item.done	Evet

OpenAI.ResponsePromptVariables

İsteminizde değişkenlerin yerine kullanılacak isteğe bağlı değer eşlemesi. Değiştirme değerleri dizeler veya görüntüler veya dosyalar gibi diğer Yanıt giriş türleri olabilir.

Tür: nesne

OpenAI.ResponseQueuedEvent

Bir yanıt kuyruğa alınıp işlenmeyi beklediğinde gönderilir.

İsim	Türü	Description	Gerekli	Varsayılan
yanıt	nesne		Evet
└─ aracısı	AgentId	Bu yanıt için kullanılan aracı	Hayı
└─ arka plan	Boolean	Model yanıtının arka planda çalıştırılıp çalıştırılmayacağı. Arka plan yanıtları hakkında daha fazla bilgi edinin.	Hayı	Yanlış
└─ konuşma	nesne		Hayı
└─ kimlik	String		Hayı
└─ oluşturulma_tarihi	tamsayı	Bu Yanıtın oluşturulduğu unix zaman damgası (saniye).	Hayı
└─ hata	OpenAI.ResponseError	Model yanıt oluşturamadığında döndürülen bir hata nesnesi.	Hayı
└─ kimlik	String	Bu Yanıt için benzersiz tanımlayıcı.	Hayı
└─ eksik_bilgiler	nesne	Yanıtın neden eksik olduğuna ilişkin ayrıntılar.	Hayı
└─ neden	enum	Yanıtın tamamlanmamış olmasının nedeni. Olası değerler: max_output_tokens, content_filter	Hayı
└─ yönerge	dize veya dizi	Modelin bağlamı içine eklenen bir sistem (veya geliştirici) iletisi. previous_response_id ile birlikte kullanırken, önceki yönergelerden gelen talimatlar yanıt bir sonraki yanıta aktarılmaz. Bu, basit olmasını sağlar yeni yanıtlarda sistem (veya geliştirici) iletilerini değiştirmek için.	Hayı
└─ maksimum_çıkış_jetonları	tamsayı	Görünür çıkış belirteçleri ve muhakeme belirteçleri de dahil olmak üzere yanıt için oluşturulabilecek belirteç sayısı için üst sınır.	Hayı
└─ maksimum araç çağrıları	tamsayı	Bir yanıtta işlenebilen yerleşik araçlara yapılan toplam çağrı sayısı üst sınırı. Bu maksimum sayı, tek tek araç başına değil, tüm yerleşik araç çağrıları için geçerlidir. Model tarafından bir aracı çağırmaya yönelik diğer girişimler yoksayılır.	Hayı
└─ meta veriler	nesne	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Hayı
└─ modeli	String	Bu yanıtın oluşturulması için kullanılacak model dağıtımı.	Hayı
└─ nesne	enum	Bu kaynağın nesne türü - her zaman response olarak ayarlanır. Olası değerler: response	Hayı
└─ çıkış	dizi	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.	Hayı
└─ çıktı_metin	String	Toplanan metin çıkışını içeren yalnızca SDK kolaylık özelliği Dizideki output_text öğelerin tümünden, eğer varsa. Python ve JavaScript SDK'larında desteklenir.	Hayı
└─ paralel_arac_cagrilari	Boolean	Modelin araç çağrılarını paralel olarak çalıştırmasına izin verilip verilmeyeceği.	Hayı	Doğru
└─ önceki_cevap_id	String	Modele önceki yanıtın benzersiz kimliği. Bunu şunu yapmak için kullanın: çok aşamalı konuşmalar oluşturun. Hakkında daha fazla bilgi edinin konuşma durumunu yönetme.	Hayı
└─ istemi	OpenAI.Prompt	bir istem şablonuna ve değişkenlerine başvuru. Daha fazla bilgi edinin.	Hayı
└─ akıl yürütme	OpenAI.Reasoning	yalnızca o serisi modeller Mantık modelleri için yapılandırma seçenekleri.	Hayı
└─ service_tier	OpenAI.ServiceTier	Not: service_tier Azure OpenAI için geçerli değildir.	Hayı
└─ durumu	enum	Yanıt oluşturma durumu. , , completed' lerden failedbiri in_progress, cancelled, queued veya incomplete. Olası değerler: completed, failed, in_progress, cancelled, , queued, incomplete	Hayı
└─ structured_inputs	nesne	Yanıta, istem şablonu değiştirme veya araç bağımsız değişkeni bağlamalarına katılabilen yapılandırılmış girişler.	Hayı
└─ sıcaklık	Numara	0 ile 2 arasında hangi örnekleme sıcaklığının kullanılacağı. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir. Genellikle bunu değiştirmenizi öneririz top_p ancak ikisini birden değiştirmemenizi öneririz.	Hayı
└─ metin	nesne	Modelden metin yanıtı için yapılandırma seçenekleri. Düz olabilir metin veya yapılandırılmış JSON verileri. Bkz . Metin girişleri ve çıkışları ve Yapılandırılmış Çıkışlar	Hayı
└─ biçimi	OpenAI.ResponseTextFormatConfiguration		Hayı
└─ araç seçimi	OpenAI.ToolChoiceOptions veya OpenAI.ToolChoiceObject	Model, oluştururken kullanılacak aracı (veya araçları) nasıl seçmelidir? bir cevap tools Hangi araçların nasıl belirtileceğini görmek için parametresine bakın modeli çağırabilir.	Hayı
└─ araçları	dizi	Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Siz parametresini ayarlayarak tool_choice hangi aracın kullanılacağını belirtebilir. Modeli sağlayabileceğiniz iki araç kategorisi şunlardır: * Yerleşik araçlar: OpenAI tarafından sağlanan ve işlevselliği genişleten araçlar modelin web araması gibi özellikleri veya dosya arama. Hakkında daha fazla bilgi edinin yerleşik araçlar. * İşlev çağrıları (özel araçlar): Sizin tanımladığınız işlevler, Modelin kendi yazdığınız kodu çağırmasını sağlama. Hakkında daha fazla bilgi edinin işlev çağrısı.	Hayı
└─ top_logprobs	tamsayı	Her biri ilişkili günlük olasılığına sahip her belirteç konumunda döndürülecek en olası belirteç sayısını belirten 0 ile 20 arasında bir tamsayı.	Hayı
└─ top_p	Numara	Sıcaklıkla örneklemeye alternatif olarak çekirdek örneklemesi adı verilir, burada model, belirteçlerin sonuçlarını top_p olasılıkla değerlendirir kütle. Yani 0,1 yalnızca ilk 10% olasılık kütlesini oluşturan belirteçler anlamına gelir dikkate alınır. Genellikle bunu değiştirmenizi öneririz temperature ancak ikisini birden değiştirmemenizi öneririz.	Hayı
└─ kısaltma	enum	Model yanıtı için kullanılacak kesme stratejisi. - auto: Bu yanıtın bağlamı ve önceki yanıtlar aşarsa modelin bağlam penceresi boyutu, modelin yanıtı bağlam penceresine uydurmak için giriş öğelerini düşürerek konuşmanın ortasında. - disabled (varsayılan): Model yanıtı bağlam penceresini aşarsa Bir model için boyut yanlış girilirse, istek 400 hatasıyla başarısız olur. Olası değerler: auto, disabled	Hayı
└─ kullanımı	OpenAI.ResponseUsage	Giriş belirteçleri, çıkış belirteçleri dahil olmak üzere belirteç kullanım ayrıntılarını temsil eder. çıkış belirteçlerinin ve kullanılan toplam belirteçlerin dökümü.	Hayı
└─ kullanıcı	String	En iyi güvenlik uygulamaları hakkında daha fazla bilgi edinin.	Hayı
type	enum	Olayın türü. Her zaman 'response.queued'. Olası değerler: response.queued	Evet

OpenAI.ResponseReasoningDeltaEvent

Muhakeme içeriğinde bir değişiklik (kısmi güncelleme) olduğunda sinyal yayılır.

İsim	Türü	Description	Gerekli	Varsayılan
content_index	tamsayı	Çıkış öğesi içindeki akıl yürütme içeriği bölümünün dizini.	Evet
delta		Gerekçe içeriğinin kısmi güncelleştirmesi.	Evet
item_id	String	Mantığın güncelleştirildiği öğenin benzersiz tanımlayıcısı.	Evet
output_index	tamsayı	Yanıtın çıkış dizisindeki çıkış öğesinin dizini.	Evet
type	enum	Olayın türü. Her zaman 'response.reasoning.delta'. Olası değerler: response.reasoning.delta	Evet

OpenAI.ResponseReasoningDoneEvent

Bir öğe için gerekçe oluşturma içeriği sonlandırıldığında gönderilir.

İsim	Türü	Description	Gerekli	Varsayılan
content_index	tamsayı	Çıkış öğesi içindeki akıl yürütme içeriği bölümünün dizini.	Evet
item_id	String	Mantığın kesinleştirildiği öğenin benzersiz tanımlayıcısı.	Evet
output_index	tamsayı	Yanıtın çıkış dizisindeki çıkış öğesinin dizini.	Evet
text	String	Son haline getirilmiş mantık metni.	Evet
type	enum	Olayın türü. Her zaman 'response.reasoning.done'. Olası değerler: response.reasoning.done	Evet

OpenAI.ResponseReasoningSummaryDeltaEvent

Muhakeme özeti içeriğinde bir değişiklik (kısmi güncelleme) olduğunda yayılır.

İsim	Türü	Description	Gerekli	Varsayılan
delta		Muhakeme özeti içeriğine yönelik kısmi güncelleştirme.	Evet
item_id	String	Gerekçe özetinin güncelleştirildiği öğenin benzersiz tanımlayıcısı.	Evet
output_index	tamsayı	Yanıtın çıkış dizisindeki çıkış öğesinin dizini.	Evet
summary_index	tamsayı	Çıkış öğesi içindeki özet bölümünün dizini.	Evet
type	enum	Olayın türü. Her zaman 'response.reasoning_summary.delta'. Olası değerler: response.reasoning_summary.delta	Evet

OpenAI.ResponseReasoningSummaryDoneEvent

Bir öğe için akıl yürütme özeti sonlandırıldığında yayınlanır.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	Gerekçe özetinin son haline getirildiği öğenin benzersiz tanımlayıcısı.	Evet
output_index	tamsayı	Yanıtın çıkış dizisindeki çıkış öğesinin dizini.	Evet
summary_index	tamsayı	Çıkış öğesi içindeki özet bölümünün dizini.	Evet
text	String	Son haline getirilmiş akıl yürütme özeti metni.	Evet
type	enum	Olayın türü. Her zaman 'response.reasoning_summary.bitti'. Olası değerler: response.reasoning_summary.done	Evet

OpenAI.ResponseReasoningSummaryPartAddedEvent

Yeni bir akıl yürütme özeti bölümü eklendiğinde yayımlanır.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	Bu özet bölümün ilişkili olduğu öğenin kimliği.	Evet
output_index	tamsayı	Bu özet bölümünün ilişkili olduğu çıkış öğesinin dizini.	Evet
parça	nesne		Evet
└─ türü	OpenAI.ReasoningItemSummaryPartType		Hayı
summary_index	tamsayı	Akıl yürütme özeti içindeki özet bölümünün dizini.	Evet
type	enum	Olayın türü. Her zaman response.reasoning_summary_part.added. Olası değerler: response.reasoning_summary_part.added	Evet

OpenAI.ResponseReasoningSummaryPartDoneEvent

Bir akıl yürütme özeti bölümü tamamlandığında gönderilir.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	Bu özet bölümün ilişkili olduğu öğenin kimliği.	Evet
output_index	tamsayı	Bu özet bölümünün ilişkili olduğu çıkış öğesinin dizini.	Evet
parça	nesne		Evet
└─ türü	OpenAI.ReasoningItemSummaryPartType		Hayı
summary_index	tamsayı	Akıl yürütme özeti içindeki özet bölümünün dizini.	Evet
type	enum	Olayın türü. Her zaman response.reasoning_summary_part.done. Olası değerler: response.reasoning_summary_part.done	Evet

OpenAI.ResponseReasoningSummaryTextDeltaEvent

Bir muhakeme özeti metnine delta eklendiğinde oluşur.

İsim	Türü	Description	Gerekli	Varsayılan
delta	String	Özete eklenen metin deltası.	Evet
item_id	String	Bu özet metin deltasının ilişkili olduğu öğenin kimliği.	Evet
output_index	tamsayı	Bu özet metin deltasının bağlı olduğu çıkış öğesinin dizini.	Evet
summary_index	tamsayı	Akıl yürütme özeti içindeki özet bölümünün dizini.	Evet
type	enum	Olayın türü. Her zaman response.reasoning_summary_text.delta. Olası değerler: response.reasoning_summary_text.delta	Evet

OpenAI.ResponseReasoningSummaryTextDoneEvent

Bir akıl yürütme özeti metni tamamlandığında yayılır.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	Bu özet metnin ilişkili olduğu öğenin kimliği.	Evet
output_index	tamsayı	Bu özet metnin ilişkili olduğu çıkış öğesinin dizini.	Evet
summary_index	tamsayı	Akıl yürütme özeti içindeki özet bölümünün dizini.	Evet
text	String	Tamamlanan akıl yürütme özetinin tam metni.	Evet
type	enum	Olayın türü. Her zaman response.reasoning_summary_text.done. Olası değerler: response.reasoning_summary_text.done	Evet

OpenAI.ResponseRefusalDeltaEvent

Kısmi bir reddetme metni olduğunda yayılır.

İsim	Türü	Description	Gerekli	Varsayılan
content_index	tamsayı	Reddetme metninin eklendiği içerik bölümünün dizini.	Evet
delta	String	Eklenen ret metni.	Evet
item_id	String	Reddetme metninin eklendiği çıkış öğesinin kimliği.	Evet
output_index	tamsayı	Reddetme metninin eklendiği çıkış öğesinin dizini.	Evet
type	enum	Olayın türü. Her zaman response.refusal.delta. Olası değerler: response.refusal.delta	Evet

OpenAI.ResponseRefusalDoneEvent

Reddeden metin sonlandırıldığında yayılır.

İsim	Türü	Description	Gerekli	Varsayılan
content_index	tamsayı	Red metni kesinleştiren içerik bölümünün dizini.	Evet
item_id	String	Sonlandırılan reddetme metninin ait olduğu çıkış öğesinin kimliği.	Evet
output_index	tamsayı	Reddetme metninin sonlandırıldığı çıkış öğesinin dizini.	Evet
Ret	String	Kesinleştirilen reddetme metni.	Evet
type	enum	Olayın türü. Her zaman response.refusal.done. Olası değerler: response.refusal.done	Evet

OpenAI.ResponseStreamEvent

OpenAI.ResponseStreamEvent için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

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

İsim	Türü	Description	Gerekli	Varsayılan
sequence_number	tamsayı	Bu olayın sıra numarası.	Evet
type	OpenAI.ResponseStreamEventType		Evet

OpenAI.ResponseStreamEventType

Mülkiyet	Değer
Türü	String
Değerler	response.audio.delta response.audio.done response.audio_transcript.delta response.audio_transcript.done response.code_interpreter_call_code.delta response.code_interpreter_call_code.done response.code_interpreter_call.completed response.code_interpreter_call.in_progress response.code_interpreter_call.interpreting response.completed response.content_part.added response.content_part.done response.created error response.file_search_call.completed response.file_search_call.in_progress response.file_search_call.searching response.function_call_arguments.delta response.function_call_arguments.done response.in_progress response.failed response.incomplete response.output_item.added response.output_item.done response.refusal.delta response.refusal.done response.output_text.annotation.added response.output_text.delta response.output_text.done response.reasoning_summary_part.added response.reasoning_summary_part.done response.reasoning_summary_text.delta response.reasoning_summary_text.done response.web_search_call.completed response.web_search_call.in_progress response.web_search_call.searching response.image_generation_call.completed response.image_generation_call.generating response.image_generation_call.in_progress response.image_generation_call.partial_image response.mcp_call.arguments_delta response.mcp_call.arguments_done response.mcp_call.completed response.mcp_call.failed response.mcp_call.in_progress response.mcp_list_tools.completed response.mcp_list_tools.failed response.mcp_list_tools.in_progress response.queued response.reasoning.delta response.reasoning.done response.reasoning_summary.delta response.reasoning_summary.done

OpenAI.ResponseTextDeltaEvent

İlave bir metin deltası olduğunda oluşur.

İsim	Türü	Description	Gerekli	Varsayılan
content_index	tamsayı	Metin deltasının eklendiği içerik bölümünün dizini.	Evet
delta	String	Eklenen metin deltası.	Evet
item_id	String	Metin deltasının eklendiği çıkış öğesinin kimliği.	Evet
output_index	tamsayı	Metin deltasının eklendiği çıkış öğesinin dizini.	Evet
type	enum	Olayın türü. Her zaman response.output_text.delta. Olası değerler: response.output_text.delta	Evet

OpenAI.ResponseTextDoneEvent

Metin içeriği sonlandırıldığında yayınlanır.

İsim	Türü	Description	Gerekli	Varsayılan
content_index	tamsayı	Metin içeriğinin tamamlandığı içerik bölümünün dizini.	Evet
item_id	String	Metin içeriğinin sonlandırıldığı çıkış öğesinin kimliği.	Evet
output_index	tamsayı	Son haline getirilen metin içeriğine ait çıktı öğesinin dizini.	Evet
text	String	Son haline getirilmiş metin içeriği.	Evet
type	enum	Olayın türü. Her zaman response.output_text.done. Olası değerler: response.output_text.done	Evet

OpenAI.ResponseTextFormatConfiguration

OpenAI.ResponseTextFormatConfiguration için Ayrıştırıcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
text	OpenAI.ResponseTextFormatConfigurationText
json_object	OpenAI.ResponseTextFormatConfigurationJsonObject
json_schema	OpenAI.ResponseTextFormatConfigurationJsonSchema

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.ResponseTextFormatConfigurationType	Modelin çıkış yapması gereken biçimi belirten bir nesne. Yapılandırma { "type": "json_schema" } , Yapılandırılmış Çıkışları etkinleştirir, modelin sağlanan JSON şemanızla eşleşmesini sağlar. Daha fazla bilgi için Varsayılan biçim { "type": "text" } ek seçenek yoktur. gpt-4o ve daha yeni modeller için önerilmez: { "type": "json_object" } ayarı, eski JSON modunu etkinleştirir. modelin oluşturduğu iletinin geçerli JSON olduğundan emin olur. json_schema’ı kullanma Bu özelliği destekleyen modeller için tercih edilir.	Evet

OpenAI.ResponseTextFormatConfigurationJsonObject

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olası değerler: json_object	Evet

OpenAI.ResponseTextFormatConfigurationJsonSchema (Yanıt Metin Biçim Yapılandırma Şeması)

JSON Şeması yanıt biçimi. Yapılandırılmış JSON yanıtları oluşturmak için kullanılır. Yapılandırılmış Çıkışlar hakkında daha fazla bilgi edinin.

İsim	Türü	Description	Gerekli	Varsayılan
açıklama	String	Model tarafından kullanılan yanıt biçiminin ne için olduğuna dair bir açıklama. Yanıt formatını nasıl belirleyeceğinizi öğrenin.	Hayı
name	String	Yanıt biçiminin adı. a-z, A-Z, 0-9 veya bunları içermelidir alt çizgi ve tirelerden oluşan, maksimum uzunluk 64 karakterdir.	Evet
şema	nesne		Evet
Sıkı	Boolean	Çıktı oluşturulurken sıkı şemaya bağlı kalınmasının etkinleştirilip etkinleştirilmeyileceği. True olarak ayarlanırsa, model her zaman tam olarak tanımlanan şemayı izler schema alanında. JSON Şemasının yalnızca bir alt kümesi desteklendiğinde strict, true'e eşittir. Daha fazla bilgi edinmek için Yapılandırılmış Çıkışlar'ı okuyun kılavuzuna bakın.	Hayı	Yanlış
type	enum	Tanımlanan yanıt biçiminin türü. Her zaman json_schema. Olası değerler: json_schema	Evet

OpenAI.CevapMetinBiçimiYapılandırmaMetni

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olası değerler: text	Evet

OpenAI.CevapMetinBiçimiYapılandırmaTürü

Modelin çıkış yapması gereken biçimi belirten bir nesne.

Yapılandırma { "type": "json_schema" } , modelin sağlanan JSON şemanızla eşleşmesini sağlayan Yapılandırılmış Çıkışlar'ı etkinleştirir. Daha fazla bilgi için

Varsayılan biçim { "type": "text" } ek seçenek yoktur.

gpt-4o ve daha yeni modeller için önerilmez:

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.

Mülkiyet	Değer
Açıklama	Modelin çıkış yapması gereken biçimi belirten bir nesne.

Yapılandırma { "type": "json_schema" } , modelin sağlanan JSON şemanızla eşleşmesini sağlayan Yapılandırılmış Çıkışlar'ı etkinleştirir. Daha fazla bilgi için

Varsayılan biçim { "type": "text" } ek seçenek yoktur.

gpt-4o ve daha yeni modeller için önerilmez:

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. | | Tür | string | | Değerler | text
json_schema
json_object |

OpenAI.ResponseUsage

Giriş belirteçleri, çıkış belirteçleri, çıkış belirteçlerinin dökümü ve kullanılan toplam belirteçler dahil olmak üzere belirteç kullanım ayrıntılarını temsil eder.

İsim	Türü	Description	Gerekli	Varsayılan
input_tokens	tamsayı	Giriş belirteçlerinin sayısı.	Evet
input_tokens_details	nesne	Giriş belirteçlerinin ayrıntılı dökümü.	Evet
└─ önbelleğe alınmış jetonlar	tamsayı	Önbellekten alınan belirteçlerin sayısı. İstem önbelleğe alma hakkında daha fazla bilgi.	Hayı
output_tokens	tamsayı	Çıkış belirteçlerinin sayısı.	Evet
output_tokens_details	nesne	Çıkış belirteçlerinin ayrıntılı dökümü.	Evet
└─ akıl yürütme_tokenlar	tamsayı	Akıl yürütme belirteçlerinin sayısı.	Hayı
total_tokens	tamsayı	Kullanılan toplam belirteç sayısı.	Evet

OpenAI.ResponseWebSearchCallCompletedEvent

Not: web_search henüz Azure OpenAI aracılığıyla sağlanmaz.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	Web arama çağrısıyla ilişkili çıkış öğesinin benzersiz kimliği.	Evet
output_index	tamsayı	Web arama çağrısının ilişkili olduğu çıkış öğesinin dizini.	Evet
type	enum	Olayın türü. Her zaman response.web_search_call.completed. Olası değerler: response.web_search_call.completed	Evet

OpenAI.ResponseWebSearchCallInProgressEvent

Not: web_search henüz Azure OpenAI aracılığıyla sağlanmaz.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	Web arama çağrısıyla ilişkili çıkış öğesinin benzersiz kimliği.	Evet
output_index	tamsayı	Web arama çağrısının ilişkili olduğu çıkış öğesinin dizini.	Evet
type	enum	Olayın türü. Her zaman response.web_search_call.in_progress. Olası değerler: response.web_search_call.in_progress	Evet

OpenAI.ResponseWebSearchCallSearchingEvent

Not: web_search henüz Azure OpenAI aracılığıyla sağlanmaz.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	Web arama çağrısıyla ilişkili çıkış öğesinin benzersiz kimliği.	Evet
output_index	tamsayı	Web arama çağrısının ilişkili olduğu çıkış öğesinin dizini.	Evet
type	enum	Olayın türü. Her zaman response.web_search_call.searching. Olası değerler: response.web_search_call.searching	Evet

OpenAI.ResponsesAssistantMessageItemParam

Rolü assistant olan bir ileti parametresi öğesi.

İsim	Türü	Description	Gerekli	Varsayılan
içerik	dize veya dizi		Evet
role	enum	her zaman assistantolan iletinin rolü. Olası değerler: assistant	Evet

OpenAI.ResponsesAssistantMessageItemResource

Rolü assistant olan bir mesaj kaynak öğesi.

İsim	Türü	Description	Gerekli	Varsayılan
içerik	dizi	İletiye bağlı içerik.	Evet
role	enum	her zaman assistantolan iletinin rolü. Olası değerler: assistant	Evet

OpenAI.ResponsesDeveloperMessageItemParam

Rolü developer olan bir ileti parametresi öğesi.

İsim	Türü	Description	Gerekli	Varsayılan
içerik	dize veya dizi		Evet
role	enum	her zaman developerolan iletinin rolü. Olası değerler: developer	Evet

OpenAI.ResponsesDeveloperMessageItemResource

Rolü developer olan bir mesaj kaynak öğesi.

İsim	Türü	Description	Gerekli	Varsayılan
içerik	dizi	İletiye bağlı içerik.	Evet
role	enum	her zaman developerolan iletinin rolü. Olası değerler: developer	Evet

OpenAI.ResponsesMessageItemParam

İstemci isteği parametreleri olarak sağlanan bir rolü ve içeriği temsil eden bir yanıt iletisi öğesi.

OpenAI.ResponsesMessageItemParam için Ayırt Edici

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini role kullanır:

Tür Değeri	Şema
user	OpenAI.ResponsesUserMessageItemParam
system	OpenAI.ResponsesSystemMessageItemParam
developer	OpenAI.ResponsesDeveloperMessageItemParam
assistant	OpenAI.ResponsesAssistantMessageItemParam

İsim	Türü	Description	Gerekli	Varsayılan
role	nesne	Yanıt ileti öğeleri için geçerli rollerin koleksiyonu.	Evet
type	enum	Yanıtlar öğesinin türü her zaman 'ileti'dir. Olası değerler: message	Evet

OpenAI.ResponsesMessageItemResource

Hizmet yanıtlarında sağlandığı gibi bir rolü ve içeriği temsil eden bir yanıt iletisi kaynak öğesi.

OpenAI.ResponsesMessageItemResource için Ayırıcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini role kullanır:

Tür Değeri	Şema
user	OpenAI.ResponsesUserMessageItemResource
system	OpenAI.ResponsesSystemMessageItemResource
developer	OpenAI.ResponsesDeveloperMessageItemResource
assistant	OpenAI.ResponsesAssistantMessageItemResource

İsim	Türü	Description	Gerekli	Varsayılan
role	nesne	Yanıt ileti öğeleri için geçerli rollerin koleksiyonu.	Evet
durum	enum	Öğenin durumu. in_progress, completed, veya bunlardan biri incomplete. Öğeler API aracılığıyla döndürülürken doldurulur. Olası değerler: in_progress, completed, incomplete	Evet
type	enum	Yanıtlar öğesinin türü her zaman 'ileti'dir. Olası değerler: message	Evet

OpenAI.ResponsesMessageRole

Yanıt ileti öğeleri için geçerli rollerin koleksiyonu.

Mülkiyet	Değer
Açıklama	Yanıt ileti öğeleri için geçerli rollerin koleksiyonu.
Türü	String
Değerler	system developer user assistant

OpenAI.ResponsesSystemMessageItemParam

Rolü system olan bir ileti parametresi öğesi.

İsim	Türü	Description	Gerekli	Varsayılan
içerik	dize veya dizi		Evet
role	enum	her zaman systemolan iletinin rolü. Olası değerler: system	Evet

OpenAI.ResponsesSystemMessageItemResource

Rolü system olan bir mesaj kaynak öğesi.

İsim	Türü	Description	Gerekli	Varsayılan
içerik	dizi	İletiye bağlı içerik.	Evet
role	enum	her zaman systemolan iletinin rolü. Olası değerler: system	Evet

OpenAI.ResponsesUserMessageItemParam

Rolü user olan bir ileti parametresi öğesi.

İsim	Türü	Description	Gerekli	Varsayılan
içerik	dize veya dizi		Evet
role	enum	her zaman userolan iletinin rolü. Olası değerler: user	Evet

OpenAI.ResponsesUserMessageItemResource

Rolü user olan bir mesaj kaynak öğesi.

İsim	Türü	Description	Gerekli	Varsayılan
içerik	dizi	İletiye bağlı içerik.	Evet
role	enum	her zaman userolan iletinin rolü. Olası değerler: user	Evet

OpenAI.ServiceTier

İsteğin sunulması için kullanılan işleme türünü belirtir.

• 'otomatik' olarak ayarlanırsa istek, Proje 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. Öncelik işleme hakkında daha fazla bilgi edinmek için satış ekibiyle iletişime geçin.
• Ayarlanmadığında, varsayılan davranış 'auto' şeklindedir.

service_tier Parametre ayarlandığında, yanıt gövdesi isteğe hizmet etmek için kullanılan işleme moduna göre değeri içerirservice_tier. Bu yanıt değeri, parametresindeki değerden farklı olabilir.

Mülkiyet	Değer
Açıklama	İsteğin sunulması için kullanılan işleme türünü belirtir. * 'otomatik' olarak ayarlanırsa istek hizmet katmanıyla işlenir proje ayarlarında yapılandırılır. Aksi yapılandırılmadığı sürece, Project 'default' kullanır. * 'varsayılan' olarak ayarlanırsa, istek standartla işlenir fiyatlandırma ve seçilen model için performans. * 'flex' olarak ayarlanırsa veya 'öncelik', ardından istek ilgili hizmetle işlenir Katmanı. Öncelik işleme hakkında daha fazla bilgi edinmek için satış ekibiyle iletişime geçin. * Ayarlanmadığında, varsayılan davranış 'auto' şeklindedir. service_tier Parametresi ayarlandığında, yanıt gövdesiservice_tier değeri, aslında isteğe hizmet etmek için kullanılan işleme modunu temel alır. Bu yanıt değeri parametresinde ayarlanan değerden farklı olabilir.
Türü	String
Değerler	auto default flex scale priority

OpenAI.TextResponseFormatConfiguration

Modelin çıkış yapması gereken biçimi belirten bir nesne.

Yapılandırma { "type": "json_schema" } , modelin sağlanan JSON şemanızla eşleşmesini sağlayan Yapılandırılmış Çıkışlar'ı etkinleştirir. Daha fazla bilgi için

Varsayılan biçim { "type": "text" } ek seçenek yoktur.

gpt-4o ve daha yeni modeller için önerilmez:*

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.TextResponseFormatConfiguration için Ayrıştırıcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema

İsim	Türü	Description	Gerekli	Varsayılan
type	String		Evet

OpenAI.Tool

OpenAI.Tool için Ayırıcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
function	OpenAI.FunctionTool
file_search	OpenAI.FileSearchTool
computer_use_preview	OpenAI.ComputerUsePreviewTool
web_search_preview	OpenAI.WebSearchPreviewTool
code_interpreter	OpenAI.CodeInterpreterTool
image_generation	OpenAI.ImageGenTool
local_shell	OpenAI.LocalShellTool
mcp	OpenAI.MCPTool
bing_grounding	BingGroundingAgentTool
fabric_dataagent_preview	MicrosoftFabricAgentTool
sharepoint_grounding_preview	SharepointAgentTool
azure_ai_search	AzureAISearchAgentTool
openapi	OpenApiAgentTool
bing_custom_search_preview	BingCustomSearchAgentTool
browser_automation_preview	BrowserAutomationAgentTool
azure_function	AzureFunctionAgentTool
capture_structured_outputs	CaptureStructuredOutputsTool
a2a_preview	A2ATool
memory_search	MemorySearchTool

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.ToolType	Yanıt oluşturmak için kullanılabilecek bir araç.	Evet

OpenAI.ToolChoiceObject

OpenAI.ToolChoiceObject için Ayırıcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
file_search	OpenAI.ToolChoiceObjectFileSearch
computer_use_preview	OpenAI.ToolChoiceObjectComputer
web_search_preview	OpenAI.ToolChoiceObjectWebSearch
image_generation	OpenAI.ToolChoiceObjectImageGen
code_interpreter	OpenAI.ToolChoiceObjectCodeInterpreter
function	OpenAI.ToolChoiceObjectFunction
mcp	OpenAI.ToolChoiceObjectMCP

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.ToolChoiceObjectType	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.	Evet

OpenAI.ToolChoiceObjectCodeInterpreter

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olası değerler: code_interpreter	Evet

OpenAI.ToolChoiceObjectComputer

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olası değerler: computer_use_preview	Evet

OpenAI.ToolChoiceObjectFileSearch

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olası değerler: file_search	Evet

OpenAI.ToolChoiceObjectFunction

Modeli belirli bir işlevi çağırmaya zorlamak için bu seçeneği kullanın.

İsim	Türü	Description	Gerekli	Varsayılan
name	String	Çağrılacak işlevin adı.	Evet
type	enum	İşlev çağrısı için türü her zaman functionşeklindedir. Olası değerler: function	Evet

OpenAI.ToolChoiceObjectImageGen

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olası değerler: image_generation	Evet

OpenAI.ToolChoiceObjectMCP

Modeli uzak bir MCP sunucusunda belirli bir aracı çağırmaya zorlamak için bu seçeneği kullanın.

İsim	Türü	Description	Gerekli	Varsayılan
name	String	Sunucuda çağrılacak aracın adı.	Hayı
sunucu etiketi	String	Kullanılacak MCP sunucusunun etiketi.	Evet
type	enum	MCP araçları için türü her zaman mcpşeklindedir. Olası değerler: mcp	Evet

OpenAI.ToolChoiceObjectType

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.

Mülkiyet	Değer
Açıklama	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.
Türü	String
Değerler	file_search function computer_use_preview web_search_preview image_generation code_interpreter mcp

OpenAI.ToolChoiceObjectWebSearch

Not: web_search henüz Azure OpenAI aracılığıyla sağlanmaz.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olası değerler: web_search_preview	Evet

OpenAI.ToolChoiceOptions

Model tarafından çağrılan aracı (varsa) denetler.

none modelin herhangi bir aracı çağırmayacağı ve bunun yerine bir ileti oluşturduğu anlamına gelir.

auto modelin ileti oluşturma veya bir veya daha fazla araç çağırma arasında seçim yapabileceğiniz anlamına gelir.

required modelin bir veya daha fazla araç çağırması gerektiği anlamına gelir.

Mülkiyet	Değer
Açıklama	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 bir ileti oluşturması veya birini araması anlamına gelir. daha fazla araç. required modelin bir veya daha fazla araç çağırması gerektiği anlamına gelir.
Türü	String
Değerler	none auto required

OpenAI.AraçTürü

Yanıt oluşturmak için kullanılabilecek bir araç.

Mülkiyet	Değer
Açıklama	Yanıt oluşturmak için kullanılabilecek bir araç.
Türü	String
Değerler	file_search function computer_use_preview web_search_preview mcp code_interpreter image_generation local_shell bing_grounding browser_automation_preview fabric_dataagent_preview sharepoint_grounding_preview azure_ai_search openapi bing_custom_search_preview capture_structured_outputs a2a_preview azure_function memory_search

OpenAI.TopLogProb

Belirtecin en yüksek günlük olasılığı.

İsim	Türü	Description	Gerekli	Varsayılan
bytes	dizi		Evet
logprob	Numara		Evet
token	String		Evet

OpenAI.UpdateConversationRequest

Konuşmayı güncelleştirme

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

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

OpenAI.WebSearchAction için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
find	OpenAI.WebSearchActionFind
open_page	OpenAI.WebSearchActionOpenPage
search	OpenAI.WebSearchActionSearch

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.WebSearchActionType		Evet

OpenAI.WebSearchActionFind

Eylem türü "bul": Yüklenen bir sayfada desen arar.

İsim	Türü	Description	Gerekli	Varsayılan
pattern	String	Sayfa içinde aranacak desen veya metin.	Evet
type	enum	Eylem türü. Olası değerler: find	Evet
url	String	Sayfanın URL'si deseni aradı.	Evet

OpenAI.WebSearchActionOpenPage

Eylem türü "open_page" - Arama sonuçlarından belirli bir URL'yi açar.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Eylem türü. Olası değerler: open_page	Evet
url	String	Model tarafından açılan URL.	Evet

OpenAI.WebSearchActionSearch

Eylem türü "arama" - Web araması sorgusu gerçekleştirir.

İsim	Türü	Description	Gerekli	Varsayılan
soru	String	Arama sorgusu.	Evet
Kaynak	dizi	Aramada kullanılan kaynaklar.	Hayı
type	enum	Eylem türü. Olası değerler: search	Evet

OpenAI.WebSearchActionSearchSources

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olası değerler: url	Evet
url	String		Evet

OpenAI.WebSearchActionType

Mülkiyet	Değer
Türü	String
Değerler	search open_page find

OpenAI.WebSearchPreviewTool

Not: web_search henüz Azure OpenAI aracılığıyla sağlanmaz.

İsim	Türü	Description	Gerekli	Varsayılan
arama_bağlam_boyutu	enum	Arama için kullanılacak bağlam penceresi alanı miktarına yönelik üst düzey kılavuz. low, mediumveya high. medium varsayılan değerdir. Olası değerler: low, medium, high	Hayı
type	enum	Web arama aracının türü. web_search_preview veya web_search_preview_2025_03_11'den biri. Olası değerler: web_search_preview	Evet
kullanıcı_konumu	nesne		Hayı
└─ türü	OpenAI.LocationType		Hayı

OpenAI.WebSearchToolCallItemParam

Bir web arama aracı çağrısının sonuçları. Daha fazla bilgi için web arama kılavuzuna bakın.

İsim	Türü	Description	Gerekli	Varsayılan
hareket	nesne		Evet
└─ türü	OpenAI.WebSearchActionType		Hayı
type	enum	Olası değerler: web_search_call	Evet

OpenAI.WebSearchToolCallItemResource

Bir web arama aracı çağrısının sonuçları. Daha fazla bilgi için web arama kılavuzuna bakın.

İsim	Türü	Description	Gerekli	Varsayılan
hareket	nesne		Evet
└─ türü	OpenAI.WebSearchActionType		Hayı
durum	enum	Web arama aracı çağrısının durumu. Olası değerler: in_progress, searching, completed, failed	Evet
type	enum	Olası değerler: web_search_call	Evet

OpenAI.integer

Tür: tamsayı

Biçim: int64

OpenAI.numeric

Tür: sayı

Biçim: çift

OpenApiAgentTool

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

İsim	Türü	Description	Gerekli	Varsayılan
openapi	nesne	Openapi işlevinin giriş tanımı bilgileri.	Evet
└─ kimlik doğrulaması	OpenApiAuthDetails	Açık API kimlik doğrulaması ayrıntıları	Hayı
└─ default_params	dizi	Kullanıcı tarafından sağlanan varsayılanları kullanacak OpenAPI belirtim parametrelerinin listesi	Hayı
└─ açıklama	String	İşlevin ne zaman ve nasıl çağrıldığını seçmek için model tarafından kullanılan işlevin ne yaptığının açıklaması.	Hayı
└─ işlevleri	dizi	OpenApi aracı tarafından kullanılan işlev tanımlarının listesi	Hayı
└─ ad	String	Çağrılacak işlevin adı.	Hayı
└─ belirtim		JSON Şeması nesnesi olarak tanımlanan openapi işlev şekli.	Hayı
type	enum	Her zaman 'openapi' olan nesne türü. Olası değerler: openapi	Evet

OpenApiAnonymousAuthDetails

OpenApi anonim kimlik doğrulaması için güvenlik ayrıntıları

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Her zaman 'anonim' olan nesne türü. Olası değerler: anonymous	Evet

OpenApiAuthDetails

OpenApiFunctionDefinition için kimlik doğrulama ayrıntıları

OpenApiAuthDetails için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
anonymous	OpenApiAnonymousAuthDetails
project_connection	OpenApiProjectConnectionAuthDetails
managed_identity	OpenApiManagedAuthDetails

İsim	Türü	Description	Gerekli	Varsayılan
type	nesne	OpenApi uç noktası için kimlik doğrulama türü. İzin verilen türler şunlardır: - Anonim (kimlik doğrulaması gerekmez) - Proje Bağlantısı (Foundry'de kurulum olarak uç noktaya project_connection_id gerektirir) - Managed_Identity (kimlik tabanlı kimlik doğrulaması için hedef kitle gerektirir)	Evet

OpenApiAuthType

OpenApi uç noktası için kimlik doğrulama türü. İzin verilen türler şunlardır:

• Anonim (kimlik doğrulaması gerekmez)
• Proje Bağlantısı (Foundry'de kurulum olarak uç noktaya project_connection_id gerektirir)
• Managed_Identity (kimlik tabanlı kimlik doğrulama için hedef kitle gerektirir)

Mülkiyet	Değer
Türü	String
Değerler	anonymous project_connection managed_identity

OpenApiFunctionDefinition

Openapi işlevinin giriş tanımı bilgileri.

İsim	Türü	Description	Gerekli	Varsayılan
auth	nesne	OpenApiFunctionDefinition için kimlik doğrulama ayrıntıları	Evet
└─ türü	OpenApiAuthType	Kimlik doğrulama türü anonim/project_connection/managed_identity olmalıdır	Hayı
default_params	dizi	Kullanıcı tarafından sağlanan varsayılanları kullanacak OpenAPI belirtim parametrelerinin listesi	Hayı
açıklama	String	İşlevin ne zaman ve nasıl çağrıldığını seçmek için model tarafından kullanılan işlevin ne yaptığının açıklaması.	Hayı
functions	dizi	OpenApi aracı tarafından kullanılan işlev tanımlarının listesi	Hayı
name	String	Çağrılacak işlevin adı.	Evet
spec		JSON Şeması nesnesi olarak tanımlanan openapi işlev şekli.	Evet

OpenApiManagedAuthDetails

OpenApi managed_identity kimlik doğrulaması için güvenlik ayrıntıları

İsim	Türü	Description	Gerekli	Varsayılan
security_scheme	nesne	OpenApi managed_identity kimlik doğrulaması için güvenlik şeması	Evet
└─ hedef kitle	String	managed_identity kimlik doğrulama türü için kimlik doğrulama kapsamı	Hayı
type	enum	Her zaman 'managed_identity' olan nesne türü. Olası değerler: managed_identity	Evet

OpenApiManagedSecurityScheme

OpenApi managed_identity kimlik doğrulaması için güvenlik şeması

İsim	Türü	Description	Gerekli	Varsayılan
audience	String	managed_identity kimlik doğrulama türü için kimlik doğrulama kapsamı	Evet

OpenApiProjectConnectionAuthDetails

OpenApi proje bağlantısı kimlik doğrulaması için güvenlik ayrıntıları

İsim	Türü	Description	Gerekli	Varsayılan
security_scheme	nesne	OpenApi managed_identity kimlik doğrulaması için güvenlik şeması	Evet
└─ project_connection_id	String	Proje Bağlantısı kimlik doğrulama türü için proje bağlantı kimliği	Hayı
type	enum	Her zaman 'project_connection' olan nesne türü. Olası değerler: project_connection	Evet

OpenApiProjectConnectionSecurityScheme

OpenApi managed_identity kimlik doğrulaması için güvenlik şeması

İsim	Türü	Description	Gerekli	Varsayılan
project_connection_id	String	Proje Bağlantısı kimlik doğrulama türü için proje bağlantı kimliği	Evet

PagedConnection

Bağlantı öğelerinin sayfalı koleksiyonu

İsim	Türü	Description	Gerekli	Varsayılan
nextLink	String	Öğelerin sonraki sayfasına bağlantı	Hayı
değer	dizi	Bu sayfadaki Bağlantı öğeleri	Evet

PagedDatasetVersion

DatasetVersion öğelerinin sayfalı koleksiyonu

İsim	Türü	Description	Gerekli	Varsayılan
nextLink	String	Öğelerin sonraki sayfasına bağlantı	Hayı
değer	dizi	Bu sayfadaki DatasetVersion öğeleri	Evet

PagedDeployment

Dağıtım öğelerinin sayfalı koleksiyonu

İsim	Türü	Description	Gerekli	Varsayılan
nextLink	String	Öğelerin sonraki sayfasına bağlantı	Hayı
değer	dizi	Bu sayfadaki Dağıtım öğeleri	Evet

PagedEvaluationRule

EvaluationRule öğelerinin disk belleğine alınmış koleksiyonu

İsim	Türü	Description	Gerekli	Varsayılan
nextLink	String	Öğelerin sonraki sayfasına bağlantı	Hayı
değer	dizi	Bu sayfadaki EvaluationRule öğeleri	Evet

PagedEvaluationTaxonomy

EvaluationTaxonomy öğelerinin sayfalanmış koleksiyonu

İsim	Türü	Description	Gerekli	Varsayılan
nextLink	String	Öğelerin sonraki sayfasına bağlantı	Hayı
değer	dizi	Bu sayfadaki EvaluationTaxonomy öğeleri	Evet

PagedEvaluatorVersion

EvaluatorVersion öğelerinin disk belleğine alınmış koleksiyonu

İsim	Türü	Description	Gerekli	Varsayılan
nextLink	String	Öğelerin sonraki sayfasına bağlantı	Hayı
değer	dizi	Bu sayfadaki EvaluatorVersion öğeleri	Evet

PagedIndex

Dizin öğelerinin sayfalı koleksiyonu

İsim	Türü	Description	Gerekli	Varsayılan
nextLink	String	Öğelerin sonraki sayfasına bağlantı	Hayı
değer	dizi	Bu sayfadaki Dizin öğeleri	Evet

PagedInsight

İçgörü öğelerinin disk belleğine alınmış koleksiyonu

İsim	Türü	Description	Gerekli	Varsayılan
nextLink	String	Öğelerin sonraki sayfasına bağlantı	Hayı
değer	dizi	Bu sayfadaki İçgörü öğeleri	Evet

PagedRedTeam

RedTeam öğelerinin sayfalı koleksiyonu

İsim	Türü	Description	Gerekli	Varsayılan
nextLink	String	Öğelerin sonraki sayfasına bağlantı	Hayı
değer	dizi	Bu sayfadaki RedTeam öğeleri	Evet

PagedSchedule

Zamanlama öğelerinin sayfalı koleksiyonu

İsim	Türü	Description	Gerekli	Varsayılan
nextLink	String	Öğelerin sonraki sayfasına bağlantı	Hayı
değer	dizi	Bu sayfadaki Öğeleri zamanla	Evet

PagedScheduleRun

ScheduleRun öğelerinin disk belleği koleksiyonu

İsim	Türü	Description	Gerekli	Varsayılan
nextLink	String	Öğelerin sonraki sayfasına bağlantı	Hayı
değer	dizi	Bu sayfadaki ScheduleRun öğeleri	Evet

PendingUploadRequest

Bekleyen bir yükleme isteğini temsil eder.

İsim	Türü	Description	Gerekli	Varsayılan
connectionName (bağlantıadı)	String	Geçici SAS belirteci oluşturmak için kullanılacak Azure Depolama Hesabı bağlantı adı	Hayı
pendingUploadId	String	PendingUploadId sağlanmazsa, rastgele bir GUID kullanılır.	Hayı
pendingUploadType	enum	BlobReference desteklenen tek türdür. Olası değerler: BlobReference	Evet

PendingUploadResponse

Bekleyen bir yükleme isteğinin yanıtını temsil eder

İsim	Türü	Description	Gerekli	Varsayılan
blobReference	nesne	Blob başvuru ayrıntıları.	Evet
└─ blobUri	String	İstemcinin verileri karşıya yüklemesi için Blob URI yolu. Örnek: https://blob.windows.core.net/Container/Path	Hayı
└─ kimlik bilgisi	SasCredential	Depolama hesabına erişmek için kimlik bilgileri .	Hayı
└─ storageAccountArmId	String	Kullanılacak depolama hesabının ARM kimliği.	Hayı
pendingUploadId	String	Bu yükleme isteğinin kimliği.	Evet
pendingUploadType	enum	BlobReference desteklenen tek türdür Olası değerler: BlobReference	Evet
version	String	Kullanıcı ilk yükleme oluşturulurken sürüm belirtmediyse oluşturulacak öğenin sürümü	Hayı

PromptAgentDefinition

İstem aracısı tanımı

İsim	Türü	Description	Gerekli	Varsayılan
instructions	String	Modelin bağlamı içine eklenen bir sistem (veya geliştirici) iletisi.	Hayı
tür	enum	Olası değerler: prompt	Evet
model	String	Bu aracı için kullanılacak model dağıtımı.	Evet
reasoning	nesne	yalnızca o serisi modeller Mantık modelleri için yapılandırma seçenekleri.	Hayı
└─ çaba	OpenAI.ReasoningEffort	Mantıp modelleri için mantık yürütme çabasını kısıtlar. Şu anda desteklenen değerler hiçbiri, en düşük, düşük, orta ve yüksek değerlerdir. 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 yok olur ve mantık yürütmez. gpt-5.1 için desteklenen mantık değerleri yok, düşük, orta ve yüksektir. Araç çağrıları gpt-5.1'deki tüm akıl yürütme değerleri için desteklenir. gpt-5.1'in önceki tüm modelleri varsayılan olarak orta düzeyde mantık yürütme eforu kullanır ve hiçbirini desteklemez. gpt-5-pro modeli varsayılan olarak yüksek mantık eforu kullanır (ve yalnızca destekler).	Hayı
└─ özet oluştur	enum	Kullanım dışı: bunun yerine kullanın summary . Model tarafından gerçekleştirilen mantığın özeti. Bu, hata ayıklama ve modelin akıl yürütme işlemini anlamak için yararlı olabilir. auto, conciseveya detailed. Olası değerler: auto, concise, detailed	Hayı
└─ özeti	enum	Model tarafından gerçekleştirilen mantığın özeti. Bu, hata ayıklamak ve modelin akıl yürütme işlemini anlamak için kullanışlıdır. auto, conciseveya detailed. Olası değerler: auto, concise, detailed	Hayı
structured_inputs	nesne	Bilgi istemi şablonu değiştirme veya araç bağımsız değişkeni bağlamalarına katılabilen yapılandırılmış girişler kümesi.	Hayı
sıcaklık	Numara	0 ile 2 arasında hangi örnekleme sıcaklığının kullanılacağı. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir. Genellikle bunu değiştirmenizi öneririz top_p ancak ikisini birden değiştirmemenizi öneririz.	Hayı	1
text	nesne	Modelden metin yanıtı için yapılandırma seçenekleri. Düz metin veya yapılandırılmış JSON verileri olabilir.	Hayı
└─ biçimi	OpenAI.ResponseTextFormatConfiguration		Hayı
araçlar	dizi	Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Siz parametresini ayarlayarak tool_choice hangi aracın kullanılacağını belirtebilir.	Hayı
top_p	Numara	Sıcaklıkla örneklemeye alternatif olarak çekirdek örneklemesi adı verilir, burada model, belirteçlerin sonuçlarını top_p olasılıkla değerlendirir kütle. Yani 0,1 yalnızca ilk 10% olasılık kütlesini oluşturan belirteçler anlamına gelir dikkate alınır. Genellikle bunu değiştirmenizi öneririz temperature ancak ikisini birden değiştirmemenizi öneririz.	Hayı	1

PromptBasedEvaluatorDefinition

İstem tabanlı değerlendirici

İsim	Türü	Description	Gerekli	Varsayılan
prompt_text	String	Değerlendirme için kullanılan bilgi istemi metni	Evet
type	enum	Olası değerler: prompt	Evet

ProtocolVersionRecord

Tek bir protokol ve sürümü için kayıt eşlemesi.

İsim	Türü	Description	Gerekli	Varsayılan
protokol	nesne		Evet
version	String	Protokolün sürüm dizesi, örneğin 'v0.1.1'.	Evet

RaiConfig

Sorumlu Yapay Zeka (RAI) içerik filtreleme ve güvenlik özellikleri için yapılandırma.

İsim	Türü	Description	Gerekli	Varsayılan
rai_policy_name	String	Uygulanacak RAI politikasının adı.	Evet

RecurrenceSchedule

Yinelenme zamanlama modeli.

RecurrenceSchedule için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
Hourly	HourlyRecurrenceSchedule
Daily	DailyRecurrenceSchedule
Weekly	WeeklyRecurrenceSchedule
Monthly	MonthlyRecurrenceSchedule

İsim	Türü	Description	Gerekli	Varsayılan
type	nesne	Yinelenme türü.	Evet

RecurrenceTrigger

Yinelenmeye dayalı tetikleyici.

İsim	Türü	Description	Gerekli	Varsayılan
endTime	String	ISO 8601 biçiminde yinelenme zamanlaması için bitiş saati.	Hayı
interval	tamsayı	Yinelenme zamanlaması aralığı.	Evet
takvim	nesne	Yinelenme zamanlama modeli.	Evet
└─ türü	RecurrenceType	Yinelenme zamanlaması için yinelenme türü.	Hayı
startTime	String	ISO 8601 biçiminde yinelenme zamanlaması için başlangıç saati.	Hayı
timeZone	String	Yinelenme zamanlaması için saat dilimi.	Hayı	UTC (Koordinatlı Evrensel Zaman)
type	enum	Tetikleyicinin türü. Olası değerler: Recurrence	Evet

RecurrenceType

Yinelenme türü.

Mülkiyet	Değer
Açıklama	Yinelenme türü.
Türü	String
Değerler	Hourly Daily Weekly Monthly

RedTeam

Kırmızı takım detayları.

İsim	Türü	Description	Gerekli	Varsayılan
applicationScenario	String	Senaryoya özel saldırılar oluşturmak için kırmızı takım operasyonu için uygulama senaryosu.	Hayı
attackStrategies	dizi	Saldırı stratejilerinin listesi veya saldırı stratejilerinin iç içe geçmiş listeleri.	Hayı
ekran adı	String	Kırmızı takım koşusunun adı.	Hayı
kimlik	String	Kırmızı takım koşusunun tanımlayıcısı.	Evet
numTurns	tamsayı	Simülasyon turlarının sayısı.	Hayı
properties	nesne	Kırmızı takımın özellikleri. Etiketlerden farklı olarak özellikler yalnızca eklentidir. Bir özellik eklendikten sonra kaldırılamaz.	Hayı
risk Kategorileri	dizi	Saldırı hedefleri oluşturmak için risk kategorilerinin listesi.	Hayı
simulationOnly	Boolean	Yalnızca simülasyon veya Simülasyon + Değerlendirme. Varsayılan olarak false, doğruysa tarama değerlendirme sonucunu değil konuşma çıktısını verir.	Hayı	Yanlış
durum	String	Kırmızı takımın durumu. Hizmet tarafından ayarlanır ve salt okunurdur.	Hayı
tags	nesne	Kırmızı takımın etiketleri. Özelliklerden farklı olarak etiketler tamamen değişebilir.	Hayı
target	nesne	Hedef yapılandırma için soyut sınıf.	Evet
└─ türü	String	Model yapılandırmasının türü.	Hayı

RedTeamItemGenerationParams

Kırmızı takım öğesi oluşturma parametrelerini temsil eder.

İsim	Türü	Description	Gerekli	Varsayılan
attack_strategies	dizi	Kullanılacak saldırı stratejilerinin koleksiyonu.	Evet
num_turns	tamsayı	Oyunda izin verilen dönüş sayısı.	Evet
type	enum	Her zaman red_teamolan öğe oluşturma parametrelerinin türü. Olası değerler: red_team	Evet

RiskCategory

Saldırı hedefi için risk kategorisi.

Mülkiyet	Değer
Açıklama	Saldırı hedefi için risk kategorisi.
Türü	String
Değerler	HateUnfairness Violence Sexual SelfHarm ProtectedMaterial CodeVulnerability UngroundedAttributes ProhibitedActions SensitiveDataLeakage TaskAdherence

SASCredentials

Paylaşılan Erişim İmzası (SAS) kimlik bilgisi tanımı

İsim	Türü	Description	Gerekli	Varsayılan
SAS	String	SAS belirteci	Hayı
type	enum	Kimlik bilgisi türü Olası değerler: SAS	Evet

SampleType

Analizde kullanılan numunenin türü.

Mülkiyet	Değer
Türü	String
Değerler	EvaluationResultSample

SasCredential (SasKimlik Bilgisi)

SAS Kimlik Bilgisi tanımı

İsim	Türü	Description	Gerekli	Varsayılan
sasUri	String	SAS uri'si	Evet
type	enum	Kimlik bilgisi türü Olası değerler: SAS	Evet

Schedule

Zamanlama modeli.

İsim	Türü	Description	Gerekli	Varsayılan
açıklama	String	Zamanlamanın açıklaması.	Hayı
ekran adı	String	Zamanlamanın adı.	Hayı
etkinleştirildi	Boolean	Zamanlamanın etkin durumu.	Evet
kimlik	String	Zamanlamanın tanımlayıcısı.	Evet
properties	nesne	Schedule'ın özellikleri. Etiketlerden farklı olarak özellikler yalnızca eklentidir. Bir özellik eklendikten sonra kaldırılamaz.	Hayı
provisioningStatus	nesne	Sağlama durumunu zamanlayın.	Hayı
sistem verileri	nesne	Kaynak için sistem meta verileri.	Evet
tags	nesne	Schedule'un etiketleri. Özelliklerden farklı olarak etiketler tamamen değişebilir.	Hayı
görev	nesne	Zamanlama görev modeli.	Evet
└─ yapılandırması	nesne	Görev için yapılandırma.	Hayı
└─ türü	ScheduleTaskType	Görevin türü.	Hayı
trigger	nesne	Zamanlamanın tetikleyicisi için temel model.	Evet
└─ türü	TriggerType	Tetikleyicinin türü.	Hayı

ScheduleProvisioningStatus

Sağlama durumunu zamanlayın.

Mülkiyet	Değer
Açıklama	Sağlama durumunu zamanlayın.
Türü	String
Değerler	Creating Updating Deleting Succeeded Failed

ScheduleRun

Zamanlama çalıştırma modeli.

İsim	Türü	Description	Gerekli	Varsayılan
hata	String	Zamanlama çalıştırması için hata bilgileri.	Hayı
kimlik	String	Zamanlama çalıştırmasının tanımlayıcısı.	Evet
properties	nesne	Zamanlama çalıştırmasının özellikleri.	Evet
scheduleId	String	Zamanlamanın tanımlayıcısı.	Evet
başarı	Boolean	Zamanlama çalıştırmasının başarı durumunu tetikleyin.	Evet
triggerTime	String	Zamanlama çalıştırmasının tetikleme zamanı.	Hayı

Görev Planla

Zamanlama görev modeli.

ScheduleTask için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
Evaluation	EvaluationScheduleTask
Insight	InsightScheduleTask

İsim	Türü	Description	Gerekli	Varsayılan
configuration	nesne	Görev için yapılandırma.	Hayı
type	nesne	Görevin türü.	Evet

ScheduleTaskType

Görevin türü.

Mülkiyet	Değer
Açıklama	Görevin türü.
Türü	String
Değerler	Evaluation Insight

SeedPromptsRedTeamItemGenerationParams

Çekirdek istemleriyle kırmızı takım öğesi oluşturma parametrelerini temsil eder.

İsim	Türü	Description	Gerekli	Varsayılan
attack_strategies	dizi	Kullanılacak saldırı stratejilerinin koleksiyonu.	Evet
num_turns	tamsayı	Oyunda izin verilen dönüş sayısı.	Evet
kaynak	nesne		Evet
└─ içerik	dizi	jsonl dosyasının içeriği.	Hayı
└─ kimlik	String	Dosyanın tanımlayıcısı.	Hayı
└─ türü	enum	Jsonl kaynağının türü. Her zaman file_id. Olası değerler: file_id	Hayı
type	enum	Her zaman red_teamolan öğe oluşturma parametrelerinin türü. Olası değerler: red_team_seed_prompts	Evet

SharepointAgentTool

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

İsim	Türü	Description	Gerekli	Varsayılan
sharepoint_grounding_preview	nesne	Sharepoint topraklama aracı parametreleri.	Evet
└─ project_connections	dizi	Bu araca bağlı proje bağlantıları. En fazla 1 bağlantı olabilir aracına bağlı kaynak.	Hayı
type	enum	Her zaman 'sharepoint_grounding' olan nesne türü. Olası değerler: sharepoint_grounding_preview	Evet

SharepointGroundingToolParameters

Sharepoint topraklama aracı parametreleri.

İsim	Türü	Description	Gerekli	Varsayılan
project_connections	dizi	Bu araca bağlı proje bağlantıları. En fazla 1 bağlantı olabilir aracına bağlı kaynak.	Hayı

Sku

Sku bilgileri

İsim	Türü	Description	Gerekli	Varsayılan
capacity	tamsayı	Sku kapasitesi	Evet
family	String	Sku ailesi	Evet
name	String	Sku adı	Evet
boyut	String	Sku boyutu	Evet
seviye	String	Sku katmanı	Evet

StructuredInputDefinition

Bilgi istemi şablonu değiştirmelerine ve araç bağımsız değişkeni bağlamasına katılabilen yapılandırılmış bir giriş.

İsim	Türü	Description	Gerekli	Varsayılan
default_value		Çalışma zamanı değeri sağlanmamışsa giriş için varsayılan değer.	Hayı
açıklama	String	Girişin okunabilir bir açıklaması.	Hayı
required	Boolean	Aracı çağrıldığında giriş özelliğinin gerekli olup olmadığı.	Hayı	Yanlış
şema		Yapılandırılmış giriş için JSON şeması (isteğe bağlı).	Hayı

StructuredOutputDefinition

Aracı tarafından üretilebilen yapılandırılmış bir çıkış.

İsim	Türü	Description	Gerekli	Varsayılan
açıklama	String	Yayınlanacak çıkışın açıklaması. Çıktının ne zaman yayınlanacağını belirlemek için model tarafından kullanılır.	Evet
name	String	Yapılandırılmış çıkışın adı.	Evet
şema		Yapılandırılmış çıkış için JSON şeması.	Evet
Sıkı	Boolean	Sıkı doğrulamanın uygulanıp uygulanmayacağı. Varsayılan true.	Evet

StructuredOutputsItemResource

İsim	Türü	Description	Gerekli	Varsayılan
çıktı		Yanıt sırasında yakalanan yapılandırılmış çıkış.	Evet
type	enum	Olası değerler: structured_outputs	Evet

Hedef

Ayırıcı desteği olan hedefler için temel sınıf.

Hedef için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
azure_ai_model	AzureAIModelTarget
azure_ai_agent	AzureAIAgentTarget
azure_ai_assistant	AzureAIAssistantTarget

İsim	Türü	Description	Gerekli	Varsayılan
type	String	Hedefin türü.	Evet

TargetCompletions

Hedef tabanlı tamamlama değerlendirme yapılandırması için bir veri kaynağını temsil eder.

İsim	Türü	Description	Gerekli	Varsayılan
input_mesajları	nesne		Hayı
└─ öğe_referansı	String		Hayı
└─ türü	enum	Olası değerler: item_reference	Hayı
kaynak	nesne		Evet
└─ içerik	dizi	jsonl dosyasının içeriği.	Hayı
└─ kimlik	String	Dosyanın tanımlayıcısı.	Hayı
└─ türü	enum	Jsonl kaynağının türü. Her zaman file_id. Olası değerler: file_id	Hayı
target	nesne	Ayırıcı desteği olan hedefler için temel sınıf.	Evet
└─ türü	String	Hedefin türü.	Hayı
type	enum	Her zaman TargetCompletionsveri kaynağı türü. Olası değerler: azure_ai_target_completions	Evet

TargetConfig

Hedef yapılandırma için soyut sınıf.

TargetConfig için Ayrıştırıcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
AzureOpenAIModel	AzureOpenAIModelConfiguration

İsim	Türü	Description	Gerekli	Varsayılan
type	String	Model yapılandırmasının türü.	Evet

TargetUpdate

Ayırıcı desteği olan hedefler için temel sınıf.

TargetUpdate için Ayrıştırıcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
azure_ai_model	AzureAIModelTargetUpdate
azure_ai_assistant	AzureAIAssistantTargetUpdate

İsim	Türü	Description	Gerekli	Varsayılan
type	String	Hedefin türü.	Evet

TaksonomiKategorisi

Taksonomi kategori tanımı.

İsim	Türü	Description	Gerekli	Varsayılan
açıklama	String	Taksonomi kategorisinin açıklaması.	Hayı
kimlik	String	Taksonomi kategorisinin benzersiz tanımlayıcısı.	Evet
name	String	Taksonomi kategorisinin adı.	Evet
properties	nesne	Taksonomi kategorisi için ek özellikler.	Hayı
riskCategory	nesne	Saldırı hedefi için risk kategorisi.	Evet
Alt kategori	dizi	Taksonomi alt kategorilerinin listesi.	Evet

TaksonomiRedTeamItemGenerationParams

Çekirdek istemleriyle kırmızı takım öğesi oluşturma parametrelerini temsil eder.

İsim	Türü	Description	Gerekli	Varsayılan
attack_strategies	dizi	Kullanılacak saldırı stratejilerinin koleksiyonu.	Evet
num_turns	tamsayı	Oyunda izin verilen dönüş sayısı.	Evet
kaynak	nesne		Evet
└─ içerik	dizi	jsonl dosyasının içeriği.	Hayı
└─ kimlik	String	Dosyanın tanımlayıcısı.	Hayı
└─ türü	enum	Jsonl kaynağının türü. Her zaman file_id. Olası değerler: file_id	Hayı
type	enum	Her zaman red_teamolan öğe oluşturma parametrelerinin türü. Olası değerler: red_team_taxonomy	Evet

TaxonomySubCategory

Taksonomi alt kategori tanımı.

İsim	Türü	Description	Gerekli	Varsayılan
açıklama	String	Taksonomi alt kategorisinin açıklaması.	Hayı
etkinleştirildi	Boolean	Bu alt kategori altındaki taksonomi öğelerinin listesi.	Evet
kimlik	String	Taksonomi alt kategorisinin benzersiz tanımlayıcısı.	Evet
name	String	Taksonomi alt kategorisinin adı.	Evet
properties	nesne	Taksonomi alt kategorisi için ek özellikler.	Hayı

ToolDescription

Bir aracı tarafından kullanılabilecek bir aracın açıklaması.

İsim	Türü	Description	Gerekli	Varsayılan
açıklama	String	Aracın amacının kısa bir açıklaması.	Hayı
name	String	Araç adı.	Hayı

ToolProjectConnection

Proje bağlantı kaynağı.

İsim	Türü	Description	Gerekli	Varsayılan
project_connection_id	String	Bu araca iliştirilmiş bir ToolProjectConnectionList'teki proje bağlantısı.	Evet

TracesEvalRunDataSource

Application Insights'ta depolanan Aracı izlemeleri üzerinde çalışan değerlendirme çalıştırmaları için bir veri kaynağını temsil eder.

İsim	Türü	Description	Gerekli	Varsayılan
lookback_hours	tamsayı	Application Insights'tan izlemeler alınırken uygulanan geri arama penceresi (saat cinsinden).	Hayı	168
trace_ids	dizi	Değerlendirilmesi gereken Aracı izleme tanımlayıcıları koleksiyonu.	Evet
type	enum	Her zaman azure_ai_tracesveri kaynağı türü. Olası değerler: azure_ai_traces	Evet

TreatmentEffectType

Tedavi Etki Türü.

Mülkiyet	Değer
Türü	String
Değerler	TooFewSamples Inconclusive Changed Improved Degraded

Tetikleyici

Zamanlamanın tetikleyicisi için temel model.

Tetikleyici için Ayrıştırıcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
Cron	CronTrigger
Recurrence	RecurrenceTrigger
OneTime	OneTimeTrigger

İsim	Türü	Description	Gerekli	Varsayılan
type	nesne	Tetikleyicinin türü.	Evet

TriggerType

Tetikleyicinin türü.

Mülkiyet	Değer
Açıklama	Tetikleyicinin türü.
Türü	String
Değerler	Cron Recurrence OneTime

UpdateAgentFromManifestRequest

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

UpdateAgentRequest

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

UpdateEvalParametersBody

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

UserProfileMemoryItem

Tercihler, ilgi alanları ve kişisel ayrıntılar gibi konuşmalardan çıkarılan kullanıcı profili bilgilerini özel olarak içeren bir bellek öğesi.

İsim	Türü	Description	Gerekli	Varsayılan
tür	enum	Hafıza öğesinin türü. Olası değerler: user_profile	Evet

WeeklyRecurrenceSchedule

Haftalık yineleme programı.

İsim	Türü	Description	Gerekli	Varsayılan
daysOfWeek	dizi	Yinelenme zamanlaması için haftanın günleri.	Evet
type	enum	Haftalık yineleme türü. Olası değerler: Weekly	Evet

WorkflowActionOutputItemResource

İsim	Türü	Description	Gerekli	Varsayılan
action_id	String	Eylem için benzersiz tanımlayıcı.	Evet
tür	String	CSDL eyleminin türü (örneğin, 'SetVariable', 'InvokeAzureAgent').	Evet
parent_action_id	String	Bu iç içe bir eylemse, üst eylemin kimliği.	Hayı
previous_action_id	String	Bu eylem başka bir eylemden sonra gelirse, önceki eylemin kimliği.	Hayı
durum	enum	Eylemin durumu (örneğin, 'in_progress', 'tamamlandı', 'başarısız', 'iptal edildi'). Olası değerler: completed, failed, in_progress, cancelled	Evet
type	enum	Olası değerler: workflow_action	Evet

WorkflowAgentDefinition

İş akışı aracısı tanımı.

İsim	Türü	Description	Gerekli	Varsayılan
tür	enum	Olası değerler: workflow	Evet
iş akışı	String	İş akışının CSDL YAML tanımı.	Hayı

tamsayı

Tür: tamsayı

Biçim: int64