Azure AI Foundry Agent Service (Önizleme)

Azure AI Foundry Aracı Hizmeti özelliklerini iş akışlarınızla kolayca tümleştirin.

Bu bağlayıcı aşağıdaki ürün ve bölgelerde kullanılabilir:

Hizmet	Class	Bölgeler
Copilot Studio	Premium	Aşağıdakiler dışında tüm Power Automate bölgeleri :      - ABD Kamu (GCC)      - US Government (GCC High)      - 21Vianet tarafından işletilen Çin Bulutu      - ABD Savunma Bakanlığı (DoD)
Logic Apps	Standart	Aşağıdakiler dışında tüm Logic Apps bölgeleri :      - Azure Kamu bölgeleri      - Azure Çin bölgeleri      - ABD Savunma Bakanlığı (DoD)
Power Apps	Premium	Aşağıdakiler dışında tüm Power Apps bölgeleri :      - ABD Kamu (GCC)      - US Government (GCC High)      - 21Vianet tarafından işletilen Çin Bulutu      - ABD Savunma Bakanlığı (DoD)
Power Automate	Premium	Aşağıdakiler dışında tüm Power Automate bölgeleri :      - ABD Kamu (GCC)      - US Government (GCC High)      - 21Vianet tarafından işletilen Çin Bulutu      - ABD Savunma Bakanlığı (DoD)

İletişim
İsim	Microsoft
URL	https://support.microsoft.com

Bağlayıcı Meta Verileri
Publisher	Microsoft
Web sitesi	https://learn.microsoft.com/en-us/azure/ai-services/agents/
Gizlilik ilkesi	https://learn.microsoft.com/en-us/legal/cognitive-services/agents/data-privacy-security
Kategoriler	AI; İş Zekası

Bağlantı oluşturma

Bağlayıcı aşağıdaki kimlik doğrulama türlerini destekler:

Logic Apps Yönetilen Kimliği	LogicApps Yönetilen Kimliği kullanarak bağlantı oluşturma	Yalnızca LOGICAPPS	Paylaşılabilir
Microsoft Entra Id Kullanıcı Oturum Açma	Microsoft Entra Id Kimlik Bilgileri ile oturum açma	Tüm bölgeler	Paylaşılamaz
Varsayılan [KULLANIM DIŞI]	Bu seçenek yalnızca açık kimlik doğrulama türü olmayan eski bağlantılar içindir ve yalnızca geriye dönük uyumluluk için sağlanır.	Tüm bölgeler	Paylaşılamaz

Logic Apps Yönetilen Kimliği

Kimlik Doğrulaması Kimliği: managedIdentityAuth

Uygulanabilir: Yalnızca LOGICAPPS

LogicApps Yönetilen Kimliği kullanarak bağlantı oluşturma

Bu, paylaşılabilir bir bağlantıdır. Power app başka bir kullanıcıyla paylaşılıyorsa, bağlantı da paylaşılır. Daha fazla bilgi için bkz . Tuval uygulamaları için bağlayıcılara genel bakış - Power Apps | Microsoft Docs

İsim	Türü	Description	Gerekli
LogicApps Yönetilen Kimliği	managedIdentity	Logic Apps Yönetilen Kimliği ile oturum açma	Doğru
Azure AI Proje Uç Noktası	String	https://{account-name}.services.ai.azure.com/api/projects/{project-name} gibi Azure AI Proje Uç Noktasının adı	Doğru

Microsoft Entra Id Kullanıcı Oturum Açma

Kimlik Doğrulama Kimliği: entraIDUserLogin

Geçerli: Tüm bölgeler

Microsoft Entra Id Kimlik Bilgileri ile oturum açma

Bu, paylaşılabilir bir bağlantı değildir. Power app başka bir kullanıcıyla paylaşılıyorsa, başka bir kullanıcıdan açıkça yeni bağlantı oluşturması istenir.

İsim	Türü	Description	Gerekli
Azure AI Proje Uç Noktası	String	https://{account-name}.services.ai.azure.com/api/projects/{project-name} gibi Azure AI Proje Uç Noktasının adı	Doğru

Varsayılan [KULLANIM DIŞI]

Geçerli: Tüm bölgeler

Bu seçenek yalnızca açık kimlik doğrulama türü olmayan eski bağlantılar içindir ve yalnızca geriye dönük uyumluluk için sağlanır.

Bu, paylaşılabilir bir bağlantı değildir. Power app başka bir kullanıcıyla paylaşılıyorsa, başka bir kullanıcıdan açıkça yeni bağlantı oluşturması istenir.

Azaltma Sınırları

Name	Çağrılar	Yenileme Dönemi
Bağlantı başına API çağrıları	1000	60 saniye

Eylemler

Aracı tanımlayıcısı temelinde dış aracı etkinlik protokolü	Aracı tanımlayıcısı temelinde dış aracı etkinlik protokolü
Aracıyı Çağırma	Aracıyı çağırın.
İş Parçacığı Oluştur	İş Parçacığı Oluştur
Koşmaya Başla	Koşmaya Başla
Liste Aracıları	Liste Aracıları
Liste Mesajları	Liste Mesajları
Uygulamaya dayalı dış aracı etkinlik protokolü	Uygulamaya dayalı dış aracı etkinlik protokolü
Çalıştır Oluştur	Çalıştır Oluştur

Aracı tanımlayıcısı temelinde dış aracı etkinlik protokolü

İşlem Kimliği:

SendActivity

Aracı tanımlayıcısı temelinde dış aracı etkinlik protokolü

Parametreler

Name	Anahtar	Gerekli	Tür	Description
İleti gönderilecek aracının kimliği.	AgentId	True	string	İleti gönderilecek aracının kimliği.
			object

Döndürülenler

response

object

Aracıyı Çağırma

İşlem Kimliği:

InvokeAgent

Aracıyı çağırın.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
API sürümü	api-version	True	string	API sürümü
metadata	metadata		object	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.
user	user		string	OpenAI'nin kötüye kullanımı izlemesine ve algılamasına yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı. Daha fazla bilgi edinin.
top_logprobs	top_logprobs		integer	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ı.
previous_response_id	previous_response_id		string	Modele önceki yanıtın benzersiz kimliği. Çok aşamalı konuşmalar oluşturmak için bunu kullanın. Konuşma durumu hakkında daha fazla bilgi edinin.
arka plan	background		boolean	Model yanıtının arka planda çalıştırılıp çalıştırılmayacağı. Daha fazla bilgi edinin.
max_output_tokens	max_output_tokens		integer	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.
max_tool_calls	max_tool_calls		integer	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.
type	type	True	string	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. Yapılandırılmış Çıkışlar kılavuzunda daha fazla bilgi edinin. 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.
type	type	True	string	Yanıt oluşturmak için kullanılabilecek bir araç.
tool_choice	tool_choice			Modelin yanıt oluştururken kullanılacak aracı (veya araçları) seçmesi gerekir. Modelin hangi araçları çağırabileceğini belirtmek için tools parametresine bakın.
kimlik	id	True	string	Kullanılacak istem şablonunun benzersiz tanımlayıcısı.
version	version		string	İstem şablonunun isteğe bağlı sürümü.
variables	variables		object	İ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.
truncation	truncation		string	Model yanıtı için kullanılacak kesme stratejisi. auto: Bu yanıtın bağlamı ve öncekiler modelin bağlam penceresi boyutunu aşarsa, model konuşmanın ortasına giriş öğelerini bırakarak yanıtı bağlam penceresine uyacak şekilde kesecektir. disabled (varsayılan): Model yanıtı bir modelin bağlam penceresi boyutunu aşarsa istek 400 hatasıyla başarısız olur.
girdi	input			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 durumu İşlev çağrısı
include	include		string	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.
paralel araç çağrıları	parallel_tool_calls		boolean	Modelin araç çağrılarını paralel olarak çalıştırmasına izin verilip verilmeyeceği.
store	store		boolean	Oluşturulan model yanıtının daha sonra API ile alınabilmesi için depolanıp depolanmayacağı.
instructions	instructions		string	Modelin bağlamı içine eklenen bir sistem (veya geliştirici) iletisi. ile previous_response_idbirlikte kullanıldığında, önceki yanıttan alınan yönergeler sonraki yanıta taşınmaz. Bu, sistem (veya geliştirici) iletilerini yeni yanıtlarda değiştirme işlemini basitleştirir.
type	type	True	string
name	name	True	string	Aracının adı.
version	version	True	string	Aracının sürüm tanımlayıcısı.

Döndürülenler

Body

OpenAI.Response

İş Parçacığı Oluştur

İşlem Kimliği:

CreateThread

İş Parçacığı Oluştur

Parametreler

Name	Anahtar	Gerekli	Tür	Description
API sürümü	api-version	True	string	API sürümü
role	role		string	İletiyi oluşturan varlığın rolü. Kullanıcı veya yardımcı olabilir. 'user', iletinin gerçek bir kullanıcı tarafından gönderildiğini gösterir ve çoğu durumda kullanıcı tarafından oluşturulan iletileri temsil etmek için kullanılmalıdır. 'assistant', iletinin yardımcı tarafından oluşturulduğunu gösterir. Yardımcıdan konuşmaya ileti eklemek için bu değeri kullanın.
içerik	content		string	İletinin içeriği.
name	name		string	Çalıştırmada kullanılabilecek dosya kimliklerinin veya iletilerin listesi.
metadata	metadata		object	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, nesne hakkında ek bilgileri yapılandırılmış biçimde depolamak için yararlı olabilir. Anahtarlar en fazla 64 karakter uzunluğunda ve değerler en fazla 512 karakter uzunluğunda olabilir.
metadata	metadata		object	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, nesne hakkında ek bilgileri yapılandırılmış biçimde depolamak için yararlı olabilir. Anahtarlar en fazla 64 karakter uzunluğunda ve değerler en fazla 512 karakter uzunluğunda olabilir.
tool_resources	tool_resources		object	Bu iş parçacığında yardımcının araçlarının kullanımına sunulan bir kaynak kümesi. Kaynaklar araç türüne özeldir. Örneğin, code_interpreter aracı dosya kimliklerinin listesini gerektirirken, file_search aracı vektör deposu kimliklerinin listesini gerektirir.

Döndürülenler

Body

createThreadResponse

Koşmaya Başla

İşlem Kimliği:

GetRun

Koşmaya Başla

Parametreler

Name	Anahtar	Gerekli	Tür	Description
API sürümü	api-version	True	string	API sürümü
İleti oluşturulacak iş parçacığının kimliği.	ThreadId	True	string	İleti oluşturulacak iş parçacığının kimliği.
Çalıştırmanın kimliği.	RunId	True	string	Çalıştırmanın kimliği.

Döndürülenler

Body

getRunResponse

Liste Aracıları

İşlem Kimliği:

ListAgents

Liste Aracıları

Parametreler

Name	Anahtar	Gerekli	Tür	Description
API sürümü	api-version	True	string	API sürümü

Döndürülenler

Body

listAgentsResponse

Liste Mesajları

İşlem Kimliği:

ListMessages

Liste Mesajları

Parametreler

Name	Anahtar	Gerekli	Tür	Description
API sürümü	api-version	True	string	API sürümü
İleti oluşturulacak iş parçacığının kimliği.	ThreadId	True	string	İleti oluşturulacak iş parçacığının kimliği.

Döndürülenler

Body

listMessageResponse

Uygulamaya dayalı dış aracı etkinlik protokolü

İşlem Kimliği:

SendActivityApplication

Uygulamaya dayalı dış aracı etkinlik protokolü

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Aracı uygulaması.	MyApplication	True	string	Aracı uygulaması.
			object

Döndürülenler

response

object

Çalıştır Oluştur

İşlem Kimliği:

CreateRun

Çalıştır Oluştur

Parametreler

Name	Anahtar	Gerekli	Tür	Description
API sürümü	api-version	True	string	API sürümü
İleti oluşturulacak iş parçacığının kimliği.	ThreadId	True	string	İleti oluşturulacak iş parçacığının kimliği.
assistant_id	assistant_id	True	string	Bu çalıştırmayı yürütmek için kullanılacak yardımcının kimliği.
model	model		string	Bu çalıştırmayı yürütmek için kullanılacak model dağıtım adı. Sağlanırsa, yardımcının model dağıtım adını geçersiz kılar.
instructions	instructions		string	Yardımcının yönergelerini geçersiz kılar. Çalıştırma başına davranışı değiştirmek için kullanışlıdır.
additional_instructions	additional_instructions		string	Çalıştırma yönergelerinin sonuna ek yönergeler ekler.
role	role		string	İletiyi oluşturan varlığın rolü. Kullanıcı veya yardımcı olabilir. 'user', iletinin gerçek bir kullanıcı tarafından gönderildiğini gösterir ve çoğu durumda kullanıcı tarafından oluşturulan iletileri temsil etmek için kullanılmalıdır. 'assistant', iletinin yardımcı tarafından oluşturulduğunu gösterir. Yardımcıdan konuşmaya ileti eklemek için bu değeri kullanın.
içerik	content		string	İletinin içeriği.
name	name		string	Çalıştırmada kullanılabilecek dosya kimliklerinin veya iletilerin listesi.
metadata	metadata		object	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, nesne hakkında ek bilgileri yapılandırılmış biçimde depolamak için yararlı olabilir. Anahtarlar en fazla 64 karakter uzunluğunda ve değerler en fazla 512 karakter uzunluğunda olabilir.
name	name		string	Çalıştırmada kullanılabilecek araçların listesi.
metadata	metadata		object	Bir nesneye eklenmiş 16 anahtar-değer çifti kümesi. Tuş maksimum uzunluğu: 64 karakter, Değerler maksimum uzunluk: 512 karakter.
sıcaklık	temperature		number	Örnekleme sıcaklığı (0-2). Daha yüksek değerler (örneğin, 0,8) rastgeleliği artırır, daha düşük değerler (örneğin, 0,2) çıkışı daha belirleyici hale getirir.
top_p	top_p		number	Sıcaklığa alternatif çekirdek örneklemesi. 0,1, ilk 10% olasılık kütlesinin kabul edildiği anlamına gelir.
yayın akışı	stream		boolean	True ise, çalıştırma sırasında sunucu tarafından gönderilen olaylar olarak bir olay akışı döndürür ve 'data: [DONE]' iletisiyle sonlandırılır.
max_prompt_tokens	max_prompt_tokens		integer	Çalıştırmada kullanılabilecek en fazla tamamlanma belirteci sayısı. Aşılırsa, çalıştırma tamamlanmamış olarak biter.
max_completion_tokens	max_completion_tokens		integer	Çalıştırmada kullanılabilecek en fazla tamamlanma belirteci sayısı. Aşılırsa, çalıştırma tamamlanmamış olarak biter.
truncation_strategy	truncation_strategy		object	İlk bağlam penceresini yönetmek için çalıştırmadan önce bir iş parçacığının nasıl kesileceğini denetler.
tool_choice	tool_choice		object	Modelin hangi aracı çağırdığı denetler. Varsayılan olarak 'auto' ayarına sahiptir ve modelin karar vermesine olanak sağlar. Araç kullanımını devre dışı bırakmak için 'yok' olarak ayarlanabilir.
yanıt formatı	response_format		object	Çıkış biçimini belirtir. { 'type': 'json_object' } ayarı geçerli JSON yanıtları için JSON modunu etkinleştirir.

Döndürülenler

Body

createRunResponse

Tanımlar

listAgentsResponse

Name	Yol	Tür	Description
object	object	string	Yanıt nesnesi türünün ayrıntıları.
veriler	data	array of Data	Hizmet tarafından döndürülen iletilerin listesi.
ilk_kimlik	first_id	string	İlk kimliğin ayrıntıları.
son_kimlik	last_id	string	Son kimliğin ayrıntıları.
daha_fazla	has_more	boolean	Daha fazla aracı olup olmadığını bildirir.

createThreadResponse

Name	Yol	Tür	Description
kimlik	id	string	API uç noktalarında başvurulabilen tanımlayıcı.
object	object	string	Her zaman iş parçacığı olan nesne türü.
oluşturulma_tarihi	created_at	integer	İş parçacığının oluşturulduğu zaman için Unix zaman damgası (saniye olarak).
metadata	metadata	object	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, nesne hakkında ek bilgileri yapılandırılmış biçimde depolamak için yararlı olabilir. Anahtarlar en fazla 64 karakter uzunluğunda ve değerler en fazla 512 karakter uzunluğunda olabilir.

createRunResponse

Name	Yol	Tür	Description
kimlik	id	string	API uç noktalarında başvurulabilen tanımlayıcı.
object	object	string	Her zaman thread.run olan nesne türü.
oluşturulma_tarihi	created_at	integer	Çalıştırmanın oluşturulduğu zaman için Unix zaman damgası (saniye olarak).
thread_id	thread_id	string	Bu çalıştırmanın bir parçası olarak üzerinde yürütülen iş parçacığının kimliği.
assistant_id	assistant_id	string	Bu çalıştırmanın yürütülmesi için kullanılan yardımcının kimliği.
statü	status	string	Kuyruğa alınabilen, in_progress, requires_action, iptal edilebilen, iptal edilebilen, başarısız, tamamlanan veya süresi dolan çalıştırmanın durumu.
required_action	required_action	object	Çalıştırmaya devam etmek için gereken eylemle ilgili ayrıntılar. Eylem gerekmiyorsa null olur.
Son_hata	last_error	object	Bu çalıştırmayla ilişkili son hata. Hata yoksa null olur.
sona_erdigi_tarih	expires_at	integer	Çalıştırmanın süresinin dolacağı zaman için Unix zaman damgası (saniye olarak).
started_at	started_at	integer	Çalıştırmanın başlatıldığı zaman için Unix zaman damgası (saniye olarak).
iptal edildiğinde	cancelled_at	integer	Çalıştırmanın iptal edildiği zaman için Unix zaman damgası (saniye olarak).
başarısız_olduğunda	failed_at	integer	Çalıştırmanın başarısız olduğu zaman için Unix zaman damgası (saniye olarak).
tamamlanma_tarihi	completed_at	integer	Çalıştırmanın ne zaman tamamlandığına ilişkin Unix zaman damgası (saniye olarak).
model	model	string	Yardımcının bu çalıştırma için kullandığı model dağıtım adı.
instructions	instructions	string	Yardımcının bu çalıştırma için kullandığı yönergeler.
araçlar	tools	array of tools	Yardımcının bu çalıştırma için kullandığı araçların listesi.
dosya_kimlikleri	file_ids	array of fileIds	Yardımcının bu çalıştırma için kullandığı Dosya Kimlikleri listesi.
metadata	metadata	object	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Anahtarlar en fazla 64 karakter uzunluğunda olabilir ve değerler en fazla 512 karakter uzunluğunda olabilir.
tool_choice	tool_choice	object	Model tarafından çağrılan aracı (varsa) denetler. 'hiçbiri', modelin hiçbir araç çağırmayacağı ve bunun yerine bir ileti oluşturduğu anlamına gelir. 'auto', modelin ileti oluşturma veya araç çağırma arasında seçim yapabileceğiniz anlamına gelir. {'type': 'file_search'} veya {'type': 'function', 'function': {'name': 'my_function'}} gibi bir araç belirtilmesi modeli bu aracı çağırmaya zorlar.
max_prompt_tokens	max_prompt_tokens	number	Çalıştırma boyunca kullanılmak üzere belirtilen en fazla istem belirteci sayısı.
max_completion_tokens	max_completion_tokens	number	Çalıştırma boyunca kullanılmak üzere belirtilen en fazla tamamlanma belirteci sayısı.
usage	usage	object	Çalıştırmayla ilgili kullanım istatistikleri. Çalıştırma bir terminal durumunda değilse (örneğin, in_progress, kuyruğa alınmış) bu değer null olur.
truncation_strategy	truncation_strategy	object	Bir iş parçacığının çalıştırmadan önce nasıl kesildiğini denetler.
yanıt formatı	response_format	string	Modelin çıkışı gereken biçim. GPT-4 Turbo ve gpt-3.5-turbo-1106'dan bu yana tüm GPT-3.5 Turbo modelleri ile uyumludur.

getRunResponse

Name	Yol	Tür	Description
kimlik	id	string	API uç noktalarında başvurulabilen tanımlayıcı.
object	object	string	Her zaman thread.run olan nesne türü.
oluşturulma_tarihi	created_at	integer	Çalıştırmanın oluşturulduğu zaman için Unix zaman damgası (saniye olarak).
thread_id	thread_id	string	Bu çalıştırmanın bir parçası olarak üzerinde yürütülen iş parçacığının kimliği.
assistant_id	assistant_id	string	Bu çalıştırmanın yürütülmesi için kullanılan yardımcının kimliği.
statü	status	string	Kuyruğa alınabilen, in_progress, requires_action, iptal edilebilen, iptal edilebilen, başarısız, tamamlanan veya süresi dolan çalıştırmanın durumu.
required_action	required_action	object	Çalıştırmaya devam etmek için gereken eylemle ilgili ayrıntılar. Eylem gerekmiyorsa null olur.
Son_hata	last_error	object	Bu çalıştırmayla ilişkili son hata. Hata yoksa null olur.
sona_erdigi_tarih	expires_at	integer	Çalıştırmanın süresinin dolacağı zaman için Unix zaman damgası (saniye olarak).
started_at	started_at	integer	Çalıştırmanın başlatıldığı zaman için Unix zaman damgası (saniye olarak).
iptal edildiğinde	cancelled_at	integer	Çalıştırmanın iptal edildiği zaman için Unix zaman damgası (saniye olarak).
başarısız_olduğunda	failed_at	integer	Çalıştırmanın başarısız olduğu zaman için Unix zaman damgası (saniye olarak).
tamamlanma_tarihi	completed_at	integer	Çalıştırmanın ne zaman tamamlandığına ilişkin Unix zaman damgası (saniye olarak).
model	model	string	Yardımcının bu çalıştırma için kullandığı model dağıtım adı.
instructions	instructions	string	Yardımcının bu çalıştırma için kullandığı yönergeler.
araçlar	tools	array of tools	Yardımcının bu çalıştırma için kullandığı araçların listesi.
dosya_kimlikleri	file_ids	array of fileIds	Yardımcının bu çalıştırma için kullandığı Dosya Kimlikleri listesi.
metadata	metadata	object	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Anahtarlar en fazla 64 karakter uzunluğunda olabilir ve değerler en fazla 512 karakter uzunluğunda olabilir.
tool_choice	tool_choice	object	Model tarafından çağrılan aracı (varsa) denetler. 'hiçbiri', modelin hiçbir araç çağırmayacağı ve bunun yerine bir ileti oluşturduğu anlamına gelir. 'auto', modelin ileti oluşturma veya araç çağırma arasında seçim yapabileceğiniz anlamına gelir. {'type': 'file_search'} veya {'type': 'function', 'function': {'name': 'my_function'}} gibi bir araç belirtilmesi modeli bu aracı çağırmaya zorlar.
max_prompt_tokens	max_prompt_tokens	number	Çalıştırma boyunca kullanılmak üzere belirtilen en fazla istem belirteci sayısı.
max_completion_tokens	max_completion_tokens	number	Çalıştırma boyunca kullanılmak üzere belirtilen en fazla tamamlanma belirteci sayısı.
usage	usage	object	Çalıştırmayla ilgili kullanım istatistikleri. Çalıştırma bir terminal durumunda değilse (örneğin, in_progress, kuyruğa alınmış) bu değer null olur.
truncation_strategy	truncation_strategy	object	Bir iş parçacığının çalıştırmadan önce nasıl kesildiğini denetler.
yanıt formatı	response_format	string	Modelin çıkışı gereken biçim. GPT-4 Turbo ve gpt-3.5-turbo-1106'dan bu yana tüm GPT-3.5 Turbo modelleri ile uyumludur.

listMessageResponse

Name	Yol	Tür	Description
object	object	string	Yanıt nesnesi türünün ayrıntıları
veriler	data	array of Data	Hizmet tarafından döndürülen iletilerin listesi.
ilk_kimlik	first_id	string	İlk kimliğin ayrıntıları
son_kimlik	last_id	string	Son kimliğin ayrıntıları
daha_fazla	has_more	boolean	Daha fazla aracı olup olmadığını bildirir

Data

Name	Yol	Tür	Description
kimlik	id	string	API uç noktalarında başvurulabilen tanımlayıcı.
object	object	string	Her zaman yardımcı olan nesne türü.
oluşturulma_tarihi	created_at	integer	Yardımcının oluşturulduğu zaman için Unix zaman damgası (saniye olarak).
name	name	string	Asistanın adı. Uzunluk üst sınırı 256 karakterdir.
açıklama	description	string	Asistanın açıklaması. Uzunluk üst sınırı 512 karakterdir.
model	model	string	Kullanılacak model dağıtım adının adı.
instructions	instructions	string	Yardımcının kullandığı sistem yönergeleri. Uzunluk üst sınırı 32768 karakterdir.
araçlar	tools	array of tools	Yardımcıda etkinleştirilen araçların listesi. Yardımcı başına en fazla 128 araç olabilir. Araçlar code_interpreter veya işlev türünde olabilir. İşlev açıklaması en fazla 1.024 karakter olabilir.
metadata	metadata	object	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Ek bilgileri yapılandırılmış biçimde depolamak için kullanışlıdır. Anahtarlar en fazla 64 karakter uzunluğunda olabilir ve değerler en fazla 512 karakter uzunluğunda olabilir.
sıcaklık	temperature	number	Varsayılan değer 1'tir. 0 ile 2 arasında hangi örnekleme sıcaklığının kullanılacağını belirler. 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.
top_p	top_p	number	Varsayılan değer 1'tir. Modelin top_p olasılık kütlesine sahip belirteçlerin sonuçlarını dikkate aldığı, çekirdek örneklemesi olarak adlandırılan sıcaklıkla örneklemeye alternatiftir. Bu nedenle 0,1 yalnızca ilk %10 olasılık kütlesinden oluşan belirteçlerin dikkate alınması anlamına gelir.
yanıt formatı	response_format	object	Modelin çıkış yapması gereken biçimi belirtir. Bu parametrenin { 'type': 'json_object' } olarak ayarlanması JSON modunu etkinleştirir ve iletinin geçerli JSON olduğundan emin olur.
tool_resources	tool_resources	object	Yardımcının araçları tarafından kullanılan bir kaynak kümesi. Kaynaklar araç türüne özeldir. Örneğin, code_interpreter aracı dosya kimliklerinin listesini gerektirirken, file_search aracı vektör deposu kimliklerinin listesini gerektirir.

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.

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

string

OpenAI.Reasoning

yalnızca o serisi modeller

Mantık modelleri için yapılandırma seçenekleri.

Name	Yol	Tür	Description
effort	effort	string
summary	summary	string	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.
generate_summary	generate_summary	string	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.

OpenAI.ResponseTextFormatConfiguration

Name	Yol	Tür	Description
type	type	OpenAI.ResponseTextFormatConfigurationType	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. Yapılandırılmış Çıkışlar kılavuzunda daha fazla bilgi edinin. 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.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. Yapılandırılmış Çıkışlar kılavuzunda daha fazla bilgi edinin.

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.

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. Yapılandırılmış Çıkışlar kılavuzunda daha fazla bilgi edinin.

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.

string

OpenAI.Tool

Name	Yol	Tür	Description
type	type	OpenAI.ToolType	Yanıt oluşturmak için kullanılabilecek bir araç.

OpenAI.AraçTürü

Yanıt oluşturmak için kullanılabilecek bir araç.

Yanıt oluşturmak için kullanılabilecek bir araç.

string

OpenAI.Prompt

bir istem şablonuna ve değişkenlerine başvuru. Daha fazla bilgi edinin.

Name	Yol	Tür	Description
kimlik	id	string	Kullanılacak istem şablonunun benzersiz tanımlayıcısı.
version	version	string	İstem şablonunun isteğe bağlı sürümü.
variables	variables	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.

OpenAI.Response

Name	Yol	Tür	Description
metadata	metadata	object	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.
sıcaklık	temperature	float	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.
top_p	top_p	float	Modelin top_p olasılık kütlesine sahip belirteçlerin sonuçlarını dikkate aldığı, çekirdek örneklemesi olarak adlandırılan sıcaklıkla örneklemeye alternatiftir. Bu nedenle 0,1 yalnızca ilk %10 olasılık kütlesinden oluşan belirteçlerin dikkate alınması anlamına gelir. Genellikle bunu değiştirmenizi öneririz temperature ancak ikisini birden değiştirmemenizi öneririz.
user	user	string	OpenAI'nin kötüye kullanımı izlemesine ve algılamasına yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı. Daha fazla bilgi edinin.
hizmet seviyesi	service_tier	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.
top_logprobs	top_logprobs	integer	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ı.
previous_response_id	previous_response_id	string	Modele önceki yanıtın benzersiz kimliği. Çok aşamalı konuşmalar oluşturmak için bunu kullanın. Konuşma durumu hakkında daha fazla bilgi edinin.
model	model	string	Bu yanıtın oluşturulması için kullanılacak model dağıtımı.
reasoning	reasoning	OpenAI.Reasoning	yalnızca o serisi modeller Mantık modelleri için yapılandırma seçenekleri.
arka plan	background	boolean	Model yanıtının arka planda çalıştırılıp çalıştırılmayacağı. Daha fazla bilgi edinin.
max_output_tokens	max_output_tokens	integer	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.
max_tool_calls	max_tool_calls	integer	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.
format	text.format	OpenAI.ResponseTextFormatConfiguration
araçlar	tools	array of OpenAI.Tool	Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Parametresini ayarlayarak tool_choice hangi aracın kullanılacağını belirtebilirsiniz. Modeli sağlayabileceğiniz iki araç kategorisi şunlardır: Yerleşik araçlar: OpenAI tarafından sağlanan ve modelin web araması veya dosya arama gibi özelliklerini genişleten araçlar. Yerleşik araçlar hakkında daha fazla bilgi edinin. İşlev çağrıları (özel araçlar): Sizin tanımladığınız ve modelin kendi kodunuzu çağırmasını sağlayan işlevler. İşlev çağırma hakkında daha fazla bilgi edinin.
tool_choice	tool_choice		Modelin yanıt oluştururken kullanılacak aracı (veya araçları) seçmesi gerekir. Modelin hangi araçları çağırabileceğini belirtmek için tools parametresine bakın.
prompt	prompt	OpenAI.Prompt	bir istem şablonuna ve değişkenlerine başvuru. Daha fazla bilgi edinin.
truncation	truncation	string	Model yanıtı için kullanılacak kesme stratejisi. auto: Bu yanıtın bağlamı ve öncekiler modelin bağlam penceresi boyutunu aşarsa, model konuşmanın ortasına giriş öğelerini bırakarak yanıtı bağlam penceresine uyacak şekilde kesecektir. disabled (varsayılan): Model yanıtı bir modelin bağlam penceresi boyutunu aşarsa istek 400 hatasıyla başarısız olur.
kimlik	id	string	Bu Yanıt için benzersiz tanımlayıcı.
object	object	string	Bu kaynağın nesne türü - her zaman response olarak ayarlanır.
statü	status	string	Yanıt oluşturma durumu. completed, , failed, in_progress, cancelled, queuedveya incomplete.
oluşturulma_tarihi	created_at	unixtime	Bu Yanıtın oluşturulduğu unix zaman damgası (saniye).
hata	error	OpenAI.ResponseError	Model yanıt oluşturamadığında döndürülen bir hata nesnesi.
sebep	incomplete_details.reason	string	Yanıtın tamamlanmamış olmasının nedeni.
output	output	array of OpenAI.ItemResource	Model tarafından oluşturulan içerik öğeleri dizisi. Dizideki output öğelerin uzunluğu ve sırası modelin yanıtına bağlıdır. Dizideki output ilk öğeye erişmek ve bunun model tarafından oluşturulan içeriğe sahip bir assistant ileti olduğunu varsaymak yerine SDK'larda desteklenen özelliğini kullanmayı output_text düşünebilirsiniz.
instructions	instructions		Modelin bağlamı içine eklenen bir sistem (veya geliştirici) iletisi. ile previous_response_idbirlikte kullanıldığında, önceki yanıttan alınan yönergeler sonraki yanıta taşınmaz. Bu, sistem (veya geliştirici) iletilerini yeni yanıtlarda değiştirme işlemini basitleştirir.
output_text	output_text	string	SDK özellikli yalnızca kolaylık sağlayan bir özellik olan, varsa dizideki tüm output_text öğelerinin metin çıktılarını bir araya getiren output içeren özellik. Python ve JavaScript SDK'larında desteklenir.
usage	usage	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.
paralel araç çağrıları	parallel_tool_calls	boolean	Modelin araç çağrılarını paralel olarak çalıştırmasına izin verilip verilmeyeceği.
kimlik	conversation.id	string
temsilci	agent	AgentId

OpenAI.ResponseError

Model yanıt oluşturamadığında döndürülen bir hata nesnesi.

Name	Yol	Tür	Description
kod	code	OpenAI.ResponseErrorCode	Yanıtın hata kodu.
message	message	string	Hatanın insan tarafından okunabilen açıklaması.

OpenAI.ResponseErrorCode

Yanıtın hata kodu.

Yanıtın hata kodu.

string

OpenAI.ItemResource

Yanıt oluşturmak için kullanılan içerik öğesi.

Name	Yol	Tür	Description
type	type	OpenAI.ItemType
kimlik	id	string

OpenAI.ItemType

string

OpenAI.ResponseUsage

Giriş belirteçleri, çıkış belirteçleri, çıkış belirteçlerinin dökümü ve kullanılan toplam belirteçler dahil olmak üzere belirteç kullanım ayrıntılarını temsil eder.

Name	Yol	Tür	Description
input_tokens	input_tokens	integer	Giriş belirteçlerinin sayısı.
cached_tokens	input_tokens_details.cached_tokens	integer	Önbellekten alınan belirteçlerin sayısı. İstem önbelleğe alma hakkında daha fazla bilgi.
output_tokens	output_tokens	integer	Çıkış belirteçlerinin sayısı.
akıl yürütme birimleri	output_tokens_details.reasoning_tokens	integer	Akıl yürütme belirteçlerinin sayısı.
total_tokens	total_tokens	integer	Kullanılan toplam belirteç sayısı.

AgentId

Name	Yol	Tür	Description
type	type	string
name	name	string	Aracının adı.
version	version	string	Aracının sürüm tanımlayıcısı.

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.

Name	Yol	Tür	Description
		object	İ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.

araçlar

Name	Yol	Tür	Description
name	name	string	Çalıştırmada kullanılabilecek araçların listesi.

fileIds

Name	Yol	Tür	Description
name	name	string	Çalıştırmada kullanılabilecek dosya kimliklerinin listesi.

object

Bu , 'object' türüdür.