Azure OpenAI için Microsoft Foundry Models v1 REST API Referansı

v1 OpenAPI 3.0 spesifikasyonu

API Sürümü: v1

Sunucu Değişkenleri:

Variable	Varsayılan	Description
endpoint		Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com

Kimlik Doğrulaması

API anahtarı

Üst bilgiyle api-key bir API anahtarı geçirin.

Kimlik doğrulama belirteçleri

Üst bilgiyle bir kimlik doğrulama belirteci authorization geçirin.

Oauth2authoauth20

Akış: örtük

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

Kapsam:

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

Batch

Toplu iş oluşturma

POST {endpoint}/openai/v1/batches

Karşıya yüklenen istek dosyasından toplu iş oluşturur ve yürütür

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.

İstek Başlığı

İsim	Gerekli	Türü	Description
kabul et	Doğru	String Olası değerler: `application/json`

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli
tamamlama penceresi	enum	Toplu işlemin gerçekleştirileceği zaman dilimi. Şu anda yalnızca `24h` desteklenmektedir. Olası değerler: `24h`	Evet
endpoint	enum	Toplu işteki tüm istekler için kullanılacak uç nokta. Şu anda `/v1/chat/completions` desteklenmektedir. Olası değerler: `/v1/chat/completions`, `/v1/embeddings`	Evet
girdi_dosya_kimliği	String	Yeni toplu iş için istekleri içeren karşıya yüklenen bir dosyanın kimliği. Giriş dosyanız bir JSON dosyası olarak biçimlendirilmelidir, ve amacı `batch`ile karşıya yüklenmelidir.	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	nesne

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Toplu işleri listeleme

GET {endpoint}/openai/v1/batches

Kuruluşunuzun toplu işlemlerini listeleyin.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
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.
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
kabul et	Doğru	String Olası değerler: `application/json`

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Toplu işlemi alma

GET {endpoint}/openai/v1/batches/{batch_id}

Bir toplu iş alır.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
batch_id	path	Evet	String	Alınacak toplu işlemin kimliği.

İstek Başlığı

İsim	Gerekli	Türü	Description
kabul et	Doğru	String Olası değerler: `application/json`

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Toplu işlemi iptal et

POST {endpoint}/openai/v1/batches/{batch_id}/cancel

Devam eden bir toplu işlemi iptal eder.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
batch_id	path	Evet	String	İptal edilen toplu işlemin kimliği.

İstek Başlığı

İsim	Gerekli	Türü	Description
kabul et	Doğru	String Olası değerler: `application/json`

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Chat

Sohbet tamamlama işlemi oluşturma

POST {endpoint}/openai/v1/chat/completions

"Sohbet tamamlama işlemini oluşturur."

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli
audio	OpenAI.CreateChatCompletionRequestAudio veya null	Ses çıkışı parametreleri. ile ses çıkışı istendiğinde gereklidir `modalities: ["audio"]`.	Hayı
frekans cezası	sayı veya null	-2,0 ile 2,0 arasında bir sayı. Pozitif değerler, yeni belirteçleri temel alarak cezalandırmaktadır metindeki mevcut sıklıklarını koruyarak, modelin frekansını azaltarak aynı satırı birebir yineleme olasılığı.	Hayı
function_call	string veya OpenAI.ChatCompletionFunctionCallOption	yerine `tool_choice`kullanım dışı bırakıldı. Model tarafından çağrılan (varsa) işlevi denetler. `none` , modelin bir işlevi çağırmayacağı ve bunun yerine bir Mesaj. `auto` modelin ileti oluşturma veya arama arasında seçim yapabileceğiniz anlamına gelir fonksiyon. Belirli bir işlevin `{"name": "my_function"}` belirtilmesi, bu işlevi çağırmak için model. `none` , hiçbir işlev mevcut olmadığında varsayılan değerdir. `auto` varsayılan değerdir işlevleri mevcutsa.	Hayı
functions	OpenAI.ChatCompletionFunctions dizisi	yerine `tools`kullanım dışı bırakıldı. Modelin JSON girişleri oluşturabileceği işlevlerin listesi.	Hayı
logit önyargısı	object veya null	Belirtilen belirteçlerin tamamlanmada görünme olasılığını değiştirin. Belirteçleri (belirteç kimlikleri ile ilişkilendirilmiş) eşleyen bir JSON nesnesini kabul eder. belirteci) -100'den 100'e kadar ilişkili bir sapma değerine. Matematiksel sapma, örneklemeden önce model tarafından oluşturulan logit'lere eklenir. Tam etki modele göre değişiklik gösterir, ancak -1 ile 1 arasındaki değerler olmalıdır seçim olasılığını azaltmak veya artırmak; -100 veya 100 gibi değerler ilgili belirtecin yasaklanması veya özel olarak seçilmesine neden olmalıdır.	Hayı
logprobs	boole veya null	Çıkış belirteçlerinin günlük olasılıklarının geri döndürülüp döndürülmeyeceği. Doğruysa, her bir çıkış belirtecinin logaritmik olasılıklarını döndürür `content` `message`.	Hayı
max_completion_tokens	tamsayı veya null	Oluşturulabilecek belirteç sayısı için üst sınır. tamamlama, görünür çıkış belirteçleri ve mantık yürütme belirteçleri dahil.	Hayı
maksimum_token	tamsayı veya null	Sohbet tamamlandığında oluşturulabilecek en fazla belirteç sayısı. Bu değer, API aracılığıyla oluşturulan metnin maliyetlerini denetlemek için kullanılabilir. Bu değer `max_completion_tokens` lehine kullanım dışı bırakılmıştır ve o1 serisi modellerle uyumlu değildir.	Hayı
Mesajlar	OpenAI.ChatCompletionRequestMessage dizisi	Şu ana kadarki konuşmayı içeren iletilerin listesi. Duruma bağlı olarak Kullandığınız modele göre, farklı ileti türleri (modaliteler) desteklenir. metin, resim ve ses gibi.	Evet
metadata	OpenAI.Metadata veya null		Hayı
yöntemler	OpenAI.ResponseModalities	Modelin oluşturmasını istediğiniz çıkış türleri. Çoğu model, varsayılan olan metin oluşturabilir: `["text"]` Model `gpt-4o-audio-preview` ayrıca ses oluşturun. Bu modelin oluşturmasını istemek için hem metin hem de ses yanıtları için şunları kullanabilirsiniz: `["text", "audio"]`	Hayı
model	String	veya `gpt-4o`gibi `o3` yanıtı oluşturmak için kullanılan model kimliği. OpenAI farklı özelliklere, performansa sahip çok çeşitli modeller sunar özellikleri ve fiyat noktaları. Model kılavuzuna bakın seçeneğine gidin ve kullanılabilir modelleri karşılaştırın.	Evet
n	tamsayı veya null	Her bir giriş iletisi için üretilecek sohbet tamamlama seçenekleri sayısı. Tüm seçeneklerde oluşturulan belirteç sayısına göre ücretlendirileceğini unutmayın. Maliyetleri en aza indirmek için farklı `n` tutun`1`.	Hayı
paralel araç çağrıları	OpenAI.ParallelToolCalls	Araç kullanımı sırasında paralel işlev çağrısının etkinleştirilip etkinleştirilmeyileceği.	Hayı
prediction	OpenAI.PredictionContent	Bir metin dosyasının içeriği gibi statik tahmin edilen çıkış içeriği yeniden üretiliyor.	Hayı
└─ içerik	OpenAI.ChatCompletionRequestMessageContentPartText dizesi veya dizisi	Model yanıtı oluşturulurken eşleşmesi gereken içerik. Oluşturulan belirteçler bu içerikle eşleşirse tüm model yanıtı çok daha hızlı döndürülebilir.	Evet
└─ türü	enum	Sağlamak istediğiniz tahmin edilen içeriğin türü. Bu tür şu anda her zaman `content`. Olası değerler: `content`	Evet
varlık cezası	sayı veya null	-2,0 ile 2,0 arasında bir sayı. Pozitif değerler, yeni belirteçleri temel alarak cezalandırmaktadır metinde şu ana kadar görünseler bile modelin olasılığını artırır yeni konular hakkında konuşmak için.	Hayı
prompt_cache_key	String	OpenAI tarafından önbellek isabet hızlarınızı iyileştirmek amacıyla benzer isteklere yönelik yanıtları önbelleğe almak için kullanılır. `user` alanını değiştirir. Daha fazla bilgi edinin.	Hayı
prompt_cache_retention	dize veya null		Hayı
akıl yürütme çabası	OpenAI.ReasoningEffort	Akıl yürütmeye yönelik çabayı kısıtlar mantık modelleri. Şu anda desteklenen değerler `none`, `minimal`, `low`, `medium`, `high`, ve `xhigh`'dir. Azaltma muhakeme çabası daha hızlı yanıtlara ve daha az belirteç kullanılmasına neden olabilir bir yanıtta mantık yürütme. - `gpt-5.1` varsayılan olarak `none`öğesini kullanır ve mantık yürütmez. Desteklenen gerekçe değerleri `gpt-5.1none`, `low`, `medium`, ve `high`'dir. Araç çağrıları gpt-5.1'deki tüm akıl yürütme değerleri için desteklenir. - Tüm modeller varsayılan olarak akıl yürütme eforu olmadan `gpt-5.1` önce `medium` ve desteklemez`none`. - Model `gpt-5-pro` varsayılan olarak akıl yürütme eforunu kullanır (ve yalnızca destekler `high` ). - `xhigh` , sonrasındaki `gpt-5.1-codex-max`tüm modeller için desteklenir.	Hayı
yanıt formatı	OpenAI.CreateChatCompletionRequestResponseFormat	Modelin çıkış yapması gereken biçimi belirten bir nesne. Ayarı:`{ "type": "json_schema", "json_schema": {...} }` Modelin sağladığınız JSON ile eşleşmesini sağlayan Yapılandırılmış Çıkışlar Şema. Yapılandırılmış Çıkışlar'da daha fazla bilgi edinin kılavuzuna bakın. `{ "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ı
└─ türü	OpenAI.CreateChatCompletionRequestResponseFormatType		Evet
safety_identifier	String	OpenAI'nin kullanım ilkelerini ihlal eden uygulamanızın kullanıcılarını algılamaya yardımcı olmak için kullanılan kararlı tanımlayıcı. Kimlikler, her kullanıcıyı benzersiz olarak tanımlayan bir dize olmalıdır. Bize herhangi bir tanımlayıcı bilgi göndermemek için kullanıcı adını veya e-posta adresini karma olarak kullanmanızı öneririz. Daha fazla bilgi edinin.	Hayı
seed	tamsayı veya null	Bu özellik Beta sürümündedir. Belirtilirse sistemimiz, aynı ve parametrelere sahip yinelenen isteklerin aynı `seed` sonucu döndürmesi için belirleyici bir şekilde örneklemek için en iyi çabayı gösterir. Determinizm garanti değildir ve arka uçtaki `system_fingerprint` değişiklikleri izlemek için yanıt parametresine başvurmanız gerekir.	Hayı
stop	OpenAI.StopConfiguration	En son mantık modelleri `o3` ve `o4-mini`ile desteklenmez. API'nin başka belirteçler üretmeyi durduracağı en fazla dört dizi. Sanal Makineye (VM) bağlı bir veya birden çok işletim sistemi diski içerdiği için döndürülen metin durdurma sırasını içermez.	Hayı
store	boole veya null	Için bu sohbet tamamlama isteğinin çıkışını depolayıp depolamayacağınız model damıtma veya değerlendirme ürünlerinde kullanın.	Hayı
veri akışı	boole veya null	True olarak ayarlanırsa model yanıt verileri istemciye akışla aktarılır sunucu tarafından gönderilen olaylar kullanılarak oluşturulur.	Hayı
stream_options	OpenAI.ChatCompletionStreamOptions veya null		Hayı
sıcaklık	sayı veya null		Hayı
tool_choice	OpenAI.ChatCompletionToolChoiceOption	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. aracılığıyla `{"type": "function", "function": {"name": "my_function"}}` belirli bir aracın belirtilmesi, modeli söz konusu aracı çağırmaya zorlar. `none` hiçbir araç mevcut olmadığında varsayılan değerdir. `auto` araçlar varsa varsayılan değerdir.	Hayı
araçlar	OpenAI.ChatCompletionTool veya OpenAI.CustomToolChatCompletions dizisi	Modelin çağırabileceği araçların listesi. Aşağıdakilerden birini sağlayabilirsiniz: özel araçlar veya işlev araçları.	Hayı
top_logprobs	tamsayı veya null		Hayı
top_p	sayı veya null		Hayı
user	dize (kullanım dışı)	Son kullanıcınızı temsil eden benzersiz bir tanımlayıcı, bu, belirli hizmetler veya işlevlerde daha etkili olmanıza yardımcı olabilir. kötüye kullanımı izleme ve tespit etme.	Hayı
user_security_context	AzureUserSecurityContext	Kullanıcı güvenlik bağlamı, uygulamanın kendisini ve uygulamayla etkileşim kuran son kullanıcıyı tanımlayan çeşitli parametreler içerir. Bu alanlar, yapay zeka uygulamalarınızı korumaya yönelik kapsamlı bir yaklaşım sağlayarak güvenlik operasyonları ekiplerinizin güvenlik olaylarını araştırmalarına ve azaltmalarına yardımcı olur. Microsoft Defender for Cloud kullanarak yapay zeka uygulamalarını koruma hakkında daha fazla bilgi edinin.	Hayı
Ayrıntı	OpenAI.Verbosity	Modelin yanıtının çok fazla olduğunu sınırlar. Daha düşük değerler, daha kısa yanıtlar elde ederken, daha yüksek değerler daha ayrıntılı yanıtlara neden olur. Şu anda desteklenen değerler , `low`ve `medium`'tir`high`.	Hayı

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Örnekler

Example

POST {endpoint}/openai/v1/chat/completions

Tamamlamalar

Tamamlama oluşturma

POST {endpoint}/openai/v1/completions

Bir tamamlama oluşturur.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli
en iyi	tamsayı veya null	Tamamlamaları `best_of` sunucu tarafı oluşturur ve "en iyi" değerini (belirteç başına en yüksek günlük olasılığına sahip olan) döndürür. Sonuçlar akışla aktarılamaz. ile `n`kullanıldığında, `best_of` aday tamamlama sayısını denetler ve `n` döndürülecek sayısını belirtir; `best_of` değerinden `n`büyük olmalıdır. Not:* Bu parametre birçok tamamlama oluşturduğundan belirteç kotanızı hızla kullanabilir. dikkatle kullanın ve ve `max_tokens`için `stop` makul ayarlara sahip olduğunuzdan emin olun.	Hayı
echo	boole veya null	Tamamlamaya ek olarak istemi geri yankıla	Hayı
frekans cezası	sayı veya null	-2,0 ile 2,0 arasında bir sayı. Pozitif değerler, yeni belirteçleri metindeki mevcut sıklıklarına göre cezalandırarak modelin aynı satır açıklamasını yineleme olasılığını azaltarak. Sıklık ve iletişim durumu cezaları hakkında daha fazla bilgi edinin.	Hayı
logit önyargısı	object veya null	Belirtilen belirteçlerin tamamlanmada görünme olasılığını değiştirin. Belirteçleri (GPT belirteç oluşturucusunda belirteç kimliğiyle belirtilen) -100 ile 100 arasındaki ilişkili bir sapma değeriyle eşleyen bir JSON nesnesi kabul eder. Matematiksel olarak sapma, örneklemeden önce model tarafından oluşturulan logit'lere eklenir. Tam etki modele göre değişir, ancak -1 ile 1 arasındaki değerler seçim olasılığını azaltmalı veya artırmalıdır; -100 veya 100 gibi değerler, ilgili belirtecin yasaklanması veya özel olarak seçilmesiyle sonuçlanmalıdır. Örneğin, \|endoftext\|`{"50256": -100}` belirtecinin oluşturulmasını <önlemek için geçirebilirsiniz>.	Hayı
logprobs	tamsayı veya null	Günlük olasılıklarını `logprobs` en olası çıkış belirteçlerine ve seçilen belirteçlere ekleyin. Örneğin, 5 ise `logprobs` , API en olası beş belirtecin listesini döndürür. API her zaman örneklenen belirtecin değerini döndürür `logprob` , bu nedenle yanıtta en `logprobs+1` fazla öğe olabilir. için `logprobs` en büyük değer 5'tir.	Hayı
maksimum_token	tamsayı veya null	Tamamlanma sırasında oluşturulabilecek en fazla belirteç sayısı. İsteminizin ve artı `max_tokens` değerin belirteç sayısı modelin bağlam uzunluğunu aşamaz. Belirteçleri saymak için örnek Python kodu.	Hayı
model	String	Kullanılacak modelin kimliği. Kullanılabilir modellerinizin tümünü görmek için Model listesi API'sini kullanabilir veya bunların açıklamaları için Modele genel bakış bilgilerimize bakabilirsiniz.	Evet
n	tamsayı veya null	Her istem için kaç tamamlama oluşturulacağı. Not:* Bu parametre birçok tamamlama oluşturduğundan belirteç kotanızı hızla kullanabilir. dikkatle kullanın ve ve `max_tokens`için `stop` makul ayarlara sahip olduğunuzdan emin olun.	Hayı
varlık cezası	sayı veya null	-2,0 ile 2,0 arasında bir sayı. Pozitif değerler, yeni belirteçleri metinde şu ana kadar görünip görünmediklerine göre cezalandırarak modelin yeni konularla ilgili konuşma olasılığını artırır. Sıklık ve iletişim durumu cezaları hakkında daha fazla bilgi edinin.	Hayı
prompt	dize veya dize dizisi veya null		Hayı
seed	tamsayı veya null	Belirtilirse sistemimiz, aynı ve parametrelere sahip yinelenen isteklerin aynı `seed` sonucu döndürmesi için belirleyici bir şekilde örneklemek için en iyi çabayı gösterir. Determinizm garanti değildir ve arka uçtaki `system_fingerprint` değişiklikleri izlemek için yanıt parametresine başvurmanız gerekir.	Hayı
stop	OpenAI.StopConfiguration	En son mantık modelleri `o3` ve `o4-mini`ile desteklenmez. API'nin başka belirteçler üretmeyi durduracağı en fazla dört dizi. Sanal Makineye (VM) bağlı bir veya birden çok işletim sistemi diski içerdiği için döndürülen metin durdurma sırasını içermez.	Hayı
veri akışı	boole veya null	Kısmi ilerlemenin akışla geri aktarılıp aktarılmayacağı. Ayarlanırsa, belirteçler kullanılabilir hale geldikçe yalnızca veri sunucu tarafından gönderilen olaylar olarak gönderilir ve akış bir `data: [DONE]` ileti tarafından sonlandırılır. Örnek Python kodu.	Hayı
stream_options	OpenAI.ChatCompletionStreamOptions veya null		Hayı
suffix	dize veya null	Eklenen metnin tamamlanmasından sonra gelen sonek. Bu parametre yalnızca için `gpt-3.5-turbo-instruct`desteklenir.	Hayı
sıcaklık	sayı veya null	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ı
top_p	sayı veya null	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.	Hayı
user	String	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	nesne

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Örnekler

Example

POST {endpoint}/openai/v1/completions

Konteynerler

Kapsayıcıları listele

GET {endpoint}/openai/v1/containers

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
limit	soru	Hayı	tamsayı	Döndürülecek nesne sayısıyla ilgili bir sınır. Sınır 1 ile 100 arasında olabilir ve varsayılan değer 20'dir.
order	soru	Hayı	String Olası değerler: `asc`, `desc`	Düzeni nesnelerin zaman damgasına göre `created_at` sıralayın. `asc` artan sırayla ve `desc` azalan sırayla
after	soru	Hayı	String	Sayfalandırmada kullanılacak bir imleç. `after` , listedeki yerinizi tanımlayan bir nesne kimliğidir. Örneğin, bir liste isteğinde bulunur ve obj_foo ile biten 100 nesne alırsanız sonraki çağrı, listenin sonraki sayfasını getirmek için after=obj_foo içerebilir.
önce	soru	Hayı	String	Sayfalandırmada kullanılacak bir imleç. `before` , listedeki yerinizi tanımlayan bir nesne kimliğidir. Örneğin, bir liste isteğinde bulunur ve obj_foo ile biten 100 nesne alırsanız sonraki çağrı, listenin önceki sayfasını getirmek için before=obj_foo içerebilir.

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Kapsayıcı oluşturma

POST {endpoint}/openai/v1/containers

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli
sona_erdikten_sonra	OpenAI.CreateContainerBodyExpiresAfter		Hayı
└─ tutturucu	enum	Olası değerler: `last_active_at`	Evet
└─ dakika	tamsayı		Evet
dosya_kimlikleri	dize dizisi	Kapsayıcıya kopyalanacak dosyaların kimlikleri.	Hayı
bellek sınırı	enum	Kapsayıcı için isteğe bağlı bellek sınırı. Varsayılan olarak `1g` değerini alır. Olası değerler: `1g`, `4g`, `16g`, `64g`	Hayı
name	String	Oluşturulacak kapsayıcının adı.	Evet

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Kapsayıcıyı alma

GET {endpoint}/openai/v1/containers/{container_id}

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
container_id	path	Evet	String	Alınacak kapsayıcının kimliği.

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Kapsayıcıyı sil

DELETE {endpoint}/openai/v1/containers/{container_id}

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
container_id	path	Evet	String	Silinecek kapsayıcının kimliği.

Yanıtlar

Durum Kodu: 200

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Kapsayıcı dosyalarını listeleme

GET {endpoint}/openai/v1/containers/{container_id}/files

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
container_id	path	Evet	String	Dosyaları listelemek için kapsayıcını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.

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Kapsayıcı dosyası oluşturma

POST {endpoint}/openai/v1/containers/{container_id}/files

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
container_id	path	Evet	String	Içinde dosya oluşturulacak kapsayıcının kimliği.

İstek Gövdesi

İçerik Türü: çok parçalı/form-veri

İsim	Türü	Description	Gerekli	Varsayılan
dosya		Karşıya yüklenecek Dosya nesnesi (dosya adı değil).	Hayı
dosya_kimlik	String	Oluşturulacak dosyanın adı.	Hayı

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Kapsayıcı dosyasını alma

GET {endpoint}/openai/v1/containers/{container_id}/files/{file_id}

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
container_id	path	Evet	String	Konteynerin kimliği.
dosya_kimlik	path	Evet	String	Alınacak dosyanın kimliği.

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Kapsayıcı dosyasını silme

DELETE {endpoint}/openai/v1/containers/{container_id}/files/{file_id}

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
container_id	path	Evet	String	Konteynerin kimliği.
dosya_kimlik	path	Evet	String	Silinecek dosyanın kimliği.

Yanıtlar

Durum Kodu: 200

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Kapsayıcı dosyası içeriğini alma

GET {endpoint}/openai/v1/containers/{container_id}/files/{file_id}/content

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
container_id	path	Evet	String	Konteynerin kimliği.
dosya_kimlik	path	Evet	String	İçerik alınacak dosyanın kimliği.

Yanıtlar

Durum Kodu: 200

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

İçerik Türü	Türü	Açıklama
application/octet-stream	nesne

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Konuşma

Konuşma oluşturma

POST {endpoint}/openai/v1/conversations

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
items	OpenAI.InputItem dizisi veya null		Hayı
metadata	OpenAI.Metadata veya null		Hayı

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Konuşmayı alma

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
conversation_id	path	Evet	String	Alınacak konuşmanın kimliği.

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Konuşmayı güncelleştirme

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
conversation_id	path	Evet	String	Güncelleştirilecek konuşmanın kimliği.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
metadata	OpenAI.Metadata veya null	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.	Evet

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Konuşmayı silme

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
conversation_id	path	Evet	String	Silinecek konuşmanın kimliği.

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Konuşma öğelerini listeleme

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
conversation_id	path	Evet	String	Öğeleri listelemek için 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`	giriş öğelerini döndürme sırası. Varsayılan `desc` değeridir.
after	soru	Hayı	String	Sayfalandırmada kullanılan, sonra öğeleri listelemek için bir öğe kimliği.
include	soru	Hayı	dizi	Model yanıtına eklenecek ek çıktı verilerini belirtin.

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Konuşma öğeleri oluşturma

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
conversation_id	path	Evet	String	Öğenin ekleneceği konuşmanın kimliği.
include	soru	Hayı	dizi	Yanıta eklenecek ek alanlar.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
items	OpenAI.InputItem dizisi		Evet

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Konuşma öğesini alma

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
conversation_id	path	Evet	String	Öğeyi içeren konuşmanın kimliği.
item_id	path	Evet	String	Geri getirilecek öğenin kimliği.
include	soru	Hayı	dizi	Yanıta eklenecek ek alanlar.

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Konuşma öğesini silme

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
conversation_id	path	Evet	String	Öğeyi içeren konuşmanın kimliği.
item_id	path	Evet	String	Silinecek öğenin kimliği.

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Değerlendirmeler

Değerlendirmeleri listeleme

GET {endpoint}/openai/v1/evals

Proje için değerlendirmeleri listeleme.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
after	soru	Hayı	String	Önceki sayfalandırma isteğinin son değerlendirme tanımlayıcısı.
limit	soru	Hayı	tamsayı	Tek bir sayfalama yanıtında döndürülecek değerlendirme sayısına yönelik bir sınır.
order	soru	Hayı	String Olası değerler: `asc`, `desc`	Değerlendirmeler zaman damgasına göre sıralanır. Artan düzen için kullanın `asc` veya `desc` azalan düzen için.
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 için Zaman.

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Değerlendirme oluşturma

POST {endpoint}/openai/v1/evals

Modelin performansını test etmek için kullanılabilecek bir değerlendirmenin yapısını oluşturun.

Değerlendirme, bir dizi test ölçütü ve veri kaynağı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.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli
veri_kaynağı_yapılandırması	OpenAI.CreateEvalCustomDataSourceConfig veya OpenAI.CreateEvalLogsDataSourceConfig veya OpenAI.CreateEvalStoredCompletionsDataSourceConfig	Değerlendirme için kullanılan veri kaynağının yapılandırması çalışır. Değerlendirmede kullanılan verilerin şemasını dikte eder.	Evet
metadata	OpenAI.Metadata veya null		Hayı
name	String	Değerlendirmenin adı.	Hayı
durum kodu	enum	Olası değerler: `201`	Evet
test kriterleri	OpenAI.CreateEvalLabelModelGrader veya OpenAI.EvalGraderStringCheck ya da OpenAI.EvalGraderTextSimilarity veya OpenAI.EvalGraderPython ya da OpenAI.EvalGraderScoreModel veya EvalGraderEndpoint dizisi	Bu gruptaki tüm değerlendirme çalıştırmaları için değerlendirici listesi. Not verenler, gibi `{{item.variable_name}}`çift küme ayracı gösterimini kullanarak veri kaynağındaki değişkenlere başvurabilir. Modelin çıkışına başvurmak için ad alanını `sample` (örneğin, `{{sample.output_text}}`) kullanın.	Evet

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Değerlendirme verilerini al

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

Bir değerlendirmeyi kimliğine göre alın. Bir değerlendirmeyi kimliğine göre alır.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
eval_id	path	Evet	String

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Değerlendirmeyi güncelleştirme

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

Belirtilen değerlendirmenin seçilebilir, değiştirilebilir özelliklerini güncelleştirin.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
eval_id	path	Evet	String

İ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 olabilir yapılandırılmış bir nesneyle ilgili ek bilgileri depolamak için kullanışlıdır biçimlendirme ve API veya kontrol paneli aracılığıyla nesneleri sorgulama. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler dizelerdir en fazla 512 karakter uzunluğunda.	Hayı
name	String		Hayı

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Değerlendirmeyi sil

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

Belirtilen değerlendirmeyi silin.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
eval_id	path	Evet	String

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Değerlendirme çalıştırmalarını alma

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

Belirtilen değerlendirme için çalıştırmaların listesini alın.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
eval_id	path	Evet	String
after	soru	Hayı	String
limit	soru	Hayı	tamsayı
order	soru	Hayı	String Olası değerler: `asc`, `desc`
durum	soru	Hayı	String Olası değerler: `queued`, `in_progress`, `completed`, `canceled`, `failed`

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

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

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

Not verme sürecini başlatarak yeni bir değerlendirme süreci oluşturun.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
eval_id	path	Evet	String

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli
veri_kaynağı	OpenAI.CreateEvalJsonlRunDataSource veya OpenAI.CreateEvalCompletionsRunDataSource veya OpenAI.CreateEvalResponsesRunDataSource	Çalıştırmanın veri kaynağıyla ilgili ayrıntılar.	Evet
metadata	OpenAI.Metadata veya null		Hayı
name	String	Koşunun adı.	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	OpenAI.EvalRun

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Doğrulama çalışmasını al

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

Kimliğine göre belirli bir değerlendirme çalışmasını alın.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
eval_id	path	Evet	String
run_id	path	Evet	String

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Değerlendirme çalıştırmasını iptal et

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

Kimliğine göre belirli bir değerlendirme çalıştırmasını iptal etme.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
eval_id	path	Evet	String
run_id	path	Evet	String

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Değerlendirme çalıştırmayı sil

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

Belirli bir değerlendirme çalışmasını kimliğine göre silin.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
eval_id	path	Evet	String
run_id	path	Evet	String

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Değerlendirme çalıştırması çıkış öğelerini alma

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

Belirtilen değerlendirme çalıştırması için çıkış öğelerinin listesini alın.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
eval_id	path	Evet	String
run_id	path	Evet	String
after	soru	Hayı	String
limit	soru	Hayı	tamsayı
durum	soru	Hayı	String Olası değerler: `fail`, `pass`
order	soru	Hayı	String Olası değerler: `asc`, `desc`

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Değerlendirme çalıştırmasının çıkış öğesini al

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

Bir değerlendirme çalışmasından kimliğine göre belirli bir çıktı öğesini alın.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
eval_id	path	Evet	String
run_id	path	Evet	String
çıktı_öğe_kimliği	path	Evet	String

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Dosyalar

Dosya oluşturma

POST {endpoint}/openai/v1/files

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.

İstek Gövdesi

İçerik Türü: çok parçalı/form-veri

İsim	Türü	Description	Gerekli
sona_erdikten_sonra	nesne		Evet
└─ tutturucu	AzureFileExpiryAnchor		Evet
└─ saniye	tamsayı		Evet
dosya		Karşıya yüklenecek Dosya nesnesi (dosya adı değil).	Evet
purpose	enum	Yüklenen dosyanın amaçlanan amacı. Bunlardan biri: - `assistants`: Yardımcılar API'sinde kullanılır - `batch`: Batch API'sinde kullanılır - `fine-tune`: hassas ayarlama için kullanılır - `evals`: Değerlendirme veri kümeleri için kullanılır Olası değerler: `assistants`, `batch`, `fine-tune`, `evals`	Evet

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Örnekler

Example

POST {endpoint}/openai/v1/files

Dosyaları listeleme

GET {endpoint}/openai/v1/files

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
purpose	soru	Hayı	String
limit	soru	Hayı	tamsayı
order	soru	Hayı	String Olası değerler: `asc`, `desc`
after	soru	Hayı	String

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Dosyayı alma

GET {endpoint}/openai/v1/files/{file_id}

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
dosya_kimlik	path	Evet	String	Bu istek için kullanılacak dosyanın kimliği.

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Dosyayı sil

DELETE {endpoint}/openai/v1/files/{file_id}

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
dosya_kimlik	path	Evet	String	Bu istek için kullanılacak dosyanın kimliği.

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Dosyayı indirme

GET {endpoint}/openai/v1/files/{file_id}/content

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
dosya_kimlik	path	Evet	String	Bu istek için kullanılacak dosyanın kimliği.

Yanıtlar

Durum Kodu: 200

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

İçerik Türü	Türü	Açıklama
application/octet-stream	nesne

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Embeddings

Ekleme oluşturma

POST {endpoint}/openai/v1/embeddings

Giriş metnini temsil eden bir ekleme vektöru oluşturur.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli
dimensions	tamsayı	Sonuçta elde edilen çıktı eklemelerinin sahip olması gereken boyut sayısı. Yalnızca ve sonraki modellerde `text-embedding-3` desteklenir. Kısıtlamalar: dk: 1	Hayı
encoding_format	enum	Eklemelerin döndürüleceği biçim. veya `float`olabilir`base64`. Olası değerler: `float`, `base64`	Hayı
girdi	dize veya dize dizisi ya da tamsayı dizisi ya da dizi dizisi	Eklemek için metin girin, dize veya belirteç dizisi olarak kodlanmış. Tek bir isteğe birden çok giriş eklemek için bir dizi dize veya belirteç dizisi geçirin. Giriş, model için maksimum giriş belirteçlerini aşmamalıdır (tüm ekleme modelleri için 8.192 belirteç), boş bir dize olamaz ve herhangi bir dizi 2.048 boyut veya daha az olmalıdır. Belirteçleri saymak için örnek Python kodu. Giriş başına belirteç sınırına ek olarak, tüm ekleme modelleri tek bir istekteki tüm girişlerde toplanmış en fazla 300.000 belirteç gerektirir.	Evet
model	String	Kullanılacak modelin kimliği. Kullanılabilir modellerinizin tümünü görmek için Model listesi API'sini kullanabilir veya bunların açıklamaları için Modele genel bakış bilgilerimize bakabilirsiniz.	Evet
user	String	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.CreateEmbeddingResponse

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Örnekler

Example

POST {endpoint}/openai/v1/embeddings

Fine-tuning

Notlandırıcıyı çalıştır.

POST {endpoint}/openai/v1/fine_tuning/alpha/graders/run

Bir değerlendirme aracı çalıştırın.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli
Yol tesviye makinesi	OpenAI.GraderStringCheck veya OpenAI.GraderTextSimilarity veya OpenAI.GraderPython veya OpenAI.GraderScoreModel ya da OpenAI.GraderMulti veya GraderEndpoint	İnce ayar işi için kullanılan not veren.	Evet
öğe	OpenAI.RunGraderRequestItem		Hayı
model_sample	String	Değerlendirilecek model örneği. Bu değer bir alanı doldurmak için kullanılacak. ad alanı `sample` . Daha fazla ayrıntı için kılavuza bakın. `output_json` Model örneği bir geçerli JSON dizesi.	Evet

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Derecelendiriciyi doğrulama

POST {endpoint}/openai/v1/fine_tuning/alpha/graders/validate

Bir değerlendiriciyi doğrula.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
Yol tesviye makinesi	OpenAI.GraderStringCheck veya OpenAI.GraderTextSimilarity veya OpenAI.GraderPython veya OpenAI.GraderScoreModel ya da OpenAI.GraderMulti veya GraderEndpoint		Hayı

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

İnce ayar denetim noktası izinlerini listeleme

GET {endpoint}/openai/v1/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions

Denetim noktası izinlerini listeleme

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
ince_ayarlı_model_kontrol_noktası	path	Evet	String	İzinleri almak için hassas ayarlanmış model denetim noktasının kimliği.
project_id	soru	Hayı	String	İzinleri almak için projenin kimliği.
after	soru	Hayı	String	Önceki sayfalandırma isteğindeki son izin kimliğinin tanımlayıcısı.
limit	soru	Hayı	tamsayı	Alınacak izin sayısı.
order	soru	Hayı	String Olası değerler: `ascending`, `descending`	İzinlerin alındığı sıra.

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

İnce ayar denetim noktası izni oluşturma

POST {endpoint}/openai/v1/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions

Denetim noktası izinleri oluşturma

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
ince_ayarlı_model_kontrol_noktası	path	Evet	String	İzin oluşturmak için hassas ayarlanmış model denetim noktasının kimliği.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
project_ids	dize dizisi	Erişim vermek için proje tanımlayıcıları.	Evet

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

hassas ayarlama denetim noktası iznini silme

DELETE {endpoint}/openai/v1/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions/{permission_id}

Denetim noktası iznini silme

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
ince_ayarlı_model_kontrol_noktası	path	Evet	String	İzin silinecek ince ayarlı model denetim noktasının kimliği.
permission_id	path	Evet	String	Silinecek ince ayarlı model denetim noktası izninin kimliği.

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

İnce ayar işi oluşturma

POST {endpoint}/openai/v1/fine_tuning/jobs

Belirli bir veri kümesinden yeni bir modelin oluşturulması sürecine başlayan bir ince ayar görevi 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.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
hiper parametreler	OpenAI.CreateFineTuningJobRequestHyperparameters		Hayı
└─ yığın boyutu	dize veya tamsayı		Hayı	otomatik
└─ öğrenme oranı çarpanı	dize veya sayı		Hayı
└─ n_epochs	dize veya tamsayı		Hayı	otomatik
Entegrasyonlar	OpenAI.CreateFineTuningJobRequestIntegrations dizisi veya null	İnce ayar işiniz için etkinleştirmek üzere entegrasyonların listesi.	Hayı
metadata	OpenAI.Metadata veya null		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 yapılacak modelin adı. Aşağıdakilerden birini seçebilirsiniz: destekli modeller.	Evet
seed	tamsayı veya null	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	dize veya null	İ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ı
eğitim_dosyası	String	Eğitim verilerini içeren karşıya yüklenen bir dosyanın kimliği. Karşıya dosya yükleme hakkında bilgi için bkz. dosyayı karşıya yükleme. Veri kümeniz JSONL dosyası olarak biçimlendirilmelidir. Ayrıca, dosyanızı amacı `fine-tune`ile karşıya yüklemeniz gerekir. Dosyanın içeriği, modelin sohbet, tamamlanma biçimi veya ince ayar yönteminin tercih biçimini kullanıp kullanmama durumuna bağlı olarak farklılık göstermelidir. Daha fazla detay için ince ayar rehberi sayfasına bakınız.	Evet
doğrulama_dosyası	dize veya null	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, ... içinde görüntülenebilir. Ince ayar sonucu dosyası. Aynı veriler hem eğitme hem de doğrulama dosyalarında bulunmamalıdır. Veri kümeniz JSONL dosyası olarak biçimlendirilmelidir. Dosyanızı amacı `fine-tune`ile karşıya yüklemeniz gerekir. Daha fazla detay için ince ayar rehberi sayfasına bakınız.	Hayı

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

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

GET {endpoint}/openai/v1/fine_tuning/jobs

Kuruluşunuzun ince ayar işlerini listeleme

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
after	soru	Hayı	String	Önceki sayfalandırma isteğindeki son işin tanımlayıcısı.
limit	soru	Hayı	tamsayı	Geri alınacak ince ayar işleri sayısı.

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

hassas ayarlama işini alma

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
ince_ayarlama_iş_id	path	Evet	String	İnce ayar işinin kimliği.

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

İnce ayarlama işini iptal etme

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/cancel

Hassas ayarlama işini hemen iptal edin.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
ince_ayarlama_iş_id	path	Evet	String	İptal edilecek ince ayar görevinin kimliği.

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

İnce ayar iş denetim noktalarını listeleme

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
ince_ayarlama_iş_id	path	Evet	String	İnce ayar görevi için denetim noktalarını almak üzere iş 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ı.

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

İnce ayar - denetim noktasını kopyalama

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints/{fine_tuning_checkpoint_id}/copy

Verilen hedef hesapta ve bölgede bir ince ayar kontrol noktasının kopyasını oluşturur.

NOT: Bu Azure OpenAI API'si önizleme aşamasındadır ve değiştirilebilir.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
ince_ayarlama_iş_id	path	Evet	String
fine_tuning_checkpoint_id	path	Evet	String

İstek Başlığı

İsim	Gerekli	Türü	Description
aoai-copy-ft-checkpoints	Doğru	String Olası değerler: `preview`	AOAI önizleme özelliği olan modeller için denetim noktası kopyalama işlemlerine erişim sağlar. Bu özelliğin çalışması için 'aoai-copy-ft-checkpoints' üst bilgisinin 'önizleme' olarak ayarlanması gerekir.
kabul et	Doğru	String Olası değerler: `application/json`

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
destinationResourceId	String	Kopyalanacak hedef Kaynağın kimliği.	Evet
region	String	Modelin kopyalanması gereken bölge.	Evet

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

İnce ayar - denetim noktası alma

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints/{fine_tuning_checkpoint_id}/copy

İnce ayar kontrol noktası kopyasının durumunu sorgular.

NOT: Bu Azure OpenAI API'si önizleme aşamasındadır ve değiştirilebilir.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
ince_ayarlama_iş_id	path	Evet	String
fine_tuning_checkpoint_id	path	Evet	String

İstek Başlığı

İsim	Gerekli	Türü	Description
aoai-copy-ft-checkpoints	Doğru	String Olası değerler: `preview`	AOAI önizleme özelliği olan modeller için denetim noktası kopyalama işlemlerine erişim sağlar. Bu özelliğin çalışması için 'aoai-copy-ft-checkpoints' üst bilgisinin 'önizleme' olarak ayarlanması gerekir.
kabul et	Doğru	String Olası değerler: `application/json`

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

İnce ayar olaylarını listeleme

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/events

İnce ayar işi için durum güncellemelerini alın.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
ince_ayarlama_iş_id	path	Evet	String	İnce ayar işi olaylarını almak için işin kimliği (ID).
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ı.

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

İnce ayarlama işini duraklatma

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/pause

İnce ayar işini duraklat.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
ince_ayarlama_iş_id	path	Evet	String	Duraklatılacak olan ince ayar işinin kimliği.

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

hassas ayarlama işini sürdürme

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/resume

Duraklatılmış ince ayar işine devam et.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
ince_ayarlama_iş_id	path	Evet	String	Sürdürülecek ince ayar görevine ait kimlik numarası.

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Models

Modelleri listeleme

GET {endpoint}/openai/v1/models

Şu anda kullanılabilir olan modelleri listeler ve sahip ve kullanılabilirlik gibi her biri hakkında temel bilgiler sağlar.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Modeli alma

GET {endpoint}/openai/v1/models/{model}

Sahip ve izin gibi model hakkında temel bilgiler sağlayan bir model örneği alır.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
model	path	Evet	String	Bu istek için kullanılacak modelin kimliği.

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Modeli silme

DELETE {endpoint}/openai/v1/models/{model}

Model örneğini siler.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
model	path	Evet	String	Silinecek modelin kimliği.

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Gerçek zamanlı

Gerçek zamanlı arama oluşturma

POST {endpoint}/openai/v1/realtime/calls

WebRTC üzerinden yeni bir Gerçek Zamanlı API çağrısı oluşturun ve eş bağlantıyı tamamlamak için gereken SDP yanıtını alın.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.

İstek Gövdesi

İçerik Türü: çok parçalı/form-veri

İsim	Türü	Description	Gerekli	Varsayılan
Sdp	String	Arayan tarafından oluşturulan WebRTC Oturum Açıklaması Protokolü (SDP) teklifi.	Evet
oturum	OpenAI.RealtimeSessionCreateRequestGA	Gerçek zamanlı oturum nesnesi yapılandırması.	Hayı
└─ ses	OpenAI.RealtimeSessionCreateRequestGAAudio	Giriş ve çıkış sesi yapılandırması.	Hayı
└─ include	dize dizisi	Sunucu çıkışlarına eklenecek ek alanlar. `item.input_audio_transcription.logprobs`: Giriş ses transkripsiyonu için logprobs ekleyin.	Hayı
└─ yönerge	String	Varsayılan sistem talimatları (sistem iletisi), model çağrılarına önceden eklenir. Bu alan, istemcinin istenen yanıtlarda modele yol göstermesine olanak tanır. Modele yanıt içeriği ve biçimi (örneğin "son derece kısa", "harekete geçin", "iyi yanıt örnekleri verilmiştir" gibi) ve ses davranışı (örneğin" hızlı konuşma", "sesinize duygu ekleme", "sık sık gülme") hakkında bilgi verilebilir. Yönergelerin model tarafından takip edilmesi garanti değildir, ancak istenen davranışla ilgili modele rehberlik sağlar. Sunucunun, bu alan ayarlanmamışsa kullanılacak varsayılan talimatları belirlediğini ve oturumun başında olayda görüneceğini `session.created` unutmayın.	Hayı
└─ maksimum_çıkış_jetonları	integer (aşağıdaki geçerli modellere bakın)	Tek bir yardımcı yanıtı için en fazla çıkış belirteci sayısı, araç çağrıları dahil. 1 ile 4096 arasında bir tamsayı sağlayın çıkış belirteçlerini sınırlama veya `inf` bir verilen model. Varsayılan olarak `inf` değerini alır.	Hayı
└─ modeli	String	Bu oturum için kullanılan Gerçek zamanlı model.	Hayı
└─ output_modalities	dize dizisi	Modelin yanıt verebileceği modalite kümesi. Varsayılan olarak `["audio"]`öğesini belirtir. modelin ses ve transkript ile yanıt vermesini sağlayın. `["text"]` yapmak için kullanılabilir model yalnızca metinle yanıt verir. Hem hem de `textaudio` aynı anda istekte bulunmak mümkün değildir.	Hayı	['audio']
└─ istemi	OpenAI.Prompt	bir istem şablonuna ve değişkenlerine başvuru. Daha fazla bilgi edinin.	Hayı
└─ araç seçimi	OpenAI.ToolChoiceOptions veya OpenAI.ToolChoiceFunction veya OpenAI.ToolChoiceMCP	Modelin araçları seçme şekli. Dize modlarından birini sağlama veya belirli bir modu zorlama işlev/MCP aracı.	Hayı	otomatik
└─ araçları	OpenAI.RealtimeFunctionTool veya OpenAI.MCPTool dizisi	Modelde kullanılabilen araçlar.	Hayı
└─ izleme	string veya OpenAI.RealtimeSessionCreateRequestGATracing veya null	"" İzlemeyi devre dışı bırakmak için null olarak ayarlayın. Bir kez izleme bir oturum için etkinleştirilir, yapılandırma değiştirilemez. `auto` oturum için varsayılan değerlerle bir izleme oluşturur iş akışı adı, grup kimliği ve meta veriler.	Hayı	otomatik
└─ kısaltma	OpenAI.RealtimeTruncation	Konuşmadaki belirteç sayısı modelin giriş belirteci sınırını aştığında konuşma kesilir, yani iletiler (en eskisinden başlayarak) modelin bağlamında yer almayacaktır. En fazla 4.096 çıkış belirtecini içeren 32k bağlam modeli, kesme gerçekleşmeden önce bağlama yalnızca 28.224 belirteç içerebilir. İstemciler, belirteç kullanımını ve maliyetini denetlemenin etkili bir yolu olan daha düşük bir maksimum belirteç sınırıyla kesilme davranışını yapılandırabilir. İletiler bağlamın başından bırakıldığından, kesme işlemi bir sonraki dönüşte önbelleğe alınmış belirteç sayısını azaltır (önbelleği daraltma). Bununla birlikte, istemciler iletileri en büyük bağlam boyutunun bir bölümüne kadar saklayacak şekilde kesmeyi de yapılandırabilir; bu da gelecekteki kesmelere olan ihtiyacı azaltır ve böylece önbellek hızını artırır. Kesme tamamen devre dışı bırakılabilir, yani sunucu hiçbir zaman kesilmez, ancak konuşma modelin giriş belirteci sınırını aşarsa hata döndürür.	Hayı
└─ türü	enum	Oluşturulacak oturum türü. Her zaman `realtime` Gerçek Zamanlı API için. Olası değerler: `realtime`	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
application/sdp	String

Yanıt Üst Bilgileri:

Başlık	Türü	Description
location	String	Sonraki denetim istekleri için çağrı kimliğini içeren göreli URL.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Gerçek zamanlı aramayı kabul et

POST {endpoint}/openai/v1/realtime/calls/{call_id}/accept

Gelen SIP çağrısını kabul edin ve bunu işleyecek gerçek zamanlı oturumu yapılandırın.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
call_id	path	Evet	String	realtime.call.incoming web kancasında sağlanan çağrının tanımlayıcısı.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
audio	OpenAI.RealtimeSessionCreateRequestGAAudio		Hayı
└─ giriş	OpenAI.RealtimeSessionCreateRequestGAAudioInput		Hayı
└─ çıkış	OpenAI.RealtimeSessionCreateRequestGAAudioOutput		Hayı
include	dize dizisi	Sunucu çıkışlarına eklenecek ek alanlar. `item.input_audio_transcription.logprobs`: Giriş ses transkripsiyonu için logprobs ekleyin.	Hayı
instructions	String	Varsayılan sistem talimatları (sistem iletisi), model çağrılarına önceden eklenir. Bu alan, istemcinin istenen yanıtlarda modele yol göstermesine olanak tanır. Modele yanıt içeriği ve biçimi (örneğin "son derece kısa", "harekete geçin", "iyi yanıt örnekleri verilmiştir" gibi) ve ses davranışı (örneğin" hızlı konuşma", "sesinize duygu ekleme", "sık sık gülme") hakkında bilgi verilebilir. Yönergelerin model tarafından takip edilmesi garanti değildir, ancak istenen davranışla ilgili modele rehberlik sağlar. Sunucunun, bu alan ayarlanmamışsa kullanılacak varsayılan talimatları belirlediğini ve oturumun başında olayda görüneceğini `session.created` unutmayın.	Hayı
max_output_tokens	integer (aşağıdaki geçerli modellere bakın)	Tek bir yardımcı yanıtı için en fazla çıkış belirteci sayısı, araç çağrıları dahil. 1 ile 4096 arasında bir tamsayı sağlayın çıkış belirteçlerini sınırlama veya `inf` bir verilen model. Varsayılan olarak `inf` değerini alır.	Hayı
model	String	Bu oturum için kullanılan Gerçek zamanlı model.	Hayı
çıkış modaliteleri	dize dizisi	Modelin yanıt verebileceği modalite kümesi. Varsayılan olarak `["audio"]`öğesini belirtir. modelin ses ve transkript ile yanıt vermesini sağlayın. `["text"]` yapmak için kullanılabilir model yalnızca metinle yanıt verir. Hem hem de `textaudio` aynı anda istekte bulunmak mümkün değildir.	Hayı	['audio']
prompt	OpenAI.Prompt	bir istem şablonuna ve değişkenlerine başvuru. Daha fazla bilgi edinin.	Hayı
tool_choice	OpenAI.ToolChoiceOptions veya OpenAI.ToolChoiceFunction veya OpenAI.ToolChoiceMCP	Modelin araçları seçme şekli. Dize modlarından birini sağlama veya belirli bir modu zorlama işlev/MCP aracı.	Hayı
araçlar	OpenAI.RealtimeFunctionTool veya OpenAI.MCPTool dizisi	Modelde kullanılabilen araçlar.	Hayı
izleme	string veya OpenAI.RealtimeSessionCreateRequestGATracing veya null	"" İzlemeyi devre dışı bırakmak için null olarak ayarlayın. Bir kez izleme bir oturum için etkinleştirilir, yapılandırma değiştirilemez. `auto` oturum için varsayılan değerlerle bir izleme oluşturur iş akışı adı, grup kimliği ve meta veriler.	Hayı
truncation	OpenAI.RealtimeTruncation	Konuşmadaki belirteç sayısı modelin giriş belirteci sınırını aştığında konuşma kesilir, yani iletiler (en eskisinden başlayarak) modelin bağlamında yer almayacaktır. En fazla 4.096 çıkış belirtecini içeren 32k bağlam modeli, kesme gerçekleşmeden önce bağlama yalnızca 28.224 belirteç içerebilir. İstemciler, belirteç kullanımını ve maliyetini denetlemenin etkili bir yolu olan daha düşük bir maksimum belirteç sınırıyla kesilme davranışını yapılandırabilir. İletiler bağlamın başından bırakıldığından, kesme işlemi bir sonraki dönüşte önbelleğe alınmış belirteç sayısını azaltır (önbelleği daraltma). Bununla birlikte, istemciler iletileri en büyük bağlam boyutunun bir bölümüne kadar saklayacak şekilde kesmeyi de yapılandırabilir; bu da gelecekteki kesmelere olan ihtiyacı azaltır ve böylece önbellek hızını artırır. Kesme tamamen devre dışı bırakılabilir, yani sunucu hiçbir zaman kesilmez, ancak konuşma modelin giriş belirteci sınırını aşarsa hata döndürür.	Hayı
type	enum	Oluşturulacak oturum türü. Her zaman `realtime` Gerçek Zamanlı API için. Olası değerler: `realtime`	Evet

Yanıtlar

Durum Kodu: 200

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

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Gerçek zamanlı aramayı kapatma

POST {endpoint}/openai/v1/realtime/calls/{call_id}/hangup

SIP veya WebRTC üzerinden başlatılan etkin bir Gerçek Zamanlı API çağrısını sonlandırabilirsiniz.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
call_id	path	Evet	String	Çağrının tanımlayıcısı.

Yanıtlar

Durum Kodu: 200

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

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Gerçek zamanlı aramaya başvurma

POST {endpoint}/openai/v1/realtime/calls/{call_id}/refer

SIP REFER fiilini kullanarak etkin bir SIP çağrısını yeni bir hedefe aktarın.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
call_id	path	Evet	String	realtime.call.incoming web kancasında sağlanan çağrının tanımlayıcısı.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
target_uri	String	SIP Refer-To üst bilgisinde görünmesi gereken URI. Gibi değerleri destekler `tel:+14155550123` veya `sip:agent\@example.com`.	Evet

Yanıtlar

Durum Kodu: 200

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

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Gerçek zamanlı aramayı reddet

POST {endpoint}/openai/v1/realtime/calls/{call_id}/reject

Arayana bir SIP durum kodu döndürerek gelen SIP çağrısını reddedin.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
call_id	path	Evet	String	realtime.call.incoming web kancasında sağlanan çağrının tanımlayıcısı.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
status_code	tamsayı	Arayana geri gönderilecek SIP yanıt kodu. Varsayılan değer : `603` (Reddet) atlandığında.	Hayı

Yanıtlar

Durum Kodu: 200

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

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Gerçek zamanlı istemci gizli dizisi oluşturma

POST {endpoint}/openai/v1/realtime/client_secrets

İlişkili oturum yapılandırmasıyla Bir Gerçek zamanlı istemci gizli dizisi oluşturun.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
sona_erdikten_sonra	OpenAI.RealtimeCreateClientSecretRequestExpiresAfter		Hayı
└─ tutturucu	enum	Olası değerler: `created_at`	Hayı
└─ saniye	tamsayı	Kısıtlamalar: dk: 10, maksimum: 7200	Hayı	600
oturum	OpenAI.RealtimeSessionCreateRequestUnion		Hayı
└─ türü	OpenAI.RealtimeSessionCreateRequestUnionType		Evet

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Gerçek zamanlı oturum oluşturma

POST {endpoint}/openai/v1/realtime/sessions

Gerçek Zamanlı API ile istemci tarafı uygulamalarında kullanmak üzere kısa ömürlü bir API belirteci oluşturun.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
client_secret	OpenAI.RealtimeSessionCreateRequestClientSecret		Evet
└─ sona_erme_tarihi	tamsayı		Evet
└─ değer	String		Evet
input_audio_format	String	Giriş sesinin biçimi. Seçenekler , `pcm16`veya `g711_ulaw`şeklindedir`g711_alaw`.	Hayı
input_audio_transcription	OpenAI.RealtimeSessionCreateRequestInputAudioTranscription		Hayı
└─ modeli	String		Hayı
instructions	String	Varsayılan sistem talimatları (sistem iletisi), model çağrılarına önceden eklenir. Bu alan, istemcinin istenen yanıtlarda modele yol göstermesine olanak tanır. Modele yanıt içeriği ve biçimi (örneğin "son derece kısa", "harekete geçin", "iyi yanıt örnekleri verilmiştir" gibi) ve ses davranışı (örneğin" hızlı konuşma", "sesinize duygu ekleme", "sık sık gülme") hakkında bilgi verilebilir. Yönergelerin model tarafından takip edilmesi garanti değildir, ancak istenen davranışla ilgili modele rehberlik sağlar. Sunucunun, bu alan ayarlanmamışsa kullanılacak varsayılan talimatları belirlediğini ve oturumun başında olayda görüneceğini `session.created` unutmayın.	Hayı
max_response_output_tokens	integer (aşağıdaki geçerli modellere bakın)	Tek bir yardımcı yanıtı için en fazla çıkış belirteci sayısı, araç çağrıları dahil. 1 ile 4096 arasında bir tamsayı sağlayın çıkış belirteçlerini sınırlama veya `inf` bir verilen model. Varsayılan olarak `inf` değerini alır.	Hayı
yöntemler	dize dizisi	Modelin yanıt verebileceği modalite kümesi. Sesi devre dışı bırakmak için bunu ["text"] olarak ayarlayın.	Hayı	['text', 'audio']
output_audio_format	String	Çıkış sesinin biçimi. Seçenekler , `pcm16`veya `g711_ulaw`şeklindedir`g711_alaw`.	Hayı
prompt	OpenAI.Prompt	bir istem şablonuna ve değişkenlerine başvuru. Daha fazla bilgi edinin.	Hayı
speed	Numara	Modelin konuşulan yanıtının hızı. 1.0 varsayılan hızdır. 0,25 en düşük hız. 1,5 maksimum hızdır. Bu değer yalnızca değiştirilebilir yanıt devam ederken değil model dönüşleri arasında. Kısıtlamalar: dk: 0,25, maksimum: 1,5	Hayı	1
sıcaklık	Numara	[0,6, 1,2] ile sınırlı olan model için örnekleme sıcaklığı. Varsayılan değer 0,8'tir.	Hayı
tool_choice	String	Modelin araçları seçme şekli. Seçenekler : `auto`, `none`, `required`veya bir işlev belirtin.	Hayı
araçlar	OpenAI.RealtimeSessionCreateRequestTools dizisi	Modelde kullanılabilen araçlar (işlevler).	Hayı
izleme	dize veya nesne	İzleme için yapılandırma seçenekleri. İzlemeyi devre dışı bırakmak için null olarak ayarlayın. Bir kez izleme bir oturum için etkinleştirilir, yapılandırma değiştirilemez. `auto` oturum için varsayılan değerlerle bir izleme oluşturur iş akışı adı, grup kimliği ve meta veriler.	Hayı
truncation	OpenAI.RealtimeTruncation	Konuşmadaki belirteç sayısı modelin giriş belirteci sınırını aştığında konuşma kesilir, yani iletiler (en eskisinden başlayarak) modelin bağlamında yer almayacaktır. En fazla 4.096 çıkış belirtecini içeren 32k bağlam modeli, kesme gerçekleşmeden önce bağlama yalnızca 28.224 belirteç içerebilir. İstemciler, belirteç kullanımını ve maliyetini denetlemenin etkili bir yolu olan daha düşük bir maksimum belirteç sınırıyla kesilme davranışını yapılandırabilir. İletiler bağlamın başından bırakıldığından, kesme işlemi bir sonraki dönüşte önbelleğe alınmış belirteç sayısını azaltır (önbelleği daraltma). Bununla birlikte, istemciler iletileri en büyük bağlam boyutunun bir bölümüne kadar saklayacak şekilde kesmeyi de yapılandırabilir; bu da gelecekteki kesmelere olan ihtiyacı azaltır ve böylece önbellek hızını artırır. Kesme tamamen devre dışı bırakılabilir, yani sunucu hiçbir zaman kesilmez, ancak konuşma modelin giriş belirteci sınırını aşarsa hata döndürür.	Hayı
turn_detection	OpenAI.RealtimeSessionCreateRequestTurnDetection		Hayı
└─ ön_ek_yastıklama_ms	tamsayı		Hayı
└─ sessizlik_süresi_ms	tamsayı		Hayı
└─ eşik	Numara		Hayı
└─ türü	String		Hayı
type	enum	Olası değerler: `realtime`	Evet
voice	OpenAI.VoiceIdsShared		Hayı

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Gerçek zamanlı transkripsiyon oturumu oluşturma

POST {endpoint}/openai/v1/realtime/transcription_sessions

Gerçek zamanlı transkripsiyonlar için özel olarak Gerçek Zamanlı API ile istemci tarafı uygulamalarında kullanmak üzere kısa ömürlü bir API belirteci oluşturun.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli
include	dize dizisi	Transkripsiyona eklenecek öğe kümesi. Geçerli kullanılabilir öğeler şunlardır: `item.input_audio_transcription.logprobs`	Hayı
input_audio_format	enum	Giriş sesinin biçimi. Seçenekler , `pcm16`veya `g711_ulaw`şeklindedir`g711_alaw`. için `pcm16`, giriş sesi 24 kHz örnek hızında 16 bit PCM olmalıdır, tek kanallı (mono) ve küçük endian bayt sırası. Olası değerler: `pcm16`, `g711_ulaw`, `g711_alaw`	Hayı
input_audio_noise_reduction	OpenAI.RealtimeTranscriptionSessionCreateRequestInputAudioNoiseReduction		Hayı
└─ türü	OpenAI.NoiseReductionType	Gürültü azaltma türü. `near_field` kulaklık gibi yakın konuşan mikrofonlar için, `far_field` dizüstü bilgisayar veya konferans odası mikrofonları gibi uzak alan mikrofonları içindir.	Hayı
input_audio_transcription	OpenAI.AudioTranscription		Hayı
└─ dili	String	Giriş sesinin dili. giriş dilini sağlama ISO-639-1 (ör. `en`) biçimi doğruluğu ve gecikme süresini artırır.	Hayı
└─ modeli	String	Transkripsiyon için kullanılacak model. Geçerli seçenekler : `whisper-1`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`ve `gpt-4o-transcribe-diarize`. Konuşmacı etiketleriyle diarizasyona ihtiyacınız olduğunda kullanın `gpt-4o-transcribe-diarize` .	Hayı
└─ istemi	String	Modelin stiline kılavuzluk etmek veya önceki bir sese devam etmek için isteğe bağlı bir metin Segment. için`whisper-1`, istem anahtar sözcüklerin listesidir. Modeller için `gpt-4o-transcribe` (hariç `gpt-4o-transcribe-diarize`), istem boş bir metin dizesidir, örneğin "teknolojiyle ilgili sözcükleri bekleme".	Hayı
turn_detection	OpenAI.RealtimeTranscriptionSessionCreateRequestTurnDetection		Hayı
└─ ön_ek_yastıklama_ms	tamsayı		Hayı
└─ sessizlik_süresi_ms	tamsayı		Hayı
└─ eşik	Numara		Hayı
└─ türü	enum	Olası değerler: `server_vad`	Hayı
type	enum	Olası değerler: `transcription`	Evet

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Yanıtlar

Yanıt oluşturma

POST {endpoint}/openai/v1/responses

Model yanıtı oluşturur.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli
arka plan	boole veya null		Hayı
konuşma	OpenAI.ConversationParam veya null		Hayı
include	OpenAI.IncludeEnum veya null dizisi		Hayı
girdi	OpenAI.InputParam	Yanıt oluşturmak için kullanılan modele metin, görüntü veya dosya girişleri. Daha fazla bilgi edinin: - Metin girişleri ve çıktıları - Görüntü girişleri - Dosya girişleri - Konuşma durumu - fonksiyon çağırıyor	Hayı
instructions	dize veya null		Hayı
max_output_tokens	tamsayı veya null		Hayı
max_tool_calls	tamsayı veya null		Hayı
metadata	OpenAI.Metadata veya null		Hayı
model	String	veya `gpt-4o`gibi `o3` yanıtı oluşturmak için kullanılan model kimliği. OpenAI farklı özelliklere, performansa sahip çok çeşitli modeller sunar özellikleri ve fiyat noktaları. Model kılavuzuna bakın seçeneğine gidin ve kullanılabilir modelleri karşılaştırın.	Hayı
paralel araç çağrıları	boole veya null		Hayı
previous_response_id	dize veya null		Hayı
prompt	OpenAI.Prompt	bir istem şablonuna ve değişkenlerine başvuru. Daha fazla bilgi edinin.	Hayı
prompt_cache_key	String	OpenAI tarafından önbellek isabet hızlarınızı iyileştirmek amacıyla benzer isteklere yönelik yanıtları önbelleğe almak için kullanılır. `user` alanını değiştirir. Daha fazla bilgi edinin.	Hayı
prompt_cache_retention	dize veya null		Hayı
reasoning	OpenAI.Reasoning veya null		Hayı
safety_identifier	String	OpenAI'nin kullanım ilkelerini ihlal eden uygulamanızın kullanıcılarını algılamaya yardımcı olmak için kullanılan kararlı tanımlayıcı. Kimlikler, her kullanıcıyı benzersiz olarak tanımlayan bir dize olmalıdır. Bize herhangi bir tanımlayıcı bilgi göndermemek için kullanıcı adını veya e-posta adresini karma olarak kullanmanızı öneririz. Daha fazla bilgi edinin.	Hayı
store	boole veya null		Hayı
veri akışı	boole veya null		Hayı
stream_options	OpenAI.ResponseStreamOptions veya null		Hayı
sıcaklık	sayı veya null		Hayı
text	OpenAI.ResponseTextParam	Modelden metin yanıtı için yapılandırma seçenekleri. Düz olabilir metin veya yapılandırılmış JSON verileri. Daha fazla bilgi edinin: - Metin girişleri ve çıktıları - Yapılandırılmış Çıktılar	Hayı
tool_choice	OpenAI.ToolChoiceParam	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	OpenAI.ToolsArray	Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Siz parametresini ayarlayarak `tool_choice` hangi aracın kullanılacağını belirtebilir. Aşağıdaki araç kategorilerini destekliyoruz: - Yerleşik araçlar: OpenAI tarafından sağlanan ve işlevselliği genişleten araçlar modelin yetenekleri, örneğin web arama veya file search. Hakkında daha fazla bilgi edinin yerleşik araçlar. - MCP Araçları: Özel MCP sunucuları aracılığıyla üçüncü taraf sistemlerle tümleştirmeler veya Google Drive ve SharePoint gibi önceden tanımlanmış bağlayıcılar. Hakkında daha fazla bilgi edinin MCP Araçları. - İşlev çağrıları (özel araçlar): Sizin tanımladığınız işlevler, modelin kesin olarak yazılan bağımsız değişkenlerle kendi kodunuzu çağırmasını sağlama ve çıkışlarını seçin. Hakkında daha fazla bilgi edinin fonksiyon çağrısı. Ayrıca şunları da kullanabilirsiniz: kendi kodunuzu çağırmak için özel araçlar.	Hayı
top_logprobs	tamsayı veya null		Hayı
top_p	sayı veya null		Hayı
truncation	dize veya null		Hayı
user	dize (kullanım dışı)	Bu alan ve `safety_identifier`ile `prompt_cache_key` değiştiriliyor. Bunun yerine önbelleğe alma iyileştirmelerini korumak için kullanın `prompt_cache_key` . Son kullanıcılarınız için kararlı bir tanımlayıcı. Benzer istekleri daha iyi demetleyerek önbellek isabet oranlarını artırmak ve OpenAI'nin kötüye kullanımı algılayıp önlemesine yardımcı olmak için kullanılır. Daha fazla bilgi edinin.	Hayı

Yanıtlar

Durum Kodu: 200

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

İçerik Türü	Türü	Açıklama
uygulama/json	nesne
text/event-stream	nesne

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Örnekler

Example

POST {endpoint}/openai/v1/responses

Yanıtı al

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

Belirtilen ID numarası ile bir model tepkisi getirir.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
response_id	path	Evet	String
include[]	soru	Hayı	dizi	Yanıta eklenecek ek alanlar. Daha fazla bilgi için yukarıdaki Yanıt oluşturma için include parametresine bakın.
veri akışı	soru	Hayı	Boolean	true olarak ayarlanırsa, model yanıt verileri sunucu tarafından gönderilen olaylar kullanılarak oluşturulduğundan istemciye akışla gönderilir.
starting_after	soru	Hayı	tamsayı	Akışın başlatıldığı olayın sıra numarası.
include_obfuscation	soru	Hayı	Boolean	True olduğunda, akış gizleme etkinleştirilir. Akış gizleme, belirli yan kanal saldırılarına azaltma olarak yük boyutlarını normalleştirmek için akış deltası olaylarında bir `obfuscation` alana rastgele karakterler ekler. Bu gizleme alanları varsayılan olarak eklenir, ancak veri akışına az miktarda ek yük ekler. Uygulamanızla OpenAI API'si arasındaki ağ bağlantılarına güveniyorsanız bant genişliğini iyileştirmek için false olarak ayarlayabilirsiniz `include_obfuscation` .

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Yanıtı silme

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

Kimlik numarasına göre bir yanıtı siler.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
response_id	path	Evet	String

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Yanıtı iptal et

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

Verilen kimlikle bir model yanıtını iptal eder. Yalnızca arka plan parametresi true olarak ayarlanmış olarak oluşturulan yanıtlar iptal edilebilir.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
response_id	path	Evet	String

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Giriş öğelerini listeleme

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

Belirli bir yanıt için giriş öğelerinin listesini döndürür.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
response_id	path	Evet	String
limit	soru	Hayı	tamsayı	Döndürülecek nesne sayısıyla ilgili bir sınır. Sınır 1 ile 100 arasında olabilir ve varsayılan değer 20'dir.
order	soru	Hayı	String Olası değerler: `asc`, `desc`	Düzeni nesnelerin zaman damgasına göre `created_at` sıralayın. `asc` artan sırayla ve `desc` azalan sırayla
after	soru	Hayı	String	Sayfalandırmada kullanılacak bir imleç. `after` , listedeki yerinizi tanımlayan bir nesne kimliğidir. Örneğin, bir liste isteğinde bulunur ve obj_foo ile biten 100 nesne alırsanız sonraki çağrı, listenin sonraki sayfasını getirmek için after=obj_foo içerebilir.
önce	soru	Hayı	String	Sayfalandırmada kullanılacak bir imleç. `before` , listedeki yerinizi tanımlayan bir nesne kimliğidir. Örneğin, bir liste isteğinde bulunur ve obj_foo ile biten 100 nesne alırsanız sonraki çağrı, listenin önceki sayfasını getirmek için before=obj_foo içerebilir.

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Threads

İş parçacığı oluşturma

POST {endpoint}/openai/v1/threads

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli
Mesajlar	OpenAI.CreateMessageRequest dizisi	İş parçacığını başlatacak iletilerin listesi.	Hayı
metadata	OpenAI.Metadata veya null		Hayı
tool_resources	OpenAI.CreateThreadRequestToolResources veya null		Hayı

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Createthread ve run

POST {endpoint}/openai/v1/threads/runs

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli
assistant_id	String	Bu çalıştırmayı yürütmek için kullanılacak yardımcının kimliği.	Evet
instructions	dize veya null	Yardımcının varsayılan sistem iletisini geçersiz kılın. Bu, çalışma başına davranışı değiştirmek için kullanışlıdır.	Hayı
max_completion_tokens	tamsayı veya null	Çalıştırma boyunca kullanılabilecek en fazla tamamlanma belirteci sayısı. Çalıştırma, çalıştırmanın birden çok dönüşünde yalnızca belirtilen tamamlanma belirteçlerinin sayısını kullanmak için en iyi çabayı gösterir. Çalıştırma belirtilen tamamlanma belirteçlerinin sayısını aşarsa, çalıştırma durumu `incomplete`ile sona erer. Daha fazla bilgi için bkz. `incomplete_details`.	Hayı
max_prompt_tokens	tamsayı veya null	Çalıştırma boyunca kullanılabilecek en fazla istem belirteci sayısı. Çalıştırma, çalıştırmanın birden çok dönüşünde yalnızca belirtilen istem belirteci sayısını kullanmak için en iyi çabayı gösterir. Çalıştırma belirtilen istem belirteci sayısını aşarsa, çalıştırma durumu `incomplete`ile sona erer. Daha fazla bilgi için bkz. `incomplete_details`.	Hayı
metadata	OpenAI.Metadata veya null		Hayı
model	String	Bu çalıştırmayı yürütmek için kullanılacak Modelin kimliği. Burada bir değer sağlanırsa, yardımcıyla ilişkili modeli geçersiz kılar. Aksi takdirde, yardımcıyla ilişkili model kullanılır.	Hayı
paralel araç çağrıları	OpenAI.ParallelToolCalls	Araç kullanımı sırasında paralel işlev çağrısının etkinleştirilip etkinleştirilmeyileceği.	Hayı
yanıt formatı	OpenAI.AssistantsApiResponseFormatOption	Modelin çıkış yapması gereken biçimi belirtir. GPT-4o, GPT-4 Turbo ve tüm `gpt-3.5-turbo-1106`GPT-3.5 Turbo modelleri ile uyumludur. ayarı, `{ "type": "json_schema", "json_schema": {...} }` modelin sağlanan JSON şemanızla eşleşmesini sağlayan Yapılandırılmış Çıkışlar'ı etkinleştirir. Daha fazla bilgi için ayarı `{ "type": "json_object" }` , modelin oluşturduğu iletinin geçerli bir JSON olduğundan emin olan JSON modunu etkinleştirir. Önemli:* JSON modunu kullanırken, modele bir sistem veya kullanıcı iletisi aracılığıyla kendiniz JSON üretmesini de belirtmeniz gerekir . Bu olmadan model, nesil belirteç sınırına ulaşana kadar bitmeyen bir boşluk akışı oluşturabilir ve bu da uzun süre çalışan ve görünüşe göre "takılmış" bir istekle sonuçlanır. Ayrıca, neslin aşıldığını veya konuşmanın maksimum bağlam uzunluğunu aştığını `finish_reason="length"` gösteren ileti `max_tokens`içeriğinin kısmen kesilebileceğini unutmayın.	Hayı
veri akışı	boole veya null	ise `true`, Sunucu tarafından gönderilen farklı çalıştır olayları sırasında gerçekleşen olayların akışını döndürür ve Çalıştır bir iletiyle `data: [DONE]` bir terminal durumuna girdiğinde sonlandırılır.	Hayı
sıcaklık	sayı veya null	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.	Hayı
iplik	OpenAI.CreateThreadRequest	Yeni iş parçacığı oluşturma seçenekleri. Bir iş parçacığı çalıştırılırken iş parçacığı sağlanmadıysa isteğinde boş bir iş parçacığı oluşturulur.	Hayı
tool_choice	OpenAI.AssistantsApiToolChoiceOption	Model tarafından çağrılan aracı (varsa) denetler. `none` modelin herhangi bir araç çağırmayacağı ve bunun yerine bir ileti oluşturduğu anlamına gelir. `auto` varsayılan değerdir ve modelin ileti oluşturma veya bir veya daha fazla araç çağırma arasında seçim yapabileceğiniz anlamına gelir. `required` , modelin kullanıcıya yanıt vermeden önce bir veya daha fazla araç çağırması gerektiği anlamına gelir. veya gibi `{"type": "file_search"}{"type": "function", "function": {"name": "my_function"}}` belirli bir aracı belirtmek, modeli söz konusu aracı çağırmaya zorlar.	Hayı
tool_resources	OpenAI.CreateThreadAndRunRequestToolResources veya null	Yardımcının araçları tarafından kullanılan bir kaynak kümesi. Kaynaklar araç türüne özeldir. Örneğin, `code_interpreter` araç bir dosya kimlikleri listesi gerektirirken `file_search` , araç vektör deposu kimliklerinin listesini gerektirir.	Hayı
araçlar	OpenAI.AssistantTool dizisi	Yardımcının bu çalıştırma için kullanabileceği araçları geçersiz kılın. Bu, çalışma başına davranışı değiştirmek için kullanışlıdır.	Hayı
top_p	sayı veya null	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 veya sıcaklığı değiştirmenizi öneririz, ancak ikisini birden değiştirmemenizi öneririz.	Hayı
truncation_strategy	OpenAI.TruncationObject	Bir iş parçacığının çalıştırmadan önce nasıl kesileceğini denetler. Çalıştırmanın ilk bağlam penceresini denetlemek için bunu kullanın.	Hayı

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

İş parçacığını silme

DELETE {endpoint}/openai/v1/threads/{thread_id}

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
thread_id	path	Evet	String

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

İş parçacığını alma

GET {endpoint}/openai/v1/threads/{thread_id}

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
thread_id	path	Evet	String

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

İş parçacığını değiştirme

POST {endpoint}/openai/v1/threads/{thread_id}

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
thread_id	path	Evet	String

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
metadata	OpenAI.Metadata veya null		Hayı
tool_resources	OpenAI.ModifyThreadRequestToolResources veya null		Hayı

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

İletileri listeleme

GET {endpoint}/openai/v1/threads/{thread_id}/messages

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
thread_id	path	Evet	String
limit	soru	Hayı	tamsayı
order	soru	Hayı	String Olası değerler: `asc`, `desc`
after	soru	Hayı	String
önce	soru	Hayı	String
run_id	soru	Hayı	String

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

İleti oluştur

POST {endpoint}/openai/v1/threads/{thread_id}/messages

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
thread_id	path	Evet	String

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli
attachments	OpenAI.CreateMessageRequestAttachments dizisi veya null		Hayı
içerik	OpenAI.MessageContentImageFileObject veya OpenAI.MessageContentImageUrlObject veya OpenAI.MessageRequestContentTextObject dizesi veya dizisi		Evet
metadata	OpenAI.Metadata veya null		Hayı
role	enum	İletiyi oluşturan varlığın rolü. İzin verilen değerler şunlardır: - `user`: İletinin 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`: İletinin yardımcı tarafından oluşturulduğunu gösterir. Yardımcıdan konuşmaya ileti eklemek için bu değeri kullanın. Olası değerler: `user`, `assistant`	Evet

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

İletiyi sil

DELETE {endpoint}/openai/v1/threads/{thread_id}/messages/{message_id}

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
thread_id	path	Evet	String
message_id	path	Evet	String

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

İletiyi alma

GET {endpoint}/openai/v1/threads/{thread_id}/messages/{message_id}

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
thread_id	path	Evet	String
message_id	path	Evet	String

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

İletiyi değiştir

POST {endpoint}/openai/v1/threads/{thread_id}/messages/{message_id}

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
thread_id	path	Evet	String
message_id	path	Evet	String

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
metadata	OpenAI.Metadata veya null		Hayı

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Çalıştırma oluşturma

POST {endpoint}/openai/v1/threads/{thread_id}/runs

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
thread_id	path	Evet	String

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli
additional_instructions	dize veya null	Çalıştırma yönergelerinin sonuna ek yönergeler ekler. Bu, diğer yönergeleri geçersiz kılmadan çalıştırma başına davranışı değiştirmek için kullanışlıdır.	Hayı
additional_messages	OpenAI.CreateMessageRequest veya null dizisi	Çalıştırmayı oluşturmadan önce iş parçacığına ek iletiler ekler.	Hayı
assistant_id	String	Bu çalıştırmayı yürütmek için kullanılacak yardımcının kimliği.	Evet
instructions	dize veya null	Yardımcının yönergelerini geçersiz kılar. Bu, çalışma başına davranışı değiştirmek için kullanışlıdır.	Hayı
max_completion_tokens	tamsayı veya null	Çalıştırma boyunca kullanılabilecek en fazla tamamlanma belirteci sayısı. Çalıştırma, çalıştırmanın birden çok dönüşünde yalnızca belirtilen tamamlanma belirteçlerinin sayısını kullanmak için en iyi çabayı gösterir. Çalıştırma belirtilen tamamlanma belirteçlerinin sayısını aşarsa, çalıştırma durumu `incomplete`ile sona erer. Daha fazla bilgi için bkz. `incomplete_details`.	Hayı
max_prompt_tokens	tamsayı veya null	Çalıştırma boyunca kullanılabilecek en fazla istem belirteci sayısı. Çalıştırma, çalıştırmanın birden çok dönüşünde yalnızca belirtilen istem belirteci sayısını kullanmak için en iyi çabayı gösterir. Çalıştırma belirtilen istem belirteci sayısını aşarsa, çalıştırma durumu `incomplete`ile sona erer. Daha fazla bilgi için bkz. `incomplete_details`.	Hayı
metadata	OpenAI.Metadata veya null		Hayı
model	String	Bu çalıştırmayı yürütmek için kullanılacak Modelin kimliği. Burada bir değer sağlanırsa, yardımcıyla ilişkili modeli geçersiz kılar. Aksi takdirde, yardımcıyla ilişkili model kullanılır.	Hayı
paralel araç çağrıları	OpenAI.ParallelToolCalls	Araç kullanımı sırasında paralel işlev çağrısının etkinleştirilip etkinleştirilmeyileceği.	Hayı
akıl yürütme çabası	OpenAI.ReasoningEffort	Akıl yürütmeye yönelik çabayı kısıtlar mantık modelleri. Şu anda desteklenen değerler `none`, `minimal`, `low`, `medium`, `high`, ve `xhigh`'dir. Azaltma muhakeme çabası daha hızlı yanıtlara ve daha az belirteç kullanılmasına neden olabilir bir yanıtta mantık yürütme. - `gpt-5.1` varsayılan olarak `none`öğesini kullanır ve mantık yürütmez. Desteklenen gerekçe değerleri `gpt-5.1none`, `low`, `medium`, ve `high`'dir. Araç çağrıları gpt-5.1'deki tüm akıl yürütme değerleri için desteklenir. - Tüm modeller varsayılan olarak akıl yürütme eforu olmadan `gpt-5.1` önce `medium` ve desteklemez`none`. - Model `gpt-5-pro` varsayılan olarak akıl yürütme eforunu kullanır (ve yalnızca destekler `high` ). - `xhigh` , sonrasındaki `gpt-5.1-codex-max`tüm modeller için desteklenir.	Hayı
yanıt formatı	OpenAI.AssistantsApiResponseFormatOption	Modelin çıkış yapması gereken biçimi belirtir. GPT-4o, GPT-4 Turbo ve tüm `gpt-3.5-turbo-1106`GPT-3.5 Turbo modelleri ile uyumludur. ayarı, `{ "type": "json_schema", "json_schema": {...} }` modelin sağlanan JSON şemanızla eşleşmesini sağlayan Yapılandırılmış Çıkışlar'ı etkinleştirir. Daha fazla bilgi için ayarı `{ "type": "json_object" }` , modelin oluşturduğu iletinin geçerli bir JSON olduğundan emin olan JSON modunu etkinleştirir. Önemli:* JSON modunu kullanırken, modele bir sistem veya kullanıcı iletisi aracılığıyla kendiniz JSON üretmesini de belirtmeniz gerekir . Bu olmadan model, nesil belirteç sınırına ulaşana kadar bitmeyen bir boşluk akışı oluşturabilir ve bu da uzun süre çalışan ve görünüşe göre "takılmış" bir istekle sonuçlanır. Ayrıca, neslin aşıldığını veya konuşmanın maksimum bağlam uzunluğunu aştığını `finish_reason="length"` gösteren ileti `max_tokens`içeriğinin kısmen kesilebileceğini unutmayın.	Hayı
veri akışı	boole veya null	ise `true`, Sunucu tarafından gönderilen farklı çalıştır olayları sırasında gerçekleşen olayların akışını döndürür ve Çalıştır bir iletiyle `data: [DONE]` bir terminal durumuna girdiğinde sonlandırılır.	Hayı
sıcaklık	sayı veya null	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.	Hayı
tool_choice	OpenAI.AssistantsApiToolChoiceOption	Model tarafından çağrılan aracı (varsa) denetler. `none` modelin herhangi bir araç çağırmayacağı ve bunun yerine bir ileti oluşturduğu anlamına gelir. `auto` varsayılan değerdir ve modelin ileti oluşturma veya bir veya daha fazla araç çağırma arasında seçim yapabileceğiniz anlamına gelir. `required` , modelin kullanıcıya yanıt vermeden önce bir veya daha fazla araç çağırması gerektiği anlamına gelir. veya gibi `{"type": "file_search"}{"type": "function", "function": {"name": "my_function"}}` belirli bir aracı belirtmek, modeli söz konusu aracı çağırmaya zorlar.	Hayı
araçlar	OpenAI.AssistantTool dizisi	Yardımcının bu çalıştırma için kullanabileceği araçları geçersiz kılın. Bu, çalışma başına davranışı değiştirmek için kullanışlıdır.	Hayı
top_p	sayı veya null	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 veya sıcaklığı değiştirmenizi öneririz, ancak ikisini birden değiştirmemenizi öneririz.	Hayı
truncation_strategy	OpenAI.TruncationObject	Bir iş parçacığının çalıştırmadan önce nasıl kesileceğini denetler. Çalıştırmanın ilk bağlam penceresini denetlemek için bunu kullanın.	Hayı

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Liste çalıştırmaları

GET {endpoint}/openai/v1/threads/{thread_id}/runs

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
thread_id	path	Evet	String
limit	soru	Hayı	tamsayı
order	soru	Hayı	String Olası değerler: `asc`, `desc`
after	soru	Hayı	String
önce	soru	Hayı	String

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Çalıştırmayı alma

GET {endpoint}/openai/v1/threads/{thread_id}/runs/{run_id}

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
thread_id	path	Evet	String
run_id	path	Evet	String

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Çalıştırmayı değiştirme

POST {endpoint}/openai/v1/threads/{thread_id}/runs/{run_id}

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
thread_id	path	Evet	String
run_id	path	Evet	String

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
metadata	OpenAI.Metadata veya null		Hayı

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Çalıştırmayı iptal et

POST {endpoint}/openai/v1/threads/{thread_id}/runs/{run_id}/cancel

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
thread_id	path	Evet	String
run_id	path	Evet	String

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Çalıştırma adımlarını listeleme

GET {endpoint}/openai/v1/threads/{thread_id}/runs/{run_id}/steps

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
thread_id	path	Evet	String
run_id	path	Evet	String
limit	soru	Hayı	tamsayı
order	soru	Hayı	String Olası değerler: `asc`, `desc`
after	soru	Hayı	String
önce	soru	Hayı	String

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Çalıştırma adımlarını alma

GET {endpoint}/openai/v1/threads/{thread_id}/runs/{run_id}/steps/{step_id}

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
thread_id	path	Evet	String
run_id	path	Evet	String
step_id	path	Evet	String

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Çalıştırılacak araç çıkışlarını gönderme

POST {endpoint}/openai/v1/threads/{thread_id}/runs/{run_id}/submit_tool_outputs

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
thread_id	path	Evet	String
run_id	path	Evet	String

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
veri akışı	boole veya null		Hayı
tool_outputs	OpenAI.SubmitToolOutputsRunRequestToolOutputs dizisi	Çıkışların gönderildiği araçların listesi.	Evet

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Vektör Depoları

Vektör depolarını listeleme

GET {endpoint}/openai/v1/vector_stores

Vektör depolarının listesini döndürür.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
limit	soru	Hayı	tamsayı	Döndürülecek nesne sayısıyla ilgili bir sınır. Sınır 1 ile 100 arasında olabilir ve varsayılan değer 20'dir.
order	soru	Hayı	String Olası değerler: `asc`, `desc`	Düzeni nesnelerin zaman damgasına göre `created_at` sıralayın. `asc` artan sırayla ve `desc` azalan sırayla
after	soru	Hayı	String	Sayfalandırmada kullanılacak bir imleç. `after` , listedeki yerinizi tanımlayan bir nesne kimliğidir. Örneğin, bir liste isteğinde bulunur ve obj_foo ile biten 100 nesne alırsanız sonraki çağrı, listenin sonraki sayfasını getirmek için after=obj_foo içerebilir.
önce	soru	Hayı	String	Sayfalandırmada kullanılacak bir imleç. `before` , listedeki yerinizi tanımlayan bir nesne kimliğidir. Örneğin, bir liste isteğinde bulunur ve obj_foo ile biten 100 nesne alırsanız sonraki çağrı, listenin önceki sayfasını getirmek için before=obj_foo içerebilir.

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Vektör deposu oluşturma

POST {endpoint}/openai/v1/vector_stores

Vektör deposu oluşturur.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli
chunking_strategy	OpenAI.ChunkingStrategyRequestParam	Dosya/dosyaları öbeklemek için kullanılan öbekleme stratejisi. Ayarlanmadıysa, stratejiyi `auto` kullanır. Yalnızca `file_ids` boş değilse geçerlidir.	Hayı
açıklama	String	Vektör deposu için bir açıklama. Vektör deposunun amacını açıklamak için kullanılabilir.	Hayı
sona_erdikten_sonra	OpenAI.VectorStoreExpirationAfter	Vektör deposu için sona erme politikası.	Hayı
dosya_kimlikleri	dize dizisi	Vektör deposunun kullanması gereken Dosya Kimliklerinin listesi. Dosyalara erişebilecek gibi `file_search` araçlar için kullanışlıdır.	Hayı
metadata	OpenAI.Metadata veya null		Hayı
name	String	Vektör deposunun adı.	Hayı

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Örnekler

Example

POST {endpoint}/openai/v1/vector_stores

Vektör deposunu al

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}

Bir vektör deposu alır.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
vektör_depolama_kimliği	path	Evet	String	Erişilecek vektör deposunun ID'si.

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Vektör depolarını değiştirme

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}

Vektör deposunu değiştirir.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
vektör_depolama_kimliği	path	Evet	String	Değiştirileceği vektör deposunun kimliği.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli
sona_erdikten_sonra	OpenAI.VectorStoreExpirationAfter	Vektör deposu için sona erme politikası.	Hayı
metadata	OpenAI.Metadata veya null		Hayı
name	dize veya null	Vektör deposunun adı.	Hayı

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Vektör depolarını silme

DELETE {endpoint}/openai/v1/vector_stores/{vector_store_id}

Vektör deposunu sil.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
vektör_depolama_kimliği	path	Evet	String	Silinecek vektör deposunun kimliği.

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Toplu vektör deposu dosyası oluşturma

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches

Vektör depo toplu işlem dosyası oluşturun.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
vektör_depolama_kimliği	path	Evet	String	Dosya toplu işleminin oluşturulacağı vektör deposunun kimliği.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli
attributes	OpenAI.VectorStoreFileAttributes veya null		Hayı
chunking_strategy	OpenAI.ChunkingStrategyRequestParam	Dosya/dosyaları öbeklemek için kullanılan öbekleme stratejisi. Ayarlanmadıysa, stratejiyi `auto` kullanır. Yalnızca `file_ids` boş değilse geçerlidir.	Hayı
dosya_kimlikleri	dize dizisi	Vektör deposunun kullanması gereken Dosya Kimliklerinin listesi. Dosyalara erişebilecek gibi `file_search` araçlar için kullanışlıdır. Sağlanmış veya `chunking_strategy` sağlanmışsa`attributes`, bunlar toplu işteki tüm dosyalara uygulanır. `files` ile birbirini dışlar.	Hayı
files	OpenAI.CreateVectorStoreFileRequest dizisi	Her biri artı isteğe bağlı `attributes` veya `chunking_strategy`içeren `file_id` nesnelerin listesi. Belirli dosyalar için meta verileri geçersiz kılmanız gerektiğinde bunu kullanın. Genel `attributes` veya `chunking_strategy` yoksayılır ve her dosya için belirtilmelidir. `file_ids` ile birbirini dışlar.	Hayı

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Vektör deposu dosya kümesini al

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}

Vektör deposu dosya kümesini alır.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
vektör_depolama_kimliği	path	Evet	String	Dosya toplu işleminin ait olduğu vektör deposunun kimliği.
batch_id	path	Evet	String	Edinilen dosya kümesinin kimliği.

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Vektör depolama dosyası toplu işlemini iptal etme

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel

Vektör depolama dosya grubunu iptal et. Bu, bu toplu işteki dosyaların işlenmesini mümkün olan en kısa sürede iptal etmeye çalışır.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
vektör_depolama_kimliği	path	Evet	String	Dosya toplu işleminin ait olduğu vektör deposunun kimliği.
batch_id	path	Evet	String	İptal edilecek dosya kümesinin kimliği.

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Vektör deposu toplu işleminde dosyaları listeleme

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/files

Toplu işlemdeki vektör deposu dosyalarının listesini döndürür.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
vektör_depolama_kimliği	path	Evet	String	Dosya toplu işleminin ait olduğu vektör deposunun kimliği.
batch_id	path	Evet	String	Dosyaların ait olduğu dosya partisinin 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.
filtre	soru	Hayı	String Olası değerler: `in_progress`, `completed`, `failed`, `cancelled`	Dosya durumuna göre filtreleyin. `in_progress`, `completed`, `failed` veya `cancelled`'den biri.

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Vektör deposu dosyalarını listeleme

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/files

Vektör deposu dosyalarının listesini döndürür.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
vektör_depolama_kimliği	path	Evet	String	Dosyaların ait olduğu vektör deposunun 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.
filtre	soru	Hayı	String Olası değerler: `in_progress`, `completed`, `failed`, `cancelled`	Dosya durumuna göre filtreleyin. `in_progress`, `completed`, `failed` veya `cancelled`'den biri.

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Vektör deposu dosyası oluşturma

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/files

Dosyayı bir vektör deposuna ekleyerek bir vektör deposu dosyası oluşturun.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
vektör_depolama_kimliği	path	Evet	String	Dosya oluşturulacak vektör deposunun kimliği.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli
attributes	OpenAI.VectorStoreFileAttributes veya null		Hayı
chunking_strategy	OpenAI.ChunkingStrategyRequestParam	Dosya/dosyaları öbeklemek için kullanılan öbekleme stratejisi. Ayarlanmadıysa, stratejiyi `auto` kullanır. Yalnızca `file_ids` boş değilse geçerlidir.	Hayı
dosya_kimlik	String	Vektör deposunun kullanması gereken dosya kimliği. Dosyalara erişebilecek gibi `file_search` araçlar için kullanışlıdır.	Evet

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Vektör deposu dosyasını alma

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/files/{file_id}

Vektör deposu dosyasını getirir.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
vektör_depolama_kimliği	path	Evet	String	Dosyanın ait olduğu vektör deposunun kimliği.
dosya_kimlik	path	Evet	String	Alınan dosyanın kimliği.

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Vektör deposu dosya özniteliklerini güncelleştirme

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/files/{file_id}

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
vektör_depolama_kimliği	path	Evet	String
dosya_kimlik	path	Evet	String

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
attributes	OpenAI.VectorStoreFileAttributes veya null		Evet

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Vektör deposu dosyasını silme

DELETE {endpoint}/openai/v1/vector_stores/{vector_store_id}/files/{file_id}

Vektör deposu dosyasını silin. Bu işlem dosyayı vektör deposundan kaldırır, ancak dosyanın kendisi silinmez. Dosyayı silmek için dosya silme uç noktası uç noktasını kullanın.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
vektör_depolama_kimliği	path	Evet	String	Dosyanın ait olduğu vektör deposunun kimliği.
dosya_kimlik	path	Evet	String	Silinecek dosyanın kimliği.

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Vektör deposu dosya içeriğini alma

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/files/{file_id}/content

Vektör deposu dosya içeriğini alma

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
vektör_depolama_kimliği	path	Evet	String	Aranacak vektör deposunun kimliği.
dosya_kimlik	path	Evet	String	İçeriği alınacak dosyanın kimliği.

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Vektör deposunu ara

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/search

Vektör deposunu ara

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String	Azure OpenAI için desteklenen uç noktalar (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü	soru	Hayı	String	Bu istek için kullanılacak açık Azure AI Foundry Modelleri API sürümü. `v1` aksi belirtilmediyse.
vektör_depolama_kimliği	path	Evet	String	Aranacak vektör deposunun kimliği.

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
filters	OpenAI.ComparisonFilter veya OpenAI.CompoundFilter	Dosya özniteliklerine göre uygulanacak bir filtre.	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. Kısıtlamalar: dk: 1, maksimum: 50	Hayı	10
soru	dize veya dize dizisi	Arama için sorgu dizesi	Evet
Sıralama_seçenekleri	OpenAI.VectorStoreSearchRequestRankingOptions		Hayı
└─ sıralama yapıcı	enum	Olası değerler: `none`, `auto`, `default-2024-11-15`	Hayı
└─ skor_eşiği	Numara	Kısıtlamalar: min: 0, max: 1	Hayı
rewrite_query	Boolean	Vektör araması için doğal dil sorgusunun yeniden yazıp yazılmayacağı.	Hayı

Yanıtlar

Durum Kodu: 200

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Durum Kodu: varsayılan

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

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

Yanıt Üst Bilgileri:

Başlık	Türü	Description
apim-request-id	String	Sorun giderme amacıyla kullanılan istek kimliği.

Components

AudioSegment

İsim	Türü	Description	Gerekli
avg_logprob	Numara	Bu ses kesimiyle ilişkili ortalama günlük olasılığı.	Evet
compression_ratio	Numara	Bu ses segmentinin sıkıştırma oranı.	Evet
son	Numara	Bu segmentin çevrilen sesin başına göre sona erdiği saat.	Evet
kimlik	tamsayı	Çeviri içindeki bu kesimin 0 tabanlı dizini.	Evet
no_speech_prob	Numara	Bu ses segmentinde konuşma algılama olmaması olasılığı.	Evet
seek	tamsayı	Bu ses segmentinin işlenmesiyle ilişkili arama konumu. Arama konumları yüzde yüz saniye olarak ifade edilir. Model tek bir arama konumundan birkaç segmenti işleyebilecek, bu nedenle arama konumu hiçbir zaman segmentin başlangıcından daha sonraki bir zaman diliminin başlangıcı, segmentin ilişkili arama konumu.	Evet
start	Numara	Bu segmentin, çevrilen sesin başlangıcına göre başladığı saat.	Evet
sıcaklık	Numara	Bu ses segmentiyle ilişkili sıcaklık puanı.	Evet
text	String	Bu ses segmentinin parçası olan çevrilmiş metin.	Evet
tokens	tamsayı dizisi	Bu ses segmentindeki çevrilmiş metinle eşleşen belirteç kimlikleri.	Evet

AudioTaskLabel

Kullanılabilir ses işlemi yanıtları için olası tanımlayıcıları tanımlar.

Mülkiyet	Değer
Açıklama	Kullanılabilir ses işlemi yanıtları için olası tanımlayıcıları tanımlar.
Türü	String
Değerler	`transcribe` `translate`

AudioTranslationSegment

Çevrilmiş ses verilerinin tek bir kesimi hakkında genişletilmiş bilgiler. Segmentler genellikle yaklaşık 5-10 saniyelik konuşmayı temsil eder. Segment sınırları genellikle sözcükler arasında gerçekleşir, ancak tümceler arasında olması gerekmez.

İsim	Türü	Description	Gerekli
avg_logprob	Numara	Bu ses kesimiyle ilişkili ortalama günlük olasılığı.	Evet
compression_ratio	Numara	Bu ses segmentinin sıkıştırma oranı.	Evet
son	Numara	Bu segmentin çevrilen sesin başına göre sona erdiği saat.	Evet
kimlik	tamsayı	Çeviri içindeki bu kesimin 0 tabanlı dizini.	Evet
no_speech_prob	Numara	Bu ses segmentinde konuşma algılama olmaması olasılığı.	Evet
seek	tamsayı	Bu ses segmentinin işlenmesiyle ilişkili arama konumu. Arama konumları yüzde yüz saniye olarak ifade edilir. Model tek bir arama konumundan birkaç segmenti işleyebilecek, bu nedenle arama konumu hiçbir zaman segmentin başlangıcından daha sonraki bir zaman diliminin başlangıcı, segmentin ilişkili arama konumu.	Evet
start	Numara	Bu segmentin, çevrilen sesin başlangıcına göre başladığı saat.	Evet
sıcaklık	Numara	Bu ses segmentiyle ilişkili sıcaklık puanı.	Evet
text	String	Bu ses segmentinin parçası olan çevrilmiş metin.	Evet
tokens	tamsayı dizisi	Bu ses segmentindeki çevrilmiş metinle eşleşen belirteç kimlikleri.	Evet

AzureAIFoundryModelsApiVersion

Mülkiyet	Değer
Türü	String
Değerler	`v1` `preview`

AzureAudioTranscriptionResponse

Konuşulan sesi yazılı metne dönüştüren bir işlemin sonuç bilgileri.

İsim	Türü	Description	Gerekli
duration	Numara	Eşlik eden transkripsiyon bilgilerini üretmek için işlenen sesin toplam süresi.	Hayı
language	String	Döküme alınan ses verilerinde algılanan konuşulan dil. Bu, 'en' veya 'fr' gibi iki harfli ISO-639-1 dil kodu olarak ifade edilir.	Hayı
segments	OpenAI.TranscriptionSegment dizisi	İşlenen her ses kesiminin zamanlaması, olasılıkları ve diğer ayrıntıları hakkında bilgi koleksiyonu.	Hayı
görev	AudioTaskLabel	Kullanılabilir ses işlemi yanıtları için olası tanımlayıcıları tanımlar.	Hayı
text	String	Sağlanan ses verileri için oluşturulan döküm metni.	Evet
words	OpenAI.TranscriptionWord dizisi	İşlenen her sözcüğün zamanlaması hakkında bilgi koleksiyonu.	Hayı

AzureAudioTranslationResponse

Konuşma sesini yazılı metne çeviren işlemin sonuç bilgileri.

İsim	Türü	Description	Gerekli
duration	Numara	Eşlik eden çeviri bilgilerini üretmek için işlenen sesin toplam süresi.	Hayı
language	String	Çevrilen ses verilerinde algılanan konuşulan dil. Bu, 'en' veya 'fr' gibi iki harfli ISO-639-1 dil kodu olarak ifade edilir.	Hayı
segments	AudioTranslationSegment dizisi	İşlenen her ses kesiminin zamanlaması, olasılıkları ve diğer ayrıntıları hakkında bilgi koleksiyonu.	Hayı
görev	AudioTaskLabel	Kullanılabilir ses işlemi yanıtları için olası tanımlayıcıları tanımlar.	Hayı
text	String	Sağlanan ses verileri için çevrilmiş metin.	Evet

AzureCompletionsSamplingParams

Tamamlamaların davranışını denetlemek için örnekleme parametreleri.

İsim	Türü	Description	Gerekli	Varsayılan
max_completion_tokens	tamsayı		Hayı
maksimum_token	tamsayı	Oluşturulan çıktıdaki en fazla belirteç sayısı.	Hayı
akıl yürütme çabası	OpenAI.ReasoningEffort	Akıl yürütmeye yönelik çabayı kısıtlar mantık modelleri. Şu anda desteklenen değerler `none`, `minimal`, `low`, `medium`, `high`, ve `xhigh`'dir. Azaltma muhakeme çabası daha hızlı yanıtlara ve daha az belirteç kullanılmasına neden olabilir bir yanıtta mantık yürütme. - `gpt-5.1` varsayılan olarak `none`öğesini kullanır ve mantık yürütmez. Desteklenen gerekçe değerleri `gpt-5.1none`, `low`, `medium`, ve `high`'dir. Araç çağrıları gpt-5.1'deki tüm akıl yürütme değerleri için desteklenir. - Tüm modeller varsayılan olarak akıl yürütme eforu olmadan `gpt-5.1` önce `medium` ve desteklemez`none`. - Model `gpt-5-pro` varsayılan olarak akıl yürütme eforunu kullanır (ve yalnızca destekler `high` ). - `xhigh` , sonrasındaki `gpt-5.1-codex-max`tüm modeller için desteklenir.	Hayı
yanıt formatı	OpenAI.ResponseFormatText veya OpenAI.ResponseFormatJsonSchema veya OpenAI.ResponseFormatJsonObject		Hayı
seed	tamsayı	Bir tohum değeri örnekleme sırasında rastgeleliği başlatır.	Hayı	42
sıcaklık	Numara	Daha yüksek bir sıcaklık çıkışlardaki rastgeleliği artırır.	Hayı	1
araçlar	OpenAI.ChatCompletionTool dizisi		Hayı
top_p	Numara	Çekirdek örneklemesi için sıcaklığa bir alternatif; 1.0 tüm belirteçleri içerir.	Hayı	1

AzureContentFilterBlocklistIdResult

Mevcut bir özel blok listesi kimliğini ilgili blok listesinin içeriğin filtrelenmesine neden olup olmadığını belirten bir değerle ilişkilendiren içerik filtresi sonuç öğesi.

İsim	Türü	Description	Gerekli	Varsayılan
filtered	Boolean	İlişkili blok listesinin, içeriğin filtrelenmesiyle sonuçlanıp sonuçlanmadığı.	Evet
kimlik	String	Filtrelenmiş durumla ilişkili özel blok listesinin kimliği.	Evet

AzureContentFilterBlocklistResult

Yapılandırılmış özel blok listeleri için true/false filtreleme sonuçları koleksiyonu.

İsim	Türü	Description	Gerekli	Varsayılan
details	nesne dizisi	Bireysel blok listesi kimlik çiftleri ve bunların filtreleme işlemine yol açıp açmadığı.	Hayı
filtered	Boolean	Ayrıntılı blok listelerinden herhangi birinin filtreleme eylemiyle sonuçlanıp sonuçlanmadığını gösteren değer.	Evet

AzureContentFilterCompletionTextSpan

Azure OpenAI içerik filtresi sonuçları tarafından kullanılan tamamlama metni bölümünün bir temsili.

İsim	Türü	Description	Gerekli	Varsayılan
completion_end_offset	tamsayı	İlk UTF32 kod noktasının yayılma alanından dışlanan uzaklığı. Boş aralıklar için bu alan her zaman completion_start_offset değerine eşittir. Bu alan, boş olmayan aralıklar için her zaman completion_start_offset'tan daha büyüktür.	Evet
completion_start_offset	tamsayı	Yayılmaya başlayan UTF32 kod noktasının uzaklığı.	Evet

AzureContentFilterCompletionTextSpanDetectionResult

İsim	Türü	Description	Gerekli
details	AzureContentFilterCompletionTextSpan dizisi	Tespit edilen tamamlama metin aralıkları hakkında ayrıntılı bilgi.	Evet
detected	Boolean	Etiketli içerik kategorisinin içerikte algılanıp algılanmadığını.	Evet
filtered	Boolean	İçerik algılamanın bir içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Evet

AzureContentFilterCustomTopicIdResult

Mevcut bir özel konu başlığı kimliğini ilgili konunun algılanmasıyla sonuçlanıp sonuçlanmadığını belirten bir değerle ilişkilendiren içerik filtresi sonuç öğesi.

İsim	Türü	Description	Gerekli	Varsayılan
detected	Boolean	İlişkili özel konunun içeriğin algılanmasının sonucu olup olmadığı.	Evet
kimlik	String	Algılanan durumla ilişkili özel konunun kimliği.	Evet

AzureContentFilterCustomTopicResult

Yapılandırılmış özel konular için doğru/yanlış filtreleme sonuçları koleksiyonu.

İsim	Türü	Description	Gerekli	Varsayılan
details	nesne dizisi	Konu kimliği çiftleri ve tespit edilip edilmedikleri.	Hayı
filtered	Boolean	Ayrıntılı konu başlıklarından herhangi birinin filtreleme eylemiyle sonuçlanıp sonuçlanmadığını gösteren değer.	Evet

AzureContentFilterDetectionResult

İçeriğin algılanıp algılandığını ve içeriğin filtrelenip filtrelenmediğini gösteren etiketli bir içerik filtresi sonuç öğesi.

İsim	Türü	Description	Gerekli	Varsayılan
detected	Boolean	Etiketli içerik kategorisinin içerikte algılanıp algılanmadığını.	Evet
filtered	Boolean	İçerik algılamanın bir içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Evet

AzureContentFilterForResponsesAPI

İsim	Türü	Description	Gerekli
Engellenmiş	Boolean	Yanıtın engellenip engellenmediğini belirtin.	Evet
content_filter_offsets	AzureContentFilterResultOffsets		Evet
content_filter_results	AzureContentFilterResultsForResponsesAPI		Evet
└─ özel blok listeleri	AzureContentFilterBlocklistResult	Yapılandırılmış özel blok listeleri için ikili filtreleme sonuçları koleksiyonu.	Hayı
└─ özelleştirilmiş_konular	AzureContentFilterCustomTopicResult	Yapılandırılmış özel konular için ikili filtreleme sonuçları koleksiyonu.	Hayı
└─ hata	nesne	Varsa, içerik filtrelemenin değerlendirmesini tamamlamasını engelleyen bir hatayla ilgili ayrıntılar.	Hayı
└─ kod	tamsayı	Hatayla ilişkili ayrı, makine tarafından okunabilir bir kod.	Evet
└─ ileti	String	Hata ile ilişkili insan tarafından okunabilir bir mesaj.	Evet
└─ nefret	AzureContentFilterSeverityResult	Pejorative veya discriminatory kullanan herhangi bir içeriğe başvurabilen bir içerik filtresi kategorisi bu grupların belirli ayırt edici özniteliklerine dayalı olarak bir kişi veya kimlik grubuna başvuru içeren dil ırk, etnik köken, milliyet, cinsiyet kimliği ve ifadesi, cinsel yönelim dahil ancak bunlarla sınırlı olmamak üzere, din, göçmenlik durumu, yetenek durumu, kişisel görünüm ve vücut boyutu.	Hayı
└─ dolaylı_saldırı	AzureContentFilterDetectionResult	Her seferinde gerçekleşebilecek, Üretken yapay zeka modelleri tarafından desteklenen sistemlere yönelik saldırıları açıklayan bir algılama sonucu Bir uygulama, doğrudan uygulama geliştiricisi tarafından yazılmış olmayan bilgileri işler veya kullanıcısını seçin.	Hayı
└─ jailbreak (cihazdaki kısıtlamaların kaldırılması)	AzureContentFilterDetectionResult	Kötü amaçlı kullanıcıların kasıtlı olarak yararlandığı kullanıcı istemi ekleme saldırılarını açıklayan bir algılama sonucu LLM'den yetkisiz davranışlar elde etmek için sistem güvenlik açıkları. Bu, uygunsuz içeriğe yol açabilir sistem tarafından uygulanan kısıtlamaların oluşturulması veya ihlalleri.	Evet
└─ personally_identifiable_information	AzureContentFilterPersonallyIdentifiableInformationResult	Yapılandırılabilir alt kategorilere sahip Kişisel Tanımlanabilir Bilgilerle eşleşmeleri açıklayan bir algılama sonucu.	Hayı
└─ küfür	AzureContentFilterDetectionResult	Crude, kaba veya başka bir itiraz dilinin Içerik.	Hayı
└─ protected_material_code	nesne	Lisanslı kod veya diğer korunan kaynak malzemeyle eşleşmeyi açıklayan bir tespit sonucu.	Hayı
└─ alıntı	nesne	Mümkünse, ilişkili lisansı ve onun yerini açıklayan atıf ayrıntıları.	Hayı
└─ Web Adresi	String	Lisansla ilişkili URL.	Hayı
└─ lisans	String	Algılamayla ilişkili lisansın adı veya tanımlayıcısı.	Hayı
└─ algılandı	Boolean	Etiketli içerik kategorisinin içerikte algılanıp algılanmadığını.	Evet
└─ filtrelenmiş	Boolean	İçerik algılamanın bir içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Evet
└─ protected_material_text	AzureContentFilterDetectionResult	Telif hakkı veya başka bir durum altında korunan metne karşı eşleşmeyi açıklayan bir algılama sonucu.	Hayı
└─ kendine zarar verme	AzureContentFilterSeverityResult	Kasıtlı olarak yaralanan, yaralanan fiziksel eylemlerle ilgili dili açıklayan bir içerik filtresi kategorisi, vücuduna zarar verebilir veya kendini öldürebilirsiniz.	Hayı
└─ cinsel	AzureContentFilterSeverityResult	Anatomik organlar ve cinsel organlar, romantik ilişkiler, eylemlerle ilgili dil için içerik filtresi kategorisi erotik veya sevgi dolu terimlerle, hamilelik, fiziksel cinsel eylemler, bir olarak tasvir edilenler de dahil olmak üzere saldırı ya da zorla cinsel şiddet eylemleri, fuhuş, pornografi ve suistimal.	Hayı
└─ task_adherence	AzureContentFilterDetectionResult	Yürütme akışının plana hala bağlı kalıp kalmadığını gösteren bir algılama sonucu.	Evet
└─ ungrounded_material	AzureContentFilterCompletionTextSpanDetectionResult		Hayı
└─ şiddet	AzureContentFilterSeverityResult	Zarar verme, yaralanma, zarar verme veya öldürme amaçlı fiziksel eylemlerle ilgili dil için içerik filtresi kategorisi birini veya başka bir şeyi; silahlar, silahlar ve imalatlar, ilişkilendirmeler gibi ilgili varlıkları açıklar, ve benzeri.	Hayı
source_type	String	İletinin kaynak türünün adı.	Evet

AzureContentFilterHarmExtensions

Ek yapılandırma seçenekleri sağlayan zarar kategorileri için uzantılar.

İsim	Türü	Description	Gerekli	Varsayılan
pii_sub_categories	AzurePiiSubCategory dizisi	PIIHarmSubCategory(ler) yapılandırması.	Hayı

AzureContentFilterImagePromptResults

Görüntü oluşturma işleminin giriş isteği içeriği için içerik filtresi sonucu.

İsim	Türü	Description	Gerekli
custom_blocklists	AzureContentFilterBlocklistResult	Yapılandırılmış özel blok listeleri için true/false filtreleme sonuçları koleksiyonu.	Hayı
└─ ayrıntılar	nesne dizisi	Bireysel blok listesi kimlik çiftleri ve bunların filtreleme işlemine yol açıp açmadığı.	Hayı
└─ filtrelenmiş	Boolean	Blok listesinin bir filtreleme eylemi oluşturup oluşturmadığını gösteren değer.	Evet
└─ kimlik	String	Değerlendirilen özel blok listesinin kimliği.	Evet
└─ filtrelenmiş	Boolean	Ayrıntılı blok listelerinden herhangi birinin filtreleme eylemiyle sonuçlanıp sonuçlanmadığını gösteren değer.	Evet
Özel Konular	AzureContentFilterCustomTopicResult	Yapılandırılmış özel konular için doğru/yanlış filtreleme sonuçları koleksiyonu.	Hayı
└─ ayrıntılar	nesne dizisi	Konu kimliği çiftleri ve tespit edilip edilmedikleri.	Hayı
└─ algılandı	Boolean	Konunun algılanıp algılanmadığını gösteren değer.	Evet
└─ kimlik	String	Değerlendirilen özel konunun kimliği.	Evet
└─ filtrelenmiş	Boolean	Ayrıntılı konu başlıklarından herhangi birinin filtreleme eylemiyle sonuçlanıp sonuçlanmadığını gösteren değer.	Evet
hate	AzureContentFilterSeverityResult	İçeriğin filtrelenip filtrelenmediğini ve nitel öğenin ne olduğunu gösteren etiketli içerik filtresi sonuç öğesi kategori için içerik filtresi yapılandırmasına göre değerlendirildiği gibi, içeriğin önem derecesi düzeyiydi.	Hayı
└─ filtrelenmiş	Boolean	İçerik önem derecesinin içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Evet
└─ önem derecesi	enum	İçeriğin etiketli önem derecesi. Olası değerler: `safe`, `low`, `medium`, `high`	Evet
jailbreak	AzureContentFilterDetectionResult	İçeriğin algılanıp algılandığını ve içeriğin algılanıp algılanmamış olduğunu gösteren etiketli bir içerik filtresi sonuç öğesi Filtrelenmiş.	Evet
└─ algılandı	Boolean	Etiketli içerik kategorisinin içerikte algılanıp algılanmadığını.	Evet
└─ filtrelenmiş	Boolean	İçerik algılamanın bir içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Evet
profanity	AzureContentFilterDetectionResult	İçeriğin algılanıp algılandığını ve içeriğin algılanıp algılanmamış olduğunu gösteren etiketli bir içerik filtresi sonuç öğesi Filtrelenmiş.	Hayı
└─ algılandı	Boolean	Etiketli içerik kategorisinin içerikte algılanıp algılanmadığını.	Evet
└─ filtrelenmiş	Boolean	İçerik algılamanın bir içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Evet
self_harm	AzureContentFilterSeverityResult	İçeriğin filtrelenip filtrelenmediğini ve nitel öğenin ne olduğunu gösteren etiketli içerik filtresi sonuç öğesi kategori için içerik filtresi yapılandırmasına göre değerlendirildiği gibi, içeriğin önem derecesi düzeyiydi.	Hayı
└─ filtrelenmiş	Boolean	İçerik önem derecesinin içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Evet
└─ önem derecesi	enum	İçeriğin etiketli önem derecesi. Olası değerler: `safe`, `low`, `medium`, `high`	Evet
sexual	AzureContentFilterSeverityResult	İçeriğin filtrelenip filtrelenmediğini ve nitel öğenin ne olduğunu gösteren etiketli içerik filtresi sonuç öğesi kategori için içerik filtresi yapılandırmasına göre değerlendirildiği gibi, içeriğin önem derecesi düzeyiydi.	Hayı
└─ filtrelenmiş	Boolean	İçerik önem derecesinin içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Evet
└─ önem derecesi	enum	İçeriğin etiketli önem derecesi. Olası değerler: `safe`, `low`, `medium`, `high`	Evet
violence	AzureContentFilterSeverityResult	İçeriğin filtrelenip filtrelenmediğini ve nitel öğenin ne olduğunu gösteren etiketli içerik filtresi sonuç öğesi kategori için içerik filtresi yapılandırmasına göre değerlendirildiği gibi, içeriğin önem derecesi düzeyiydi.	Hayı
└─ filtrelenmiş	Boolean	İçerik önem derecesinin içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Evet
└─ önem derecesi	enum	İçeriğin etiketli önem derecesi. Olası değerler: `safe`, `low`, `medium`, `high`	Evet

AzureContentFilterImageResponseResults

Görüntü oluşturma işleminin çıkış yanıtı içeriği için içerik filtresi sonucu.

İsim	Türü	Description	Gerekli
hate	AzureContentFilterSeverityResult	İçeriğin filtrelenip filtrelenmediğini ve nitel öğenin ne olduğunu gösteren etiketli içerik filtresi sonuç öğesi kategori için içerik filtresi yapılandırmasına göre değerlendirildiği gibi, içeriğin önem derecesi düzeyiydi.	Hayı
└─ filtrelenmiş	Boolean	İçerik önem derecesinin içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Evet
└─ önem derecesi	enum	İçeriğin etiketli önem derecesi. Olası değerler: `safe`, `low`, `medium`, `high`	Evet
self_harm	AzureContentFilterSeverityResult	İçeriğin filtrelenip filtrelenmediğini ve nitel öğenin ne olduğunu gösteren etiketli içerik filtresi sonuç öğesi kategori için içerik filtresi yapılandırmasına göre değerlendirildiği gibi, içeriğin önem derecesi düzeyiydi.	Hayı
└─ filtrelenmiş	Boolean	İçerik önem derecesinin içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Evet
└─ önem derecesi	enum	İçeriğin etiketli önem derecesi. Olası değerler: `safe`, `low`, `medium`, `high`	Evet
sexual	AzureContentFilterSeverityResult	İçeriğin filtrelenip filtrelenmediğini ve nitel öğenin ne olduğunu gösteren etiketli içerik filtresi sonuç öğesi kategori için içerik filtresi yapılandırmasına göre değerlendirildiği gibi, içeriğin önem derecesi düzeyiydi.	Hayı
└─ filtrelenmiş	Boolean	İçerik önem derecesinin içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Evet
└─ önem derecesi	enum	İçeriğin etiketli önem derecesi. Olası değerler: `safe`, `low`, `medium`, `high`	Evet
violence	AzureContentFilterSeverityResult	İçeriğin filtrelenip filtrelenmediğini ve nitel öğenin ne olduğunu gösteren etiketli içerik filtresi sonuç öğesi kategori için içerik filtresi yapılandırmasına göre değerlendirildiği gibi, içeriğin önem derecesi düzeyiydi.	Hayı
└─ filtrelenmiş	Boolean	İçerik önem derecesinin içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Evet
└─ önem derecesi	enum	İçeriğin etiketli önem derecesi. Olası değerler: `safe`, `low`, `medium`, `high`	Evet

AzureİçerikFiltresiKişiselOlarakTanımlanabilirBilgiSonucu

Zarar uzantılarını içeren Kişisel Bilgiler için bir içerik filtresi algılama sonucu.

İsim	Türü	Description	Gerekli
detected	Boolean	Etiketli içerik kategorisinin içerikte algılanıp algılanmadığını.	Evet
filtered	Boolean	İçerik algılamanın bir içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Evet
redacted_text	String	PII bilgilerinin kaldırıldığı veya maskelendiği karartılmış metin.	Hayı
alt_kategoriler	AzurePiiSubCategoryResult dizisi	Her bir PIIHarmSubCategory için ayrıntılı sonuçlar.	Hayı

AzureContentFilterResultForChoice

Üretken bir yapay zeka sistemi tarafından üretilen tek bir yanıt öğesi için içerik filtresi sonucu.

İsim	Türü	Description	Gerekli
custom_blocklists	AzureContentFilterBlocklistResult	Yapılandırılmış özel blok listeleri için true/false filtreleme sonuçları koleksiyonu.	Hayı
└─ ayrıntılar	nesne dizisi	Bireysel blok listesi kimlik çiftleri ve bunların filtreleme işlemine yol açıp açmadığı.	Hayı
└─ filtrelenmiş	Boolean	Blok listesinin bir filtreleme eylemi oluşturup oluşturmadığını gösteren değer.	Evet
└─ kimlik	String	Değerlendirilen özel blok listesinin kimliği.	Evet
└─ filtrelenmiş	Boolean	Ayrıntılı blok listelerinden herhangi birinin filtreleme eylemiyle sonuçlanıp sonuçlanmadığını gösteren değer.	Evet
Özel Konular	AzureContentFilterCustomTopicResult	Yapılandırılmış özel konular için doğru/yanlış filtreleme sonuçları koleksiyonu.	Hayı
└─ ayrıntılar	nesne dizisi	Konu kimliği çiftleri ve tespit edilip edilmedikleri.	Hayı
└─ algılandı	Boolean	Konunun algılanıp algılanmadığını gösteren değer.	Evet
└─ kimlik	String	Değerlendirilen özel konunun kimliği.	Evet
└─ filtrelenmiş	Boolean	Ayrıntılı konu başlıklarından herhangi birinin filtreleme eylemiyle sonuçlanıp sonuçlanmadığını gösteren değer.	Evet
hata	nesne	Varsa, içerik filtrelemenin değerlendirmesini tamamlamasını engelleyen bir hatayla ilgili ayrıntılar.	Hayı
└─ kod	tamsayı	Hatayla ilişkili ayrı, makine tarafından okunabilir bir kod.	Evet
└─ ileti	String	Hata ile ilişkili insan tarafından okunabilir bir mesaj.	Evet
hate	AzureContentFilterSeverityResult	İçeriğin filtrelenip filtrelenmediğini ve nitel öğenin ne olduğunu gösteren etiketli içerik filtresi sonuç öğesi kategori için içerik filtresi yapılandırmasına göre değerlendirildiği gibi, içeriğin önem derecesi düzeyiydi.	Hayı
└─ filtrelenmiş	Boolean	İçerik önem derecesinin içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Evet
└─ önem derecesi	enum	İçeriğin etiketli önem derecesi. Olası değerler: `safe`, `low`, `medium`, `high`	Evet
kişisel olarak tanımlanabilir bilgi	AzureContentFilterPersonallyIdentifiableInformationResult	Zarar uzantılarını içeren Kişisel Bilgiler için bir içerik filtresi algılama sonucu.	Hayı
└─ redacted_text	String	PII bilgilerinin kaldırıldığı veya maskelendiği karartılmış metin.	Hayı
└─ alt_kategoriler	AzurePiiSubCategoryResult dizisi	Her bir PIIHarmSubCategory için ayrıntılı sonuçlar.	Hayı
profanity	AzureContentFilterDetectionResult	İçeriğin algılanıp algılandığını ve içeriğin algılanıp algılanmamış olduğunu gösteren etiketli bir içerik filtresi sonuç öğesi Filtrelenmiş.	Hayı
└─ algılandı	Boolean	Etiketli içerik kategorisinin içerikte algılanıp algılanmadığını.	Evet
└─ filtrelenmiş	Boolean	İçerik algılamanın bir içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Evet
protected_material_code	nesne	Lisanslı kod veya diğer korunan kaynak malzemeyle eşleşmeyi açıklayan bir tespit sonucu.	Hayı
└─ alıntı	nesne	Mümkünse, ilişkili lisansı ve onun yerini açıklayan atıf ayrıntıları.	Hayı
└─ Web Adresi	String	Lisansla ilişkili URL.	Hayı
└─ lisans	String	Algılamayla ilişkili lisansın adı veya tanımlayıcısı.	Hayı
└─ algılandı	Boolean	Etiketli içerik kategorisinin içerikte algılanıp algılanmadığını.	Evet
└─ filtrelenmiş	Boolean	İçerik algılamanın bir içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Evet
protected_material_text	AzureContentFilterDetectionResult	İçeriğin algılanıp algılandığını ve içeriğin algılanıp algılanmamış olduğunu gösteren etiketli bir içerik filtresi sonuç öğesi Filtrelenmiş.	Hayı
└─ algılandı	Boolean	Etiketli içerik kategorisinin içerikte algılanıp algılanmadığını.	Evet
└─ filtrelenmiş	Boolean	İçerik algılamanın bir içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Evet
self_harm	AzureContentFilterSeverityResult	İçeriğin filtrelenip filtrelenmediğini ve nitel öğenin ne olduğunu gösteren etiketli içerik filtresi sonuç öğesi kategori için içerik filtresi yapılandırmasına göre değerlendirildiği gibi, içeriğin önem derecesi düzeyiydi.	Hayı
└─ filtrelenmiş	Boolean	İçerik önem derecesinin içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Evet
└─ önem derecesi	enum	İçeriğin etiketli önem derecesi. Olası değerler: `safe`, `low`, `medium`, `high`	Evet
sexual	AzureContentFilterSeverityResult	İçeriğin filtrelenip filtrelenmediğini ve nitel öğenin ne olduğunu gösteren etiketli içerik filtresi sonuç öğesi kategori için içerik filtresi yapılandırmasına göre değerlendirildiği gibi, içeriğin önem derecesi düzeyiydi.	Hayı
└─ filtrelenmiş	Boolean	İçerik önem derecesinin içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Evet
└─ önem derecesi	enum	İçeriğin etiketli önem derecesi. Olası değerler: `safe`, `low`, `medium`, `high`	Evet
ungrounded_material	AzureContentFilterCompletionTextSpanDetectionResult		Hayı
violence	AzureContentFilterSeverityResult	İçeriğin filtrelenip filtrelenmediğini ve nitel öğenin ne olduğunu gösteren etiketli içerik filtresi sonuç öğesi kategori için içerik filtresi yapılandırmasına göre değerlendirildiği gibi, içeriğin önem derecesi düzeyiydi.	Hayı
└─ filtrelenmiş	Boolean	İçerik önem derecesinin içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Evet
└─ önem derecesi	enum	İçeriğin etiketli önem derecesi. Olası değerler: `safe`, `low`, `medium`, `high`	Evet

AzureContentFilterResultForPrompt

Üretken bir yapay zeka sistemine tek bir giriş istemi öğesiyle ilişkilendirilmiş içerik filtresi sonucu.

İsim	Türü	Description	Gerekli
content_filter_results	nesne	Sonuç için içerik filtresi kategori ayrıntıları.	Hayı
└─ özel blok listeleri	AzureContentFilterBlocklistResult	Yapılandırılmış özel blok listeleri için true/false filtreleme sonuçları koleksiyonu.	Hayı
└─ ayrıntılar	nesne dizisi	Bireysel blok listesi kimlik çiftleri ve bunların filtreleme işlemine yol açıp açmadığı.	Hayı
└─ filtrelenmiş	Boolean	Blok listesinin bir filtreleme eylemi oluşturup oluşturmadığını gösteren değer.	Evet
└─ kimlik	String	Değerlendirilen özel blok listesinin kimliği.	Evet
└─ filtrelenmiş	Boolean	Ayrıntılı blok listelerinden herhangi birinin filtreleme eylemiyle sonuçlanıp sonuçlanmadığını gösteren değer.	Evet
└─ özelleştirilmiş_konular	AzureContentFilterCustomTopicResult	Yapılandırılmış özel konular için doğru/yanlış filtreleme sonuçları koleksiyonu.	Hayı
└─ ayrıntılar	nesne dizisi	Konu kimliği çiftleri ve tespit edilip edilmedikleri.	Hayı
└─ algılandı	Boolean	Konunun algılanıp algılanmadığını gösteren değer.	Evet
└─ kimlik	String	Değerlendirilen özel konunun kimliği.	Evet
└─ filtrelenmiş	Boolean	Ayrıntılı konu başlıklarından herhangi birinin filtreleme eylemiyle sonuçlanıp sonuçlanmadığını gösteren değer.	Evet
└─ hata	nesne	Varsa, içerik filtrelemenin değerlendirmesini tamamlamasını engelleyen bir hatayla ilgili ayrıntılar.	Hayı
└─ kod	tamsayı	Hatayla ilişkili ayrı, makine tarafından okunabilir bir kod.	Evet
└─ ileti	String	Hata ile ilişkili insan tarafından okunabilir bir mesaj.	Evet
└─ nefret	AzureContentFilterSeverityResult	İçeriğin filtrelenip filtrelenmediğini ve nitel öğenin ne olduğunu gösteren etiketli içerik filtresi sonuç öğesi kategori için içerik filtresi yapılandırmasına göre değerlendirildiği gibi, içeriğin önem derecesi düzeyiydi.	Hayı
└─ filtrelenmiş	Boolean	İçerik önem derecesinin içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Evet
└─ önem derecesi	enum	İçeriğin etiketli önem derecesi. Olası değerler: `safe`, `low`, `medium`, `high`	Evet
└─ dolaylı_saldırı	AzureContentFilterDetectionResult	İçeriğin algılanıp algılandığını ve içeriğin algılanıp algılanmamış olduğunu gösteren etiketli bir içerik filtresi sonuç öğesi Filtrelenmiş.	Evet
└─ algılandı	Boolean	Etiketli içerik kategorisinin içerikte algılanıp algılanmadığını.	Evet
└─ filtrelenmiş	Boolean	İçerik algılamanın bir içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Evet
└─ jailbreak (cihazdaki kısıtlamaların kaldırılması)	AzureContentFilterDetectionResult	İçeriğin algılanıp algılandığını ve içeriğin algılanıp algılanmamış olduğunu gösteren etiketli bir içerik filtresi sonuç öğesi Filtrelenmiş.	Evet
└─ algılandı	Boolean	Etiketli içerik kategorisinin içerikte algılanıp algılanmadığını.	Evet
└─ filtrelenmiş	Boolean	İçerik algılamanın bir içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Evet
└─ küfür	AzureContentFilterDetectionResult	İçeriğin algılanıp algılandığını ve içeriğin algılanıp algılanmamış olduğunu gösteren etiketli bir içerik filtresi sonuç öğesi Filtrelenmiş.	Hayı
└─ algılandı	Boolean	Etiketli içerik kategorisinin içerikte algılanıp algılanmadığını.	Evet
└─ filtrelenmiş	Boolean	İçerik algılamanın bir içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Evet
└─ kendine zarar verme	AzureContentFilterSeverityResult	İçeriğin filtrelenip filtrelenmediğini ve nitel öğenin ne olduğunu gösteren etiketli içerik filtresi sonuç öğesi kategori için içerik filtresi yapılandırmasına göre değerlendirildiği gibi, içeriğin önem derecesi düzeyiydi.	Hayı
└─ filtrelenmiş	Boolean	İçerik önem derecesinin içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Evet
└─ önem derecesi	enum	İçeriğin etiketli önem derecesi. Olası değerler: `safe`, `low`, `medium`, `high`	Evet
└─ cinsel	AzureContentFilterSeverityResult	İçeriğin filtrelenip filtrelenmediğini ve nitel öğenin ne olduğunu gösteren etiketli içerik filtresi sonuç öğesi kategori için içerik filtresi yapılandırmasına göre değerlendirildiği gibi, içeriğin önem derecesi düzeyiydi.	Hayı
└─ filtrelenmiş	Boolean	İçerik önem derecesinin içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Evet
└─ önem derecesi	enum	İçeriğin etiketli önem derecesi. Olası değerler: `safe`, `low`, `medium`, `high`	Evet
└─ şiddet	AzureContentFilterSeverityResult	İçeriğin filtrelenip filtrelenmediğini ve nitel öğenin ne olduğunu gösteren etiketli içerik filtresi sonuç öğesi kategori için içerik filtresi yapılandırmasına göre değerlendirildiği gibi, içeriğin önem derecesi düzeyiydi.	Hayı
└─ filtrelenmiş	Boolean	İçerik önem derecesinin içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Evet
└─ önem derecesi	enum	İçeriğin etiketli önem derecesi. Olası değerler: `safe`, `low`, `medium`, `high`	Evet
prompt_index	tamsayı	Eşlik eden içerik filtresi sonuç kategorileri ile ilişkili giriş isteminin dizini.	Hayı

AzureContentFilterResultOffsets

İsim	Türü	Gerekli
check_offset	tamsayı	Evet
end_offset	tamsayı	Evet
start_offset	tamsayı	Evet

AzureContentFilterResultsForResponsesAPI

İsim	Türü	Description	Gerekli
custom_blocklists	AzureContentFilterBlocklistResult	Yapılandırılmış özel blok listeleri için true/false filtreleme sonuçları koleksiyonu.	Hayı
└─ ayrıntılar	nesne dizisi	Bireysel blok listesi kimlik çiftleri ve bunların filtreleme işlemine yol açıp açmadığı.	Hayı
└─ filtrelenmiş	Boolean	Blok listesinin bir filtreleme eylemi oluşturup oluşturmadığını gösteren değer.	Evet
└─ kimlik	String	Değerlendirilen özel blok listesinin kimliği.	Evet
└─ filtrelenmiş	Boolean	Ayrıntılı blok listelerinden herhangi birinin filtreleme eylemiyle sonuçlanıp sonuçlanmadığını gösteren değer.	Evet
Özel Konular	AzureContentFilterCustomTopicResult	Yapılandırılmış özel konular için doğru/yanlış filtreleme sonuçları koleksiyonu.	Hayı
└─ ayrıntılar	nesne dizisi	Konu kimliği çiftleri ve tespit edilip edilmedikleri.	Hayı
└─ algılandı	Boolean	Konunun algılanıp algılanmadığını gösteren değer.	Evet
└─ kimlik	String	Değerlendirilen özel konunun kimliği.	Evet
└─ filtrelenmiş	Boolean	Ayrıntılı konu başlıklarından herhangi birinin filtreleme eylemiyle sonuçlanıp sonuçlanmadığını gösteren değer.	Evet
hata	nesne	Varsa, içerik filtrelemenin değerlendirmesini tamamlamasını engelleyen bir hatayla ilgili ayrıntılar.	Hayı
└─ kod	tamsayı	Hatayla ilişkili ayrı, makine tarafından okunabilir bir kod.	Evet
└─ ileti	String	Hata ile ilişkili insan tarafından okunabilir bir mesaj.	Evet
hate	AzureContentFilterSeverityResult	İçeriğin filtrelenip filtrelenmediğini ve nitel öğenin ne olduğunu gösteren etiketli içerik filtresi sonuç öğesi kategori için içerik filtresi yapılandırmasına göre değerlendirildiği gibi, içeriğin önem derecesi düzeyiydi.	Hayı
└─ filtrelenmiş	Boolean	İçerik önem derecesinin içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Evet
└─ önem derecesi	enum	İçeriğin etiketli önem derecesi. Olası değerler: `safe`, `low`, `medium`, `high`	Evet
indirect_attack	AzureContentFilterDetectionResult	İçeriğin algılanıp algılandığını ve içeriğin algılanıp algılanmamış olduğunu gösteren etiketli bir içerik filtresi sonuç öğesi Filtrelenmiş.	Hayı
└─ algılandı	Boolean	Etiketli içerik kategorisinin içerikte algılanıp algılanmadığını.	Evet
└─ filtrelenmiş	Boolean	İçerik algılamanın bir içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Evet
jailbreak	AzureContentFilterDetectionResult	İçeriğin algılanıp algılandığını ve içeriğin algılanıp algılanmamış olduğunu gösteren etiketli bir içerik filtresi sonuç öğesi Filtrelenmiş.	Evet
└─ algılandı	Boolean	Etiketli içerik kategorisinin içerikte algılanıp algılanmadığını.	Evet
└─ filtrelenmiş	Boolean	İçerik algılamanın bir içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Evet
kişisel olarak tanımlanabilir bilgi	AzureContentFilterPersonallyIdentifiableInformationResult	Zarar uzantılarını içeren Kişisel Bilgiler için bir içerik filtresi algılama sonucu.	Hayı
└─ redacted_text	String	PII bilgilerinin kaldırıldığı veya maskelendiği karartılmış metin.	Hayı
└─ alt_kategoriler	AzurePiiSubCategoryResult dizisi	Her bir PIIHarmSubCategory için ayrıntılı sonuçlar.	Hayı
profanity	AzureContentFilterDetectionResult	İçeriğin algılanıp algılandığını ve içeriğin algılanıp algılanmamış olduğunu gösteren etiketli bir içerik filtresi sonuç öğesi Filtrelenmiş.	Hayı
└─ algılandı	Boolean	Etiketli içerik kategorisinin içerikte algılanıp algılanmadığını.	Evet
└─ filtrelenmiş	Boolean	İçerik algılamanın bir içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Evet
protected_material_code	nesne	Lisanslı kod veya diğer korunan kaynak malzemeyle eşleşmeyi açıklayan bir tespit sonucu.	Hayı
└─ alıntı	nesne	Mümkünse, ilişkili lisansı ve onun yerini açıklayan atıf ayrıntıları.	Hayı
└─ Web Adresi	String	Lisansla ilişkili URL.	Hayı
└─ lisans	String	Algılamayla ilişkili lisansın adı veya tanımlayıcısı.	Hayı
└─ algılandı	Boolean	Etiketli içerik kategorisinin içerikte algılanıp algılanmadığını.	Evet
└─ filtrelenmiş	Boolean	İçerik algılamanın bir içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Evet
protected_material_text	AzureContentFilterDetectionResult	İçeriğin algılanıp algılandığını ve içeriğin algılanıp algılanmamış olduğunu gösteren etiketli bir içerik filtresi sonuç öğesi Filtrelenmiş.	Hayı
└─ algılandı	Boolean	Etiketli içerik kategorisinin içerikte algılanıp algılanmadığını.	Evet
└─ filtrelenmiş	Boolean	İçerik algılamanın bir içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Evet
self_harm	AzureContentFilterSeverityResult	İçeriğin filtrelenip filtrelenmediğini ve nitel öğenin ne olduğunu gösteren etiketli içerik filtresi sonuç öğesi kategori için içerik filtresi yapılandırmasına göre değerlendirildiği gibi, içeriğin önem derecesi düzeyiydi.	Hayı
└─ filtrelenmiş	Boolean	İçerik önem derecesinin içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Evet
└─ önem derecesi	enum	İçeriğin etiketli önem derecesi. Olası değerler: `safe`, `low`, `medium`, `high`	Evet
sexual	AzureContentFilterSeverityResult	İçeriğin filtrelenip filtrelenmediğini ve nitel öğenin ne olduğunu gösteren etiketli içerik filtresi sonuç öğesi kategori için içerik filtresi yapılandırmasına göre değerlendirildiği gibi, içeriğin önem derecesi düzeyiydi.	Hayı
└─ filtrelenmiş	Boolean	İçerik önem derecesinin içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Evet
└─ önem derecesi	enum	İçeriğin etiketli önem derecesi. Olası değerler: `safe`, `low`, `medium`, `high`	Evet
task_adherence	AzureContentFilterDetectionResult	İçeriğin algılanıp algılandığını ve içeriğin algılanıp algılanmamış olduğunu gösteren etiketli bir içerik filtresi sonuç öğesi Filtrelenmiş.	Evet
└─ algılandı	Boolean	Etiketli içerik kategorisinin içerikte algılanıp algılanmadığını.	Evet
└─ filtrelenmiş	Boolean	İçerik algılamanın bir içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Evet
ungrounded_material	AzureContentFilterCompletionTextSpanDetectionResult		Hayı
violence	AzureContentFilterSeverityResult	İçeriğin filtrelenip filtrelenmediğini ve nitel öğenin ne olduğunu gösteren etiketli içerik filtresi sonuç öğesi kategori için içerik filtresi yapılandırmasına göre değerlendirildiği gibi, içeriğin önem derecesi düzeyiydi.	Hayı
└─ filtrelenmiş	Boolean	İçerik önem derecesinin içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Evet
└─ önem derecesi	enum	İçeriğin etiketli önem derecesi. Olası değerler: `safe`, `low`, `medium`, `high`	Evet

AzureContentFilterSeverityResult

İçeriğin filtrelenip filtrelenmediğini ve kategorinin içerik filtresi yapılandırmasına göre değerlendirildiği şekilde içeriğin nitel önem düzeyini gösteren etiketli bir içerik filtresi sonuç öğesi.

İsim	Türü	Description	Gerekli	Varsayılan
filtered	Boolean	İçerik önem derecesinin içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Evet
severity	enum	İçeriğin etiketli önem derecesi. Olası değerler: `safe`, `low`, `medium`, `high`	Evet

AzureFileExpiryAnchor

Mülkiyet	Değer
Türü	String
Değerler	`created_at`

AzureFineTuneReinforcementMethod

İsim	Türü	Description	Gerekli
Yol tesviye makinesi	OpenAI.GraderStringCheck veya OpenAI.GraderTextSimilarity veya OpenAI.GraderScoreModel ya da OpenAI.GraderMulti veya GraderEndpoint		Evet
hiper parametreler	OpenAI.FineTuneReinforcementHyperparameters	Pekiştirici ince ayarlama işi için kullanılan hiper parametreler.	Hayı
yanıt formatı	ResponseFormatJSONSchemaRequest		Hayı
└─ json_schema	nesne	Yanıt biçimi için JSON Şeması	Evet
└─ türü	enum	Yanıt biçimi türü Olası değerler: `json_schema`	Evet

AzurePiiSubCategory

Zarar uzantıları çerçevesinde bireysel PIIHarmSubCategory'ler için yapılandırma.

İsim	Türü	Description	Gerekli
Algılamak	Boolean	Bu alt kategori için algılamanın etkinleştirilip etkinleştirilmediği.	Evet
filtre	Boolean	Bu alt kategoriyi içeren içeriğin engellenip engellenmeyeceği.	Evet
yeniden işlem	Boolean	Bu alt kategoriyi içeren içeriğin yeniden düzenlenip dağıtılmayacağı.	Evet
alt_kategori	String	Yapılandırılan PIIHarmSubCategory.	Evet

AzurePiiSubCategoryResult

Bireysel PIIHarmSubCategory(ler) için sonuç ayrıntıları.

İsim	Türü	Description	Gerekli
detected	Boolean	etiketli içerik alt kategorisinin içerikte algılanıp algılanamadıdığı.	Evet
filtered	Boolean	İçerik algılamanın bu alt kategori için bir içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Evet
Sansürlenmiş	Boolean	İçeriğin bu alt kategori için sansürlenip sansürlenmediği.	Evet
alt_kategori	String	Değerlendirilmiş olan PIIHarmAltKategori.	Evet

AzureResponsesSamplingParams

Yanıtların davranışını denetlemek için örnekleme parametreleri.

İsim	Türü	Description	Gerekli	Varsayılan
maksimum_token	tamsayı	Oluşturulan çıktıdaki en fazla belirteç sayısı.	Hayı
akıl yürütme çabası	OpenAI.ReasoningEffort	Akıl yürütmeye yönelik çabayı kısıtlar mantık modelleri. Şu anda desteklenen değerler `none`, `minimal`, `low`, `medium`, `high`, ve `xhigh`'dir. Azaltma muhakeme çabası daha hızlı yanıtlara ve daha az belirteç kullanılmasına neden olabilir bir yanıtta mantık yürütme. - `gpt-5.1` varsayılan olarak `none`öğesini kullanır ve mantık yürütmez. Desteklenen gerekçe değerleri `gpt-5.1none`, `low`, `medium`, ve `high`'dir. Araç çağrıları gpt-5.1'deki tüm akıl yürütme değerleri için desteklenir. - Tüm modeller varsayılan olarak akıl yürütme eforu olmadan `gpt-5.1` önce `medium` ve desteklemez`none`. - Model `gpt-5-pro` varsayılan olarak akıl yürütme eforunu kullanır (ve yalnızca destekler `high` ). - `xhigh` , sonrasındaki `gpt-5.1-codex-max`tüm modeller için desteklenir.	Hayı
seed	tamsayı	Bir tohum değeri örnekleme sırasında rastgeleliği başlatır.	Hayı	42
sıcaklık	Numara	Daha yüksek bir sıcaklık çıkışlardaki rastgeleliği artırır.	Hayı	1
text	OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText		Hayı
araçlar	OpenAI.Tool dizisi		Hayı
top_p	Numara	Çekirdek örneklemesi için sıcaklığa bir alternatif; 1.0 tüm belirteçleri içerir.	Hayı	1

AzureUserSecurityContext

Kullanıcı güvenlik bağlamı, uygulamanın kendisini ve uygulamayla etkileşim kuran son kullanıcıyı tanımlayan çeşitli parametreler içerir. Bu alanlar, yapay zeka uygulamalarınızı korumaya yönelik kapsamlı bir yaklaşım sağlayarak güvenlik operasyonları ekiplerinizin güvenlik olaylarını araştırmalarına ve azaltmalarına yardımcı olur. Microsoft Defender for Cloud kullanarak yapay zeka uygulamalarını koruma hakkında daha fazla bilgi edinin.

İsim	Türü	Description	Gerekli
application_name	String	Uygulamanın adı. Hassas kişisel bilgiler bu alana dahil edilmemelidir.	Hayı
end_user_id	String	Bu tanımlayıcı, oluşturan yapay zeka uygulamasında son kullanıcıların kimliğini doğrulamak için kullanılan Microsoft Entra ID (eski adıyla Azure Active Directory) kullanıcı nesne kimliğidir. Hassas kişisel bilgiler bu alana dahil edilmemelidir.	Hayı
end_user_tenant_id	String	Son kullanıcının ait olduğu Microsoft 365 kiracı kimliği. Üretken yapay zeka uygulaması çok kiracılı bir ortamda olduğunda gereklidir.	Hayı
source_ip	String	Özgün istemcinin IP adresini yakalar.	Hayı

KopyalanmışHesapDetayları

İsim	Türü	Description	Gerekli
destinationResourceId	String	Modelin kopyalandığı hedef kaynağın kimliği.	Evet
region	String	Modelin kopyalandığı bölge.	Evet
durum	enum	Kopyalama işleminin durumu. Olası değerler: `Completed`, `Failed`, `InProgress`	Evet

KopyaModelİsteği

İsim	Türü	Description	Gerekli	Varsayılan
destinationResourceId	String	Kopyalanacak hedef Kaynağın kimliği.	Evet
region	String	Modelin kopyalanması gereken bölge.	Evet

CopyModelResponse

İsim	Türü	Description	Gerekli
checkpointedModelName	String	Kopyalanan modelin kimliği.	Evet
kopyalanmışHesapDetayları	CopiedAccountDetails dizisi	Kopyalandığı hedef kaynak kimliğinin kimliği	Evet
fineTuningJobId	String	İnce ayar işinin kopyalandığı kontrol noktasının kimliği.	Evet

CreateVideoBody

İsim	Türü	Description	Gerekli	Varsayılan
model	String	Bu istek için kullanılacak dağıtımın adı.	Evet
prompt	String	Oluşturulacak videoyu açıklayan metin istemi. Kısıtlamalar: minLength: 1	Evet
saniye	VideoSaniyeler	Saniye cinsinden ölçülen desteklenen klip süreleri.	Hayı	4
boyut	Video Boyutu	olarak `{width}x{height}`biçimlendirilmiş çıkış boyutları.	Hayı	720x1280

CreateVideoBodyWithInputReference

Medya dosyalarıyla bir video oluşturma işi isteğinin özellikleri.

İsim	Türü	Description	Gerekli
input_reference	nesne	Oluşturma işlemine yol gösteren isteğe bağlı görüntü başvurusu.	Evet
model	nesne	Bu istek için kullanılacak dağıtımın adı.	Evet
prompt	nesne	Oluşturulacak videoyu açıklayan metin istemi.	Evet
saniye	nesne	Saniye cinsinden kırpma süresi. Varsayılan değer 4 saniyedir.	Hayı
boyut	nesne	Genişlik x yükseklik olarak biçimlendirilmiş çıkış çözünürlüğü. Varsayılan değer: 720x1280.	Hayı

CreateVideoRemixBody

Mevcut oluşturulan bir videoya yeniden karıştırma parametreleri.

İsim	Türü	Description	Gerekli	Varsayılan
prompt	String	Karıştırma oluşturma işlemini yönlendiren güncelleştirilmiş metin istemi. Kısıtlamalar: minLength: 1	Evet

DeletedVideoResource

Video silindikten sonra onay yükü döndürüldü.

İsim	Türü	Description	Gerekli	Varsayılan
silindi	Boolean	Video kaynağının silindiğini gösterir.	Evet	Doğru
kimlik	String	Silinen videonun tanımlayıcısı.	Evet
nesne	String	Silme yanıtına işaret eden nesne türü.	Evet	video.deleted

Error

İsim	Türü	Description	Gerekli	Varsayılan
kod	String		Evet
mesaj	String		Evet

EvalGraderEndpoint

İsim	Türü	Description	Gerekli
headers	object veya null	Uç noktaya yönelik isteklere eklenecek isteğe bağlı HTTP üst bilgileri	Hayı
name	String	Not verenin adı	Evet
eşik_geçiş	sayı veya null	Notunun başarılı olarak kabul edildiği isteğe bağlı eşik puanı Belirtilmezse, tüm puanlar geçerli kabul edilir	Hayı
rate_limit	tamsayı veya null	Uç noktaya saniye başına istekler için isteğe bağlı hız sınırı Pozitif bir tamsayı olmalıdır	Hayı
type	enum	Olası değerler: `endpoint`	Evet
url	String	Puanlama için çağrılacak uç noktanın HTTPS URL'si Kısıtlamalar: desen: `^https://`	Evet

GraderEndpoint

Dış HTTP uç nokta değerlendirmesi için uç nokta sınıflayıcı yapılandırması

İsim	Türü	Description	Gerekli
headers	object veya null	Uç noktaya yönelik isteklere eklenecek isteğe bağlı HTTP üst bilgileri	Hayı
name	String	Not verenin adı	Evet
eşik_geçiş	sayı veya null	Notunun başarılı olarak kabul edildiği isteğe bağlı eşik puanı Belirtilmezse, tüm puanlar geçerli kabul edilir	Hayı
rate_limit	tamsayı veya null	Uç noktaya saniye başına istekler için isteğe bağlı hız sınırı Pozitif bir tamsayı olmalıdır	Hayı
type	enum	Olası değerler: `endpoint`	Evet
url	String	Puanlama için çağrılacak uç noktanın HTTPS URL'si Kısıtlamalar: desen: `^https://`	Evet

OpenAI.Annotation

Çıkış metninin yayılma alanına uygulanan bir ek açıklama.

OpenAI.Annotation için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
`file_citation`	OpenAI.FileCitationBody
`url_citation`	OpenAI.UrlCitationBody
`container_file_citation`	OpenAI.ContainerFileCitationBody
`file_path`	OpenAI.FilePath

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.AnnotationType		Evet

OpenAI.AnnotationType

Mülkiyet	Değer
Türü	String
Değerler	`file_citation` `url_citation` `container_file_citation` `file_path`

OpenAI.ApplyPatchCallOutputStatus

Mülkiyet	Değer
Türü	String
Değerler	`completed` `failed`

OpenAI.ApplyPatchCallStatus

Mülkiyet	Değer
Türü	String
Değerler	`in_progress` `completed`

OpenAI.ApplyPatchCreateFileOperation

apply_patch aracı aracılığıyla dosya oluşturmayı açıklayan yönerge.

İsim	Türü	Description	Gerekli
Fark	String	Uygulanacak fark.	Evet
path	String	Oluşturulacak dosyanın yolu.	Evet
type	enum	Sağlanan fark ile yeni bir dosya oluşturun. Olası değerler: `create_file`	Evet

OpenAI.ApplyPatchDeleteFileOperation

apply_patch aracı aracılığıyla bir dosyanın nasıl silineceği hakkında yönergeler.

İsim	Türü	Description	Gerekli	Varsayılan
path	String	Silinecek dosyanın yolu.	Evet
type	enum	Belirtilen dosyayı silin. Olası değerler: `delete_file`	Evet

OpenAI.ApplyPatchFileOperation

apply_patch aracılığıyla uygulanan create_file, delete_file veya update_file işlemlerinden biri.

OpenAI.ApplyPatchFileOperation için Ayrıştırıcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
`create_file`	OpenAI.ApplyPatchCreateFileOperation
`delete_file`	OpenAI.ApplyPatchDeleteFileOperation
`update_file`	OpenAI.ApplyPatchUpdateFileOperation

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.ApplyPatchFileOperationType		Evet

OpenAI.ApplyPatchFileOperationType

Mülkiyet	Değer
Türü	String
Değerler	`create_file` `delete_file` `update_file`

OpenAI.ApplyPatchToolParam

Asistanın dosyaları birleşik farklılıklar kullanarak oluşturmasına, silmesine veya güncellemesine olanak tanır.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Aracın türü. Her zaman `apply_patch`. Olası değerler: `apply_patch`	Evet

OpenAI.ApplyPatchUpdateFileOperation

apply_patch aracı aracılığıyla bir dosyanın nasıl güncelleştirileceklerini açıklayan yönerge.

İsim	Türü	Description	Gerekli
Fark	String	Uygulanacak fark.	Evet
path	String	Güncelleştirilecek dosyanın yolu.	Evet
type	enum	Mevcut bir dosyayı sağlanan farkla güncelleştirin. Olası değerler: `update_file`	Evet

OpenAI.YaklaşıkKonum

İsim	Türü	Description	Gerekli
city	dize veya null		Hayı
country	dize veya null		Hayı
region	dize veya null		Hayı
timezone	dize veya null		Hayı
type	enum	Konum yaklaşımının türü. Her zaman `approximate`. Olası değerler: `approximate`	Evet

OpenAI.AssistantTool

OpenAI.AssistantTool 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_interpreter`	OpenAI.AssistantToolsCode
`file_search`	OpenAI.AssistantToolsFileSearch
`function`	OpenAI.AssistantToolsFunction

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.AssistantToolType		Evet

OpenAI.AssistantToolType

Mülkiyet	Değer
Türü	String
Değerler	`code_interpreter` `file_search` `function`

OpenAI.AssistantToolsCode

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Tanımlanan araç türü: `code_interpreter` Olası değerler: `code_interpreter`	Evet

OpenAI.AssistantToolsFileSearch

İsim	Türü	Description	Gerekli
file_search	OpenAI.AssistantToolsFileSearchFileSearch		Hayı
└─ maksimum_sonuç_sayısı	tamsayı	Kısıtlamalar: dk: 1, maksimum: 50	Hayı
└─ ranking_options	OpenAI.FileSearchRankingOptions	Dosya araması için derecelendirme seçenekleri. Belirtilmezse, dosya arama aracı derecelendiriciyi `auto` ve 0 score_threshold kullanır. Daha fazla bilgi için dosya arama aracı belgelerine bakın.	Hayı
type	enum	Tanımlanan araç türü: `file_search` Olası değerler: `file_search`	Evet

OpenAI.AssistantToolsFileSearchFileSearch

İsim	Türü	Description	Gerekli	Varsayılan
maks_sonuç_sayısı	tamsayı	Kısıtlamalar: dk: 1, maksimum: 50	Hayı
Sıralama_seçenekleri	OpenAI.FileSearchRankingOptions	Dosya araması için derecelendirme seçenekleri. Belirtilmezse, dosya arama aracı derecelendiriciyi `auto` ve 0 score_threshold kullanır. Daha fazla bilgi için dosya arama aracı belgelerine bakın.	Hayı

OpenAI.AssistantToolsFileSearchTypeOnly

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Tanımlanan araç türü: `file_search` Olası değerler: `file_search`	Evet

OpenAI.AssistantToolsFunction

İsim	Türü	Description	Gerekli	Varsayılan
function	OpenAI.FunctionObject		Evet
type	enum	Tanımlanan araç türü: `function` Olası değerler: `function`	Evet

OpenAI.AssistantsApiResponseFormatOption

Modelin çıkış yapması gereken biçimi belirtir. GPT-4o, GPT-4 Turbo ve tüm gpt-3.5-turbo-1106GPT-3.5 Turbo modelleri ile uyumludur. ayarı, { "type": "json_schema", "json_schema": {...} } modelin sağlanan JSON şemanızla eşleşmesini sağlayan Yapılandırılmış Çıkışlar'ı etkinleştirir. Modelin oluşturduğu iletinin geçerli JSON olduğundan emin olan JSON modunu etkinleştirme ayarı { "type": "json_object" } bölümünde daha fazla bilgi edinin. Önemli:* JSON modunu kullanırken, modele bir sistem veya kullanıcı iletisi aracılığıyla kendiniz JSON üretmesini de belirtmeniz gerekir . Bu olmadan model, nesil belirteç sınırına ulaşana kadar bitmeyen bir boşluk akışı oluşturabilir ve bu da uzun süre çalışan ve görünüşe göre "takılmış" bir istekle sonuçlanır. Ayrıca, neslin aşıldığını veya konuşmanın maksimum bağlam uzunluğunu aştığını finish_reason="length" gösteren ileti max_tokensiçeriğinin kısmen kesilebileceğini unutmayın.

Tür: dize veya OpenAI.ResponseFormatText veya OpenAI.ResponseFormatJsonObject veya OpenAI.ResponseFormatJsonSchema

OpenAI.AssistantsApiToolChoiceOption

Model tarafından çağrılan aracı (varsa) denetler. none modelin herhangi bir araç çağırmayacağı ve bunun yerine bir ileti oluşturduğu anlamına gelir. auto varsayılan değerdir ve modelin ileti oluşturma veya bir veya daha fazla araç çağırma arasında seçim yapabileceğiniz anlamına gelir. required , modelin kullanıcıya yanıt vermeden önce bir veya daha fazla araç çağırması gerektiği anlamına gelir. veya gibi {"type": "file_search"}{"type": "function", "function": {"name": "my_function"}} belirli bir aracı belirtmek, modeli söz konusu aracı çağırmaya zorlar.

Tür: string veya OpenAI.AssistantsNamedToolChoice

OpenAI.AssistantsNamedToolChoice

Modelin kullanması gereken aracı belirtir. Modeli belirli bir aracı çağırmaya zorlamak için kullanın.

İsim	Türü	Description	Gerekli	Varsayılan
function	OpenAI.AssistantsNamedToolChoiceFunction		Hayı
type	enum	Aracın türü. türü ise `function`, işlev adı ayarlanmalıdır Olası değerler: `function`, `code_interpreter`, `file_search`	Evet

OpenAI.AssistantsNamedToolChoiceFunction

İsim	Türü	Description	Gerekli	Varsayılan
name	String		Evet

OpenAI.AudioTranscription

İsim	Türü	Description	Gerekli
language	String	Giriş sesinin dili. giriş dilini sağlama ISO-639-1 (ör. `en`) biçimi doğruluğu ve gecikme süresini artırır.	Hayı
model	String	Transkripsiyon için kullanılacak model. Geçerli seçenekler : `whisper-1`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`ve `gpt-4o-transcribe-diarize`. Konuşmacı etiketleriyle diarizasyona ihtiyacınız olduğunda kullanın `gpt-4o-transcribe-diarize` .	Hayı
prompt	String	Modelin stiline kılavuzluk etmek veya önceki bir sese devam etmek için isteğe bağlı bir metin Segment. için`whisper-1`, istem anahtar sözcüklerin listesidir. Modeller için `gpt-4o-transcribe` (hariç `gpt-4o-transcribe-diarize`), istem boş bir metin dizesidir, örneğin "teknolojiyle ilgili sözcükleri bekleme".	Hayı

OpenAI.AutoChunkingStrategyRequestParam

Varsayılan strateji. Bu strateji şu anda ve'nin max_chunk_size_tokens bir 800 sürümünü chunk_overlap_tokens400kullanır.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Her zaman `auto`. Olası değerler: `auto`	Evet

OpenAI.Batch

İsim	Türü	Description	Gerekli
iptal edildiğinde	tamsayı	Toplu işleminin iptal edildiği zaman için Unix zaman damgası (saniye cinsinden).	Hayı
iptal_edildiğinde	tamsayı	Toplu işlemi iptal etme işleminin başladığı zaman için Unix zaman damgası (saniye cinsinden).	Hayı
tamamlanma_tarihi	tamsayı	Toplu işleminin ne zaman tamamlandığına ilişkin Unix zaman damgası (saniye cinsinden).	Hayı
tamamlama penceresi	String	Toplu işlemin gerçekleştirileceği zaman dilimi.	Evet
oluşturulma_tarihi	tamsayı	Toplu iş oluşturulduğu zaman için Unix zaman damgası (saniye cinsinden).	Evet
endpoint	String	Toplu iş tarafından kullanılan OpenAI API uç noktası.	Evet
hata_dosya_id	String	Hata içeren isteklerin çıkışlarını içeren dosyanın kimliği.	Hayı
Hata	OpenAI.BatchErrors		Hayı
süresi dolma tarihi	tamsayı	Toplu iş süresinin dolmasına ilişkin Unix zaman damgası (saniye cinsinden).	Hayı
sona_erdigi_tarih	tamsayı	Toplu iş süresinin dolacağı zaman için Unix zaman damgası (saniye cinsinden).	Hayı
başarısız_olduğunda	tamsayı	Toplu iş başarısız olduğunda unix zaman damgası (saniye cinsinden).	Hayı
finalize_ediliyor	tamsayı	Toplu işlemi sonlandırmaya başladığı zaman için Unix zaman damgası (saniye cinsinden).	Hayı
kimlik	String		Evet
devam_ediyor	tamsayı	Toplu işlemin ne zaman başladığının Unix zaman damgası (saniye cinsinden).	Hayı
girdi_dosya_kimliği	dize veya null		Hayı
metadata	OpenAI.Metadata veya null		Hayı
model	String	Toplu işlemi işlemek için kullanılan model kimliği( gibi `gpt-5-2025-08-07`). OpenAI farklı özelliklere, performansa sahip çok çeşitli modeller sunar özellikleri ve fiyat noktaları. Modele bakın kullanılabilir modellere göz atma ve modelleri karşılaştırma kılavuzu .	Hayı
nesne	enum	Her zaman `batch`olan nesne türü. Olası değerler: `batch`	Evet
çıkış dosya kimliği	String	Başarıyla yürütülen isteklerin çıkışlarını içeren dosyanın kimliği.	Hayı
istek_sayıları	OpenAI.BatchRequestCounts	İstek, toplu iş içindeki farklı durumlar için sayılır.	Hayı
durum	enum	Toplu işlemin mevcut durumu. Olası değerler: `validating`, `failed`, `in_progress`, `finalizing`, `completed`, `expired`, `cancelling`, `cancelled`	Evet
usage	OpenAI.BatchUsage		Hayı
└─ girdi_simgeleri	tamsayı		Evet
└─ giriş_jeton_detayları	OpenAI.BatchUsageInputTokensDetails		Evet
└─ çıkış_birimleri	tamsayı		Evet
└─ output_tokens_details	OpenAI.BatchUsageOutputTokensDetails		Evet
└─ toplam_jetonlar	tamsayı		Evet

OpenAI.BatchError

İsim	Türü	Description	Gerekli
kod	String	Hata türünü tanımlayan bir hata kodu.	Hayı
satır	tamsayı veya null		Hayı
mesaj	String	Hata hakkında daha fazla ayrıntı sağlayan, okunabilir bir ileti.	Hayı
param	dize veya null		Hayı

OpenAI.BatchErrors

İsim	Türü	Description	Gerekli	Varsayılan
veriler	OpenAI.BatchError dizisi		Hayı
nesne	String		Hayı

OpenAI.BatchRequestCounts

İstek, toplu iş içindeki farklı durumlar için sayılır.

İsim	Türü	Description	Gerekli
Tamamlandı	tamsayı	Başarıyla tamamlanan istek sayısı.	Evet
başarısız	tamsayı	Başarısız olan istek sayısı.	Evet
toplam	tamsayı	Toplu işlemdeki toplam istek sayısı.	Evet

OpenAI.BatchUsage

İsim	Türü	Gerekli
input_tokens	tamsayı	Evet
input_tokens_details	OpenAI.BatchUsageInputTokensDetails	Evet
output_tokens	tamsayı	Evet
output_tokens_details	OpenAI.BatchUsageOutputTokensDetails	Evet
total_tokens	tamsayı	Evet

OpenAI.BatchUsageInputTokensDetails

İsim	Türü	Description	Gerekli	Varsayılan
cached_tokens	tamsayı		Evet

OpenAI.BatchUsageOutputTokensDetails

İsim	Türü	Description	Gerekli	Varsayılan
akıl yürütme birimleri	tamsayı		Evet

OpenAI.ChatCompletionAllowedTools

Modelin kullanabileceği araçları önceden tanımlanmış bir kümeyle kısıtlar.

İsim	Türü	Description	Gerekli	Varsayılan
modu	enum	Modelin kullanabileceği araçları önceden tanımlanmış bir kümeyle kısıtlar. `auto` modelin izin verilen araçlar arasından seçim yapmasına ve Mesaj. `required` modelin izin verilen araçlardan birini veya daha fazlasını çağırmasını gerektirir. Olası değerler: `auto`, `required`	Evet
araçlar	nesne dizisi	Modelin çağırmasına izin verilmesi gereken araç tanımlarının listesi. Sohbet Tamamlamaları API'sinde araç tanımlarının listesi şöyle görünebilir: `json<br> [<br> { "type": "function", "function": { "name": "get_weather" } },<br> { "type": "function", "function": { "name": "get_time" } }<br> ]<br>`	Evet

OpenAI.ChatCompletionAllowedToolsChoice

Modelin kullanabileceği araçları önceden tanımlanmış bir kümeyle kısıtlar.

İsim	Türü	Description	Gerekli	Varsayılan
izin verilen araçlar	OpenAI.ChatCompletionAllowedTools	Modelin kullanabileceği araçları önceden tanımlanmış bir kümeyle kısıtlar.	Evet
type	enum	İzin verilen araç yapılandırma türü. Her zaman `allowed_tools`. Olası değerler: `allowed_tools`	Evet

OpenAI.ChatCompletionFunctionCallOption

aracılığıyla {"name": "my_function"} belirli bir işlevin belirtilmesi, modeli bu işlevi çağırmaya zorlar.

İsim	Türü	Description	Gerekli	Varsayılan
name	String	Çağrılacak işlevin adı.	Evet

OpenAI.ChatCompletionFunctions

İsim	Türü	Description	Gerekli
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ı. 64 karaktere kadar a-z, A-Z, 0-9, alt çizgi veya kısa çizgi içermelidir.	Evet
parameters	OpenAI.FunctionParameters	İşlevlerin kabullediği, JSON Şeması nesnesi olarak tanımlanan parametreler. Örnekler için guide ve format hakkında dokümantasyon için JSON Schema reference adresine bakınız. Atlama `parameters` , boş parametre listesi olan bir işlevi tanımlar.	Hayı

OpenAI.ChatCompletionMessageCustomToolCall

Model tarafından oluşturulan özel bir araca çağrı.

İsim	Türü	Description	Gerekli
custom	OpenAI.ChatCompletionMessageCustomToolCallCustom		Evet
└─ giriş	String		Evet
└─ ad	String		Evet
kimlik	String	Araç çağrısının kimliği.	Evet
type	enum	Aracın türü. Her zaman `custom`. Olası değerler: `custom`	Evet

OpenAI.ChatCompletionMessageCustomToolCallCustom

İsim	Türü	Description	Gerekli	Varsayılan
girdi	String		Evet
name	String		Evet

OpenAI.ChatCompletionMessageToolCall

Model tarafından oluşturulan bir işlev aracı çağrısı.

İsim	Türü	Description	Gerekli
function	OpenAI.ChatCompletionMessageToolCallFunction		Evet
└─ argümanlar	String		Evet
└─ ad	String		Evet
kimlik	String	Araç çağrısının kimliği.	Evet
type	enum	Aracın türü. Şu anda yalnızca `function` desteklenmektedir. Olası değerler: `function`	Evet

OpenAI.ChatCompletionMessageToolCallChunk

İsim	Türü	Description	Gerekli
function	OpenAI.ChatCompletionMessageToolCallChunkFunction		Hayı
kimlik	String	Araç çağrısının kimliği.	Hayı
indeks	tamsayı		Evet
type	enum	Aracın türü. Şu anda yalnızca `function` desteklenmektedir. Olası değerler: `function`	Hayı

OpenAI.ChatCompletionMessageToolCallChunkFunction

İsim	Türü	Description	Gerekli	Varsayılan
arguments	String		Hayı
name	String		Hayı

OpenAI.ChatCompletionMessageToolCallFunction

İsim	Türü	Description	Gerekli	Varsayılan
arguments	String		Evet
name	String		Evet

OpenAI.ChatCompletionMessageToolCalls

Model tarafından oluşturulan, işlev çağrıları gibi araç çağrıları.

OpenAI.ChatCompletionMessageToolCallsItem

Model tarafından oluşturulan, işlev çağrıları gibi araç çağrıları.

OpenAI.ChatCompletionNamedToolChoice

Modelin kullanması gereken aracı belirtir. Modeli belirli bir işlevi çağırmaya zorlamak için kullanın.

İsim	Türü	Description	Gerekli	Varsayılan
function	OpenAI.ChatCompletionNamedToolChoiceFunction		Evet
type	enum	İşlev çağrısı için türü her zaman `function`şeklindedir. Olası değerler: `function`	Evet

OpenAI.ChatCompletionNamedToolChoiceCustom

Modelin kullanması gereken aracı belirtir. Modeli belirli bir özel aracı çağırmaya zorlamak için kullanın.

İsim	Türü	Description	Gerekli	Varsayılan
custom	OpenAI.ChatCompletionNamedToolChoiceCustomCustom		Evet
type	enum	Özel araç çağrısı için türü her zaman `custom`şeklindedir. Olası değerler: `custom`	Evet

OpenAI.ChatCompletionNamedToolChoiceCustomCustom

İsim	Türü	Description	Gerekli	Varsayılan
name	String		Evet

OpenAI.ChatCompletionNamedToolChoiceFunction

İsim	Türü	Description	Gerekli	Varsayılan
name	String		Evet

OpenAI.ChatCompletionRequestAssistantMessage

Model tarafından kullanıcı iletilerine yanıt olarak gönderilen iletiler.

İsim	Türü	Description	Gerekli
audio	OpenAI.ChatCompletionRequestAssistantMessageAudio veya null	Modelin daha önceki bir ses yanıtına ilişkin veriler.	Hayı
içerik	OpenAI.ChatCompletionRequestAssistantMessageContentPart veya null dizesi veya dizisi		Hayı
function_call	OpenAI.ChatCompletionRequestAssistantMessageFunctionCall veya null		Hayı
name	String	Katılımcı için isteğe bağlı bir ad. Aynı rolün katılımcılarını ayırt etmek için model bilgilerini sağlar.	Hayı
Ret	dize veya null		Hayı
role	enum	İleti yazarının rolü( bu örnekte `assistant`). Olası değerler: `assistant`	Evet
tool_calls	OpenAI.ChatCompletionMessageToolCalls	Model tarafından oluşturulan, işlev çağrıları gibi araç çağrıları.	Hayı

OpenAI.ChatCompletionRequestAssistantMessageAudio

İsim	Türü	Description	Gerekli	Varsayılan
kimlik	String		Evet

OpenAI.ChatCompletionRequestAssistantMessageContentPart

OpenAI.ChatCompletionRequestAssistantMessageContentPart 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
`refusal`	OpenAI.ChatCompletionRequestMessageContentPartRefusal
`text`	OpenAI.ChatCompletionRequestAssistantMessageContentPartChatCompletionRequestMessageContentPartText

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.ChatCompletionRequestAssistantMessageContentPartType		Evet

OpenAI.ChatCompletionRequestAssistantMessageContentPartChatCompletionRequestMessageContentPartText

Metin girişleri hakkında bilgi edinin.

İsim	Türü	Description	Gerekli	Varsayılan
text	String	Metin içeriği.	Evet
type	enum	İçerik bölümünün türü. Olası değerler: `text`	Evet

OpenAI.ChatCompletionRequestAssistantMessageContentPartType

Mülkiyet	Değer
Türü	String
Değerler	`text` `refusal`

OpenAI.ChatCompletionRequestAssistantMessageFunctionCall

İsim	Türü	Description	Gerekli	Varsayılan
arguments	String		Evet
name	String		Evet

OpenAI.ChatCompletionRequestDeveloperMessage

Kullanıcı tarafından gönderilen iletilerden bağımsız olarak modelin izlemesi gereken geliştirici tarafından sağlanan yönergeler. o1 modelleri ve daha yenisi ile iletiler önceki developersystem iletilerin yerini alır.

İsim	Türü	Description	Gerekli
içerik	OpenAI.ChatCompletionRequestMessageContentPartText dizesi veya dizisi	Geliştirici iletisinin içeriği.	Evet
name	String	Katılımcı için isteğe bağlı bir ad. Aynı rolün katılımcılarını ayırt etmek için model bilgilerini sağlar.	Hayı
role	enum	İleti yazarının rolü( bu örnekte `developer`). Olası değerler: `developer`	Evet

OpenAI.ChatCompletionRequestFunctionMessage

İsim	Türü	Description	Gerekli
içerik	dize veya null		Evet
name	String	Çağrılacak işlevin adı.	Evet
role	enum	İleti yazarının rolü( bu örnekte `function`). Olası değerler: `function`	Evet

OpenAI.ChatCompletionRequestMessage

OpenAI.ChatCompletionRequestMessage 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
`assistant`	OpenAI.ChatCompletionRequestAssistantMessage
`developer`	OpenAI.ChatCompletionRequestDeveloperMessage
`function`	OpenAI.ChatCompletionRequestFunctionMessage
`system`	OpenAI.ChatCompletionRequestSystemMessage
`user`	OpenAI.ChatCompletionRequestUserMessage
`tool`	OpenAI.ChatCompletionRequestToolMessage

İsim	Türü	Description	Gerekli	Varsayılan
role	OpenAI.ChatCompletionRequestMessageType		Evet

OpenAI.ChatCompletionRequestMessageContentPartAudio

İsim	Türü	Description	Gerekli	Varsayılan
input_audio	OpenAI.ChatCompletionRequestMessageContentPartAudioInputAudio		Evet
type	enum	İçerik bölümünün türü. Her zaman `input_audio`. Olası değerler: `input_audio`	Evet

OpenAI.ChatCompletionRequestMessageContentPartAudioInputAudio

İsim	Türü	Description	Gerekli	Varsayılan
veriler	String		Evet
format	enum	Olası değerler: `wav`, `mp3`	Evet

OpenAI.ChatCompletionRequestMessageContentPartFile

Metin oluşturma için dosya girişleri hakkında bilgi edinin.

İsim	Türü	Description	Gerekli
dosya	OpenAI.ChatCompletionRequestMessageContentPartFileFile		Evet
└─ dosya_verisi	String		Hayı
└─ dosya_kimliği	String		Hayı
└─ dosya adı	String		Hayı
type	enum	İçerik bölümünün türü. Her zaman `file`. Olası değerler: `file`	Evet

OpenAI.ChatCompletionRequestMessageContentPartFileFile

İsim	Türü	Gerekli
file_data	String	Hayı
dosya_kimlik	String	Hayı
filename	String	Hayı

OpenAI.ChatCompletionRequestMessageContentPartImage

İsim	Türü	Description	Gerekli	Varsayılan
image_url	OpenAI.ChatCompletionRequestMessageContentPartImageImageUrl		Evet
type	enum	İçerik bölümünün türü. Olası değerler: `image_url`	Evet

OpenAI.ChatCompletionRequestMessageContentPartImageImageUrl

İsim	Türü	Description	Gerekli	Varsayılan
detail	enum	Olası değerler: `auto`, `low`, `high`	Hayı
url	String		Evet

OpenAI.ChatCompletionRequestMessageContentPartRefusal

İsim	Türü	Description	Gerekli	Varsayılan
Ret	String	Model tarafından oluşturulan reddetme iletisi.	Evet
type	enum	İçerik bölümünün türü. Olası değerler: `refusal`	Evet

OpenAI.ChatCompletionRequestMessageContentPartText

İsim	Türü	Description	Gerekli	Varsayılan
text	String	Metin içeriği.	Evet
type	enum	İçerik bölümünün türü. Olası değerler: `text`	Evet

OpenAI.ChatCompletionRequestMessageType

Mülkiyet	Değer
Türü	String
Değerler	`developer` `system` `user` `assistant` `tool` `function`

OpenAI.ChatCompletionRequestSystemMessage

Kullanıcı tarafından gönderilen iletilerden bağımsız olarak modelin izlemesi gereken geliştirici tarafından sağlanan yönergeler. O1 modelleri ve daha yenisi ile bunun yerine developer iletileri bu amaçla kullanın.

İsim	Türü	Description	Gerekli
içerik	OpenAI.ChatCompletionRequestSystemMessageContentPart dizesi veya dizisi	Sistem iletisinin içeriği.	Evet
name	String	Katılımcı için isteğe bağlı bir ad. Aynı rolün katılımcılarını ayırt etmek için model bilgilerini sağlar.	Hayı
role	enum	İleti yazarının rolü( bu örnekte `system`). Olası değerler: `system`	Evet

OpenAI.ChatCompletionRequestSystemMessageContentPart

Referanslar: OpenAI.ChatCompletionRequestMessageContentPartText

OpenAI.ChatCompletionRequestToolMessage

İsim	Türü	Description	Gerekli
içerik	OpenAI.ChatCompletionRequestToolMessageContentPart dizesi veya dizisi	Araç iletisinin içeriği.	Evet
role	enum	İleti yazarının rolü( bu örnekte `tool`). Olası değerler: `tool`	Evet
tool_call_id	String	Bu iletinin yanıt verdiği araç komutu.	Evet

OpenAI.ChatCompletionRequestToolMessageContentPart

Referanslar: OpenAI.ChatCompletionRequestMessageContentPartText

OpenAI.ChatCompletionRequestUserMessage

Son kullanıcı tarafından gönderilen ve istemler veya ek bağlam bilgileri içeren iletiler.

İsim	Türü	Description	Gerekli
içerik	OpenAI.ChatCompletionRequestUserMessageContentPart dizesi veya dizisi	Kullanıcı iletisinin içeriği.	Evet
name	String	Katılımcı için isteğe bağlı bir ad. Aynı rolün katılımcılarını ayırt etmek için model bilgilerini sağlar.	Hayı
role	enum	İleti yazarının rolü( bu örnekte `user`). Olası değerler: `user`	Evet

OpenAI.ChatCompletionRequestUserMessageContentPart

OpenAI.ChatCompletionRequestUserMessageContentPart 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_url`	OpenAI.ChatCompletionRequestMessageContentPartImage
`input_audio`	OpenAI.ChatCompletionRequestMessageContentPartAudio
`file`	OpenAI.ChatCompletionRequestMessageContentPartFile
`text`	OpenAI.ChatCompletionRequestUserMessageContentPartChatCompletionRequestMessageContentPartText

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.ChatCompletionRequestUserMessageContentPartType		Evet

OpenAI.ChatCompletionRequestUserMessageContentPartChatCompletionRequestMessageContentPartText

Metin girişleri hakkında bilgi edinin.

İsim	Türü	Description	Gerekli	Varsayılan
text	String	Metin içeriği.	Evet
type	enum	İçerik bölümünün türü. Olası değerler: `text`	Evet

OpenAI.ChatCompletionRequestUserMessageContentPartType

Mülkiyet	Değer
Türü	String
Değerler	`text` `image_url` `input_audio` `file`

OpenAI.ChatCompletionResponseMessage

Ses çıkış modu istenirse, bu nesne modelin ses yanıtıyla ilgili verileri içerir.

İsim	Türü	Description	Gerekli
Açıklamalar	OpenAI.ChatCompletionResponseMessageAnnotations dizisi	Mesaj için ek açıklamalar, kullanılan duruma uygun olduğunda web arama aracı.	Hayı
audio	OpenAI.ChatCompletionResponseMessageAudio veya null		Hayı
içerik	dize veya null		Evet
function_call	OpenAI.ChatCompletionResponseMessageFunctionCall		Hayı
└─ argümanlar	String		Evet
└─ ad	String		Evet
reasoning_content	String	Desteklenen modellerden oluşturulan akıl yürütme içeriğini içeren Azure özgü bir uzantı özelliği.	Hayı
Ret	dize veya null		Evet
role	enum	Bu iletinin yazarının rolü. Olası değerler: `assistant`	Evet
tool_calls	OpenAI.ChatCompletionMessageToolCallsItem	Model tarafından oluşturulan, işlev çağrıları gibi araç çağrıları.	Hayı

OpenAI.ChatCompletionResponseMessageAnnotations

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olası değerler: `url_citation`	Evet
url_citation	OpenAI.ChatCompletionResponseMessageAnnotationsUrlCitation		Evet

OpenAI.ChatCompletionResponseMessageAnnotationsUrlCitation

İsim	Türü	Gerekli
end_index	tamsayı	Evet
start_index	tamsayı	Evet
title	String	Evet
url	String	Evet

OpenAI.ChatCompletionResponseMessageAudio

İsim	Türü	Gerekli
veriler	String	Evet
sona_erdigi_tarih	tamsayı	Evet
kimlik	String	Evet
transcript	String	Evet

OpenAI.ChatCompletionResponseMessageFunctionCall

İsim	Türü	Description	Gerekli	Varsayılan
arguments	String		Evet
name	String		Evet

OpenAI.ChatCompletionStreamOptions

Akış yanıtı seçenekleri. Bunu yalnızca ayarladığınızda ayarlayın stream: true.

İsim	Türü	Description	Gerekli	Varsayılan
include_obfuscation	Boolean	True olduğunda, akış gizleme etkinleştirilir. Akış gizleme eklemeleri değişiklik olaylarının akışındaki bir `obfuscation` alana rastgele karakterler yük boyutlarını belirli yan kanal saldırılarına karşı bir azaltma olarak normalleştirin. Bu gizleme alanları varsayılan olarak eklenir, ancak küçük bir miktar eklenir veri akışı için ek yük. Şunu ayarlayabilirsiniz:`include_obfuscation` arasında ağ bağlantılarına güveniyorsanız bant genişliğini iyileştirmek için false uygulamanızı ve OpenAI API'sini seçin.	Hayı
include_usage	Boolean	Ayarlanırsa, `data: [DONE]` öncesinde ek bir parça yayınlanacaktır. Mesaj. `usage` Bu öbek üzerindeki alanda belirteç kullanım istatistikleri gösterilir tüm istek için ve `choices` alan her zaman boş olacaktır dizi. Diğer tüm öbekler de bir `usage` alanı içerir, ancak bu alan null değer içerir. değer. NOT: Akış kesintiye uğrarsa, almayabilirsiniz. isteğin toplam belirteç kullanımını içeren son kullanım parçası.	Hayı

OpenAI.ChatCompletionStreamResponseDelta

Akışlı model yanıtları tarafından oluşturulan bir sohbet tamamlama deltası.

İsim	Türü	Description	Gerekli
içerik	dize veya null		Hayı
function_call	OpenAI.ChatCompletionStreamResponseDeltaFunctionCall		Hayı
└─ argümanlar	String		Hayı
└─ ad	String		Hayı
reasoning_content	String	Desteklenen modellerden oluşturulan akıl yürütme içeriğini içeren Azure özgü bir uzantı özelliği.	Hayı
Ret	dize veya null		Hayı
role	enum	Bu iletinin yazarının rolü. Olası değerler: `developer`, `system`, `user`, `assistant`, `tool`	Hayı
tool_calls	OpenAI.ChatCompletionMessageToolCallChunk dizisi		Hayı

OpenAI.ChatCompletionStreamResponseDeltaFunctionCall

İsim	Türü	Description	Gerekli	Varsayılan
arguments	String		Hayı
name	String		Hayı

OpenAI.ChatCompletionTokenLogprob

İsim	Türü	Description	Gerekli
bytes	tamsayı veya null dizisi		Evet
logprob	Numara	İlk 20 en olası belirtecin içindeyse, bu belirtecin log olasılığı. Aksi takdirde, belirtecin çok düşük bir olasılık olduğunu göstermek için değeri `-9999.0` kullanılır.	Evet
token	String	Jeton.	Evet
top_logprobs	OpenAI.ChatCompletionTokenLogprobTopLogprobs dizisi	Bu belirteç konumunda en olası belirteçlerin ve günlük olasılıklarının listesi. Nadir durumlarda, döndürülen istek `top_logprobs` sayısından daha az olabilir.	Evet

OpenAI.ChatCompletionTokenLogprobTopLogprobs

İsim	Türü	Gerekli
bytes	tamsayı veya null dizisi	Evet
logprob	Numara	Evet
token	String	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.ChatCompletionToolChoiceOption

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. aracılığıyla {"type": "function", "function": {"name": "my_function"}} belirli bir aracın belirtilmesi, modeli söz konusu aracı çağırmaya zorlar. none hiçbir araç mevcut olmadığında varsayılan değerdir. auto araçlar varsa varsayılan değerdir.

Tür: string veya OpenAI.ChatCompletionAllowedToolsChoice veya OpenAI.ChatCompletionNamedToolChoice veya OpenAI.ChatCompletionNamedToolChoiceCustom

OpenAI.ChunkingStrategyRequestParam

Dosya/dosyaları öbeklemek için kullanılan öbekleme stratejisi. Ayarlanmadıysa, stratejiyi auto kullanır. Yalnızca file_ids boş değilse geçerlidir.

OpenAI.ChunkingStrategyRequestParam 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
`auto`	OpenAI.AutoChunkingStrategyRequestParam
`static`	OpenAI.StaticChunkingStrategyRequestParam

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.ChunkingStrategyRequestParamType		Evet

OpenAI.ChunkingStrategyRequestParamType

Mülkiyet	Değer
Türü	String
Değerler	`auto` `static`

OpenAI.ChunkingStrategyResponse

Dosyayı öbeklemek için kullanılan strateji.

OpenAI.ChunkingStrategyResponse 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
`static`	OpenAI.StaticChunkingStrategyResponseParam
`other`	OpenAI.OtherChunkingStrategyResponseParam

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.ChunkingStrategyResponseType		Evet

OpenAI.ChunkingStrategyResponseType

Mülkiyet	Değer
Türü	String
Değerler	`static` `other`

OpenAI.ClickButtonType

Mülkiyet	Değer
Türü	String
Değerler	`left` `right` `wheel` `back` `forward`

OpenAI.ClickParam

Tıklama eylemi.

İsim	Türü	Description	Gerekli
düğme	OpenAI.ClickButtonType		Evet
type	enum	Olay türünü belirtir. Tıklama hareketi için bu özellik her `click`zaman . 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.CodeInterpreterContainerAuto

Kod yorumlayıcı kapsayıcısı için yapılandırma. İsteğe bağlı olarak kodun çalıştırıldığı dosyaların kimliklerini belirtin.

İsim	Türü	Description	Gerekli
dosya_kimlikleri	dize dizisi	Kodunuz için kullanılabilir hale getirmek üzere yüklenen dosyaların isteğe bağlı bir listesi.	Hayı
bellek sınırı	OpenAI.ContainerMemoryLimit veya null		Hayı
type	enum	Her zaman `auto`. Olası değerler: `auto`	Evet

OpenAI.KodYorumlayıcıÇıktıGörüntüsü

Kod yorumlayıcıdan görüntü çıkışı.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Çıktının türü. Her zaman `image`. Olası değerler: `image`	Evet
url	String	Kod yorumlayıcıdan görüntü çıkışının URL'si.	Evet

OpenAI.CodeInterpreterOutputLogs

Kod yorumlayıcısının günlük çıktısı.

İsim	Türü	Description	Gerekli	Varsayılan
logs	String	Kod yorumlayıcısının günlük çıktısı.	Evet
type	enum	Çıktının türü. Her zaman `logs`. Olası değerler: `logs`	Evet

OpenAI.CodeInterpreterTool

İstemi yanıtlamaya yardımcı olmak için Python kodu çalıştıran bir araç.

İsim	Türü	Description	Gerekli	Varsayılan
container	string veya OpenAI.CodeInterpreterContainerAuto	Kod yorumlayıcı kapsayıcısı. Kapsayıcı kimliği veya bir nesne olabilir , kodunuz için kullanılabilir hale getirmek için karşıya yüklenen dosya kimliklerini ve bir isteğe bağlı `memory_limit` ayarına bakın.	Evet
type	enum	Kod yorumlayıcı aracının türü. Her zaman `code_interpreter`. Olası değerler: `code_interpreter`	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
key	String	Değerle karşılaştırmak için anahtar.	Evet
type	enum	Karşılaştırma operatörünü belirtir: `eq`, `ne`, `gt`, `gteltlteinnin`. - `eq`:Eşit -tir - `ne`: eşit değil - `gt`: büyüktür - `gte`: büyüktür veya eşittir - `lt`: daha azdır - `lte`: küçüktür veya eşittir - `in`:Inç - `nin`: içinde değil Olası değerler: `eq`, `ne`, `gt`, `gte`, , `lt`, `lte`	Evet
değer	OpenAI.ComparisonFilterValueItems dizesi veya numarası ya da boole ya da dizisi	Öznitelik anahtarıyla karşılaştıracak değer; dize, sayı veya boole türlerini destekler.	Evet

OpenAI.ComparisonFilterValueItems

Bu şema aşağıdaki türlerden birini kabul eder:

string
sayı

OpenAI.CompletionUsage

Tamamlanma isteği için kullanım istatistikleri.

İsim	Türü	Description	Gerekli
completion_tokens	tamsayı	Oluşturulan tamamlamadaki belirteçlerin sayısı.	Evet
completion_tokens_details	OpenAI.CompletionUsageCompletionTokensDetails		Hayı
└─ kabul edilen tahmin belirteçleri	tamsayı		Hayı
└─ ses_öğeleri	tamsayı		Hayı
└─ akıl yürütme_tokenlar	tamsayı		Hayı
└─ reddedilen_tahmin_tokenları	tamsayı		Hayı
prompt_tokens	tamsayı	İstemdeki belirteç sayısı.	Evet
prompt_tokens_details	OpenAI.CompletionUsagePromptTokensDetails		Hayı
└─ ses_öğeleri	tamsayı		Hayı
└─ önbelleğe alınmış jetonlar	tamsayı		Hayı
total_tokens	tamsayı	İstekte kullanılan toplam belirteç sayısı (istem + tamamlama).	Evet

OpenAI.CompletionUsageCompletionTokensDetails

İsim	Türü	Gerekli
accepted_prediction_tokens	tamsayı	Hayı
ses_jetonları	tamsayı	Hayı
akıl yürütme birimleri	tamsayı	Hayı
rejected_prediction_tokens	tamsayı	Hayı

OpenAI.CompletionUsagePromptTokensDetails

İsim	Türü	Description	Gerekli	Varsayılan
ses_jetonları	tamsayı		Hayı
cached_tokens	tamsayı		Hayı

OpenAI.CompoundFilter

and veya or kullanarak birden çok filtreyi birleştirin.

İsim	Türü	Description	Gerekli	Varsayılan
filters	OpenAI.ComparisonFilter dizisi veya nesnesi	Birleştirilecek filtreler dizisi. Öğeler `ComparisonFilter` veya `CompoundFilter` olabilir.	Evet
type	enum	İşlem türü: `and` veya `or`. Olası değerler: `and`, `or`	Evet

OpenAI.ComputerAction

OpenAI.ComputerAction için Ayrıştırıcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
`click`	OpenAI.ClickParam
`double_click`	OpenAI.DoubleClickAction
`drag`	OpenAI.Drag
`keypress`	OpenAI.KeyPressAction
`move`	OpenAI.Move
`screenshot`	OpenAI.Ekran Görüntüsü
`scroll`	OpenAI.Scroll
`type`	OpenAI.Type
`wait`	OpenAI.Wait

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.ComputerActionType		Evet

OpenAI.ComputerActionType

Mülkiyet	Değer
Türü	String
Değerler	`click` `double_click` `drag` `keypress` `move` `screenshot` `scroll` `type` `wait`

OpenAI.ComputerCallSafetyCheckParam

Bilgisayar çağrısı için bekleyen bir güvenlik denetimi.

İsim	Türü	Description	Gerekli
kod	dize veya null		Hayı
kimlik	String	Bekleyen güvenlik denetiminin kimliği.	Evet
mesaj	dize veya null		Hayı

OpenAI.ComputerEnvironment

Mülkiyet	Değer
Türü	String
Değerler	`windows` `mac` `linux` `ubuntu` `browser`

OpenAI.ComputerScreenshotContent

Bilgisayarın ekran görüntüsü.

İsim	Türü	Description	Gerekli
dosya_kimlik	dize veya null		Evet
image_url	dize veya null		Evet
type	enum	Olay türünü belirtir. Bilgisayar ekran görüntüsü için bu özellik her zaman olarak `computer_screenshot`ayarlanır. Olası değerler: `computer_screenshot`	Evet

OpenAI.ComputerScreenshotImage

Bilgisayar kullanım aracıyla kullanılan bir bilgisayar ekran görüntüsü.

İsim	Türü	Description	Gerekli
dosya_kimlik	String	Yüklenmiş dosyanın, ekran görüntüsünü içeren kimliği.	Hayı
image_url	String	Ekran görüntüsü URL'si.	Hayı
type	enum	Olay türünü belirtir. Bir bilgisayar ekran görüntüsü için bu özellik şu şekildedir: her zaman `computer_screenshot` olarak ayarlanır. Olası değerler: `computer_screenshot`	Evet

OpenAI Bilgisayar Kullanımı Önizleme Aracı

Sanal bilgisayarı denetleyebilen bir araç.

İsim	Türü	Description	Gerekli
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	OpenAI.ComputerEnvironment		Evet
type	enum	Bilgisayar kullanım aracının türü. Her zaman `computer_use_preview`. Olası değerler: `computer_use_preview`	Evet

OpenAI.ContainerFileCitationBody

Model yanıtı oluşturmak için kullanılan bir konteyner dosyası için bir atıf.

İsim	Türü	Description	Gerekli
container_id	String	Konteyner dosyasının kimliği.	Evet
end_index	tamsayı	Mesajdaki konteyner dosyası alıntısının son karakterinin indeksi.	Evet
dosya_kimlik	String	Dosyanın kimliği.	Evet
filename	String	Bahsedilen konteyner dosyasının dosya adı.	Evet
start_index	tamsayı	Mesajdaki konteyner dosyası atıfının ilk karakterinin indeksi.	Evet
type	enum	Konteyner dosyası atıfının türü. Her zaman `container_file_citation`. Olası değerler: `container_file_citation`	Evet

OpenAI.ContainerFileListResource

İsim	Türü	Description	Gerekli
veriler	OpenAI.ContainerFileResource dizisi	Kapsayıcı dosyalarının listesi.	Evet
ilk_kimlik	String	Listedeki ilk dosyanın kimliği.	Evet
daha_fazla	Boolean	Kullanılabilir daha fazla dosya olup olmadığı.	Evet
son_kimlik	String	Listedeki son dosyanın kimliği.	Evet
nesne	enum	Döndürülen nesnenin türü 'list' olmalıdır. Olası değerler: `list`	Evet

OpenAI.ContainerFileResource

İsim	Türü	Description	Gerekli
bytes	tamsayı	Dosyanın boyutu bayt cinsinden.	Evet
container_id	String	Bu dosyanın ait olduğu kapsayıcı.	Evet
oluşturulma_tarihi	tamsayı	Dosyanın oluşturulduğu unix zaman damgası (saniye).	Evet
kimlik	String	Dosyanın benzersiz tanımlayıcısı.	Evet
nesne	enum	Bu nesnenin türü (`container.file`). Olası değerler: `container.file`	Evet
path	String	Kapsayıcıdaki dosyanın yolu.	Evet
kaynak	String	Dosyanın kaynağı (örneğin, , `userassistant`).	Evet

OpenAI.ContainerListResource

İsim	Türü	Description	Gerekli
veriler	OpenAI.ContainerResource dizisi	Kapsayıcıların listesi.	Evet
ilk_kimlik	String	Listedeki ilk kapsayıcının kimliği.	Evet
daha_fazla	Boolean	Kullanılabilir daha fazla kapsayıcı olup olmadığı.	Evet
son_kimlik	String	Listedeki son kapsayıcının kimliği.	Evet
nesne	enum	Döndürülen nesnenin türü 'list' olmalıdır. Olası değerler: `list`	Evet

OpenAI.ContainerMemoryLimit

Mülkiyet	Değer
Türü	String
Değerler	`1g` `4g` `16g` `64g`

OpenAI.ContainerResource

İsim	Türü	Description	Gerekli
oluşturulma_tarihi	tamsayı	Kapsayıcının oluşturulduğu unix zaman damgası (saniye).	Evet
sona_erdikten_sonra	OpenAI.ContainerResourceExpiresAfter		Hayı
└─ tutturucu	enum	Olası değerler: `last_active_at`	Hayı
└─ dakika	tamsayı		Hayı
kimlik	String	Kapsayıcının benzersiz tanımlayıcısı.	Evet
son etkinlik zamanı	tamsayı	Kapsayıcının en son etkin olduğu unix zaman damgası (saniye).	Hayı
bellek sınırı	enum	Kapsayıcı için yapılandırılan bellek sınırı. Olası değerler: `1g`, `4g`, `16g`, `64g`	Hayı
name	String	Kapsayıcının adı.	Evet
nesne	String	Bu nesnenin türü.	Evet
durum	String	Kapsayıcının durumu (örneğin, etkin, silinmiş).	Evet

OpenAI.ContainerResourceExpiresAfter

İsim	Türü	Description	Gerekli	Varsayılan
anchor	enum	Olası değerler: `last_active_at`	Hayı
minutes	tamsayı		Hayı

OpenAI.ConversationItem

Konuşma içinde tek bir öğe. Olası türler kümesi, output türüyle aynıdır.

OpenAI.ConversationItem için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

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

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.ConversationItemType		Evet

OpenAI.ConversationItemApplyPatchToolCall

Dosya oluşturarak, silerek veya güncelleştirerek dosya farklarını uygulayan bir araç çağrısı.

İsim	Türü	Description	Gerekli
call_id	String	Model tarafından oluşturulan uygulama yama aracı çağrısının benzersiz kimliği.	Evet
Oluşturan	String	Bu araç çağrısını oluşturan varlığın kimliği.	Hayı
kimlik	String	Düzeltme eki uygulama aracı çağrısının benzersiz kimliği. Bu öğe, API aracılığıyla iade edildiğinde doldurulur.	Evet
Operasyon	OpenAI.ApplyPatchFileOperation	apply_patch aracılığıyla uygulanan create_file, delete_file veya update_file işlemlerinden biri.	Evet
└─ türü	OpenAI.ApplyPatchFileOperationType		Evet
durum	OpenAI.ApplyPatchCallStatus		Evet
type	enum	Öğenin türü. Her zaman `apply_patch_call`. Olası değerler: `apply_patch_call`	Evet

OpenAI.ConversationItemApplyPatchToolCallOutput

Bir düzeltme eki uygulama aracı çağrısı tarafından yayılan çıkış.

İsim	Türü	Description	Gerekli
call_id	String	Model tarafından oluşturulan uygulama yama aracı çağrısının benzersiz kimliği.	Evet
Oluşturan	String	Bu aracı oluşturan varlığın kimliği çağrı çıktısı.	Hayı
kimlik	String	Düzeltme eki uygulama aracı çağrı çıkışının benzersiz kimliği. Bu öğe, API aracılığıyla iade edildiğinde doldurulur.	Evet
çıktı	dize veya null		Hayı
durum	OpenAI.ApplyPatchCallOutputStatus		Evet
type	enum	Öğenin türü. Her zaman `apply_patch_call_output`. Olası değerler: `apply_patch_call_output`	Evet

OpenAI.ConversationItemCodeInterpreterToolCall

Kodu çalıştırmak için bir araç çağrısı.

İsim	Türü	Description	Gerekli
kod	dize veya null		Evet
container_id	String	Kodu çalıştırmak için kullanılan kapsayıcının kimliği.	Evet
kimlik	String	Kod yorumlayıcısı araç çağrısının benzersiz kimliği.	Evet
Çıktılar	OpenAI.CodeInterpreterOutputLogs dizisi veya OpenAI.CodeInterpreterOutputImage veya null		Evet
durum	enum	Kod yorumlayıcı aracı çağrısının durumu. Geçerli değerler : `in_progress`, `completed`, `incomplete`, `interpreting`ve `failed`. Olası değerler: `in_progress`, `completed`, `incomplete`, `interpreting`, `failed`	Evet
type	enum	Kod yorumlayıcı aracı çağrısının türü. Her zaman `code_interpreter_call`. Olası değerler: `code_interpreter_call`	Evet

OpenAI.ConversationItemComputerToolCall

Bilgisayar kullanım araçlarına bir araç komutu verme. Daha fazla bilgi için bilgisayar kullanım rehberi adresine bakınız.

İsim	Türü	Description	Gerekli
hareket	OpenAI.ComputerAction		Evet
call_id	String	Çıkış verisi ile araç çağrısına yanıt verirken kullanılan tanımlayıcı.	Evet
kimlik	String	Bilgisayar çağrısının benzersiz tanımlayıcısı.	Evet
pending_safety_checks	OpenAI.ComputerCallSafetyCheckParam dizisi	Bilgisayar çağrısı için bekleyen güvenlik denetimleri.	Evet
durum	enum	Öğenin durumu. `in_progress`, `completed`, veya bunlardan biri `incomplete`. Öğeler API aracılığıyla döndürülürken doldurulur. Olası değerler: `in_progress`, `completed`, `incomplete`	Evet
type	enum	Bilgisayar çağrısının türü. Her zaman `computer_call`. Olası değerler: `computer_call`	Evet

OpenAI.ConversationItemComputerToolCallOutputResource

İsim	Türü	Description	Gerekli
acknowledged_safety_checks	OpenAI.ComputerCallSafetyCheckParam dizisi	API tarafından bildirilen ve kabul edilen güvenlik kontrolleri geliştirici.	Hayı
call_id	String	Çıktı üreten bilgisayar aracı çağrısının kimliği.	Evet
kimlik	String	Bilgisayar aracı çağrısı çıkış kimliği.	Hayı
çıktı	OpenAI.ComputerScreenshotImage	Bilgisayar kullanım aracıyla kullanılan bir bilgisayar ekran görüntüsü.	Evet
durum	enum	İleti girişinin durumu. `in_progress`, `completed`, veya bunlardan biri `incomplete`. API aracılığıyla giriş öğeleri döndürüldüğünde doldurulur. Olası değerler: `in_progress`, `completed`, `incomplete`	Hayı
type	enum	Bilgisayar araçlarının çağrı çıktısının türü. Her zaman `computer_call_output`. Olası değerler: `computer_call_output`	Evet

OpenAI.ConversationItemCustomToolCall

Model tarafından oluşturulan özel bir araca çağrı.

İsim	Türü	Description	Gerekli
call_id	String	Bu özel araç çağrısını bir araç çağrısı çıktısına eşlemek için kullanılan bir tanımlayıcı.	Evet
kimlik	String	OpenAI platformundaki özel araç çağrısının benzersiz kimliği.	Hayı
girdi	String	Model tarafından oluşturulan özel araç çağrısı için girdi.	Evet
name	String	Çağrılan özel aracın adı.	Evet
type	enum	Özel araç çağrısının türü. Her zaman `custom_tool_call`. Olası değerler: `custom_tool_call`	Evet

OpenAI.ConversationItemCustomToolCallOutput

Kodunuzdan özel bir araç çağrısının çıktısı, modele geri gönderiliyor.

İsim	Türü	Description	Gerekli
call_id	String	Çağrı kimliği, bu özel araç çağrısı çıktısını özel bir araç çağrısına eşlemek için kullanılır.	Evet
kimlik	String	OpenAI platformunda çıkan özel araç çağrısının benzersiz kimliği.	Hayı
çıktı	OpenAI.FunctionAndCustomToolCallOutput dizesi veya dizisi	Kodunuz tarafından oluşturulan özel araç çağrısından çıkan çıktı. Bir dize veya çıkış içeriği listesi olabilir.	Evet
type	enum	Özel araç çağrısı çıkışının türü. Her zaman `custom_tool_call_output`. Olası değerler: `custom_tool_call_output`	Evet

OpenAI.ConversationItemFileSearchToolCall

Dosya arama aracı çağrısının sonuçları. Daha fazla bilgi için dosya arama rehberi adresine bakınız.

İsim	Türü	Description	Gerekli
kimlik	String	Dosya arama aracı çağrısının benzersiz kimliği.	Evet
queries	dize dizisi	Dosyaları aramak için kullanılan sorgular.	Evet
results	OpenAI.FileSearchToolCallResults veya null dizisi		Hayı
durum	enum	Dosya arama aracı çağrısının durumu. Bunlardan biri `in_progress` `searching`, `incomplete` veya `failed`, Olası değerler: `in_progress`, `searching`, `completed`, `incomplete`, `failed`	Evet
type	enum	Dosya arama aracı çağrısının türü. Her zaman `file_search_call`. Olası değerler: `file_search_call`	Evet

OpenAI.ConversationItemFunctionShellCall

Yönetilen bir ortamda bir veya daha fazla kabuk komutu yürüten bir araç çağrısı.

İsim	Türü	Description	Gerekli
hareket	OpenAI.FunctionShellAction	Bir kabuk komutu yürütür.	Evet
└─ komutları	dize dizisi		Evet
└─ max_output_length	tamsayı veya null		Evet
└─ timeout_ms	tamsayı veya null		Evet
call_id	String	Model tarafından oluşturulan shell araç çağrısının benzersiz kimliği.	Evet
Oluşturan	String	Bu araç çağrısını oluşturan varlığın kimliği.	Hayı
kimlik	String	Kabuk aracı çağrısının benzersiz kimliği. Bu öğe, API aracılığıyla iade edildiğinde doldurulur.	Evet
durum	OpenAI.LocalShellCallStatus		Evet
type	enum	Öğenin türü. Her zaman `shell_call`. Olası değerler: `shell_call`	Evet

OpenAI.ConversationItemFunctionShellCallOutput

Yayılan bir kabuk aracı çağrısının çıktısı.

İsim	Türü	Description	Gerekli
call_id	String	Model tarafından oluşturulan shell araç çağrısının benzersiz kimliği.	Evet
Oluşturan	String	Öğeyi oluşturan aktörün tanımlayıcısı.	Hayı
kimlik	String	Kabuk çağrısı çıkışının benzersiz kimliği. Bu öğe, API aracılığıyla iade edildiğinde doldurulur.	Evet
max_output_length	tamsayı veya null		Evet
çıktı	OpenAI.FunctionShellCallOutputContent dizisi	Kabuk çağrısı çıkış içeriği dizisi	Evet
type	enum	Kabuk çağrısı çıkışının türü. Her zaman `shell_call_output`. Olası değerler: `shell_call_output`	Evet

OpenAI.ConversationItemFunctionToolCallOutputResource

İsim	Türü	Description	Gerekli
call_id	String	Model tarafından oluşturulan işlev aracı çağrısının benzersiz kimliği.	Evet
kimlik	String	İşlev aracının çağrı çıkışının benzersiz kimliği. Bu öğe doldurulduğunda API aracılığıyla döndürülür.	Hayı
çıktı	OpenAI.FunctionAndCustomToolCallOutput dizesi veya dizisi	Kodunuz tarafından oluşturulan işlev çağrısının çıktısı. Bir dize veya çıkış içeriği listesi olabilir.	Evet
durum	enum	Öğenin durumu. `in_progress`, `completed`, veya bunlardan biri `incomplete`. Öğeler API aracılığıyla döndürülürken doldurulur. Olası değerler: `in_progress`, `completed`, `incomplete`	Hayı
type	enum	İşlev aracının çağrı çıktısının türü. Her zaman `function_call_output`. Olası değerler: `function_call_output`	Evet

OpenAI.ConversationItemFunctionToolCallResource

İsim	Türü	Description	Gerekli
arguments	String	İşleve geçirecek bağımsız değişkenlerin JSON dizesi.	Evet
call_id	String	Model tarafından oluşturulan işlev aracı çağrısının benzersiz kimliği.	Evet
kimlik	String	İşlev aracı çağrısının benzersiz kimliği.	Hayı
name	String	Çalıştırılacak işlevin adı.	Evet
durum	enum	Öğenin durumu. `in_progress`, `completed`, veya bunlardan biri `incomplete`. Öğeler API aracılığıyla döndürülürken doldurulur. Olası değerler: `in_progress`, `completed`, `incomplete`	Hayı
type	enum	İşlev aracı çağrısının türü. Her zaman `function_call`. Olası değerler: `function_call`	Evet

OpenAI.ConversationItemImageGenToolCall

Model tarafından yapılan bir görüntü oluşturma isteği.

İsim	Türü	Description	Gerekli
kimlik	String	Görüntü oluşturma çağrısının benzersiz kimliği.	Evet
sonuç	dize veya null		Evet
durum	enum	Görüntü oluşturma çağrısının durumu. Olası değerler: `in_progress`, `completed`, `generating`, `failed`	Evet
type	enum	Görüntü oluşturma çağrısının türü. Her zaman `image_generation_call`. Olası değerler: `image_generation_call`	Evet

OpenAI.ConversationItemList

Konuşma öğelerinin listesi.

İsim	Türü	Description	Gerekli
veriler	OpenAI.ConversationItem dizisi	Konuşma öğelerinin listesi.	Evet
ilk_kimlik	String	Listedeki ilk öğenin kimliği.	Evet
daha_fazla	Boolean	Kullanılabilir daha fazla öğe olup olmadığı.	Evet
son_kimlik	String	Listedeki son öğenin kimliği.	Evet
nesne	enum	Döndürülen nesnenin türü olmalıdır `list`. Olası değerler: `list`	Evet

OpenAI.ConversationItemLocalShellToolCall

Yerel kabukta komut çalıştırmak için bir araç çağrısı.

İsim	Türü	Description	Gerekli
hareket	OpenAI.LocalShellExecAction	Sunucuda bir komut satırı komutunu çalıştır.	Evet
call_id	String	Model tarafından oluşturulan yerel kabuk aracı çağrısının benzersiz kimliği.	Evet
kimlik	String	Yerel shell çağrısının benzersiz kimliği.	Evet
durum	enum	Yerel shell çağrısının durumu. Olası değerler: `in_progress`, `completed`, `incomplete`	Evet
type	enum	Yerel shell call'ın türü. Her zaman `local_shell_call`. Olası değerler: `local_shell_call`	Evet

OpenAI.ConversationItemLocalShellToolCallOutput

Yerel kabuk aracı çağrısının çıktısı.

İsim	Türü	Description	Gerekli
kimlik	String	Model tarafından oluşturulan yerel kabuk aracı çağrısının benzersiz kimliği.	Evet
çıktı	String	Yerel kabuk aracı çağrısının çıkışına ait bir JSON dizesi.	Evet
durum	dize veya null		Hayı
type	enum	Yerel kabuk aracı çağrı çıkışının türü. Her zaman `local_shell_call_output`. Olası değerler: `local_shell_call_output`	Evet

OpenAI.ConversationItemMcpApprovalRequest

Bir araç çağrısı işlemi için insan onayı isteği.

İsim	Türü	Description	Gerekli
arguments	String	Araç için bir JSON bağımsız değişken dizesi.	Evet
kimlik	String	Onay talebinin benzersiz kimliği.	Evet
name	String	Çalıştırılacak aracın adı.	Evet
sunucu etiketi	String	İsteği yapan MCP sunucusunun etiketi.	Evet
type	enum	Öğenin türü. Her zaman `mcp_approval_request`. Olası değerler: `mcp_approval_request`	Evet

OpenAI.ConversationItemMcpApprovalResponseResource

MCP onay isteğine yanıt.

İsim	Türü	Description	Gerekli
approval_request_id	String	Yanıtlanan onay isteğinin ID'si.	Evet
approve	Boolean	İsteğin onaylanıp onaylanmadı.	Evet
kimlik	String	Onay yanıtının benzersiz kimliği	Evet
sebep	dize veya null		Hayı
type	enum	Öğenin türü. Her zaman `mcp_approval_response`. Olası değerler: `mcp_approval_response`	Evet

OpenAI.ConversationItemMcpListTools

MCP sunucusunda kullanılabilen araçların listesi.

İsim	Türü	Description	Gerekli
hata	dize veya null		Hayı
kimlik	String	Listenin benzersiz kimliği.	Evet
sunucu etiketi	String	MCP sunucusunun etiketi.	Evet
araçlar	OpenAI.MCPListToolsTool dizisi	Sunucuda bulunan araçlar.	Evet
type	enum	Öğenin türü. Her zaman `mcp_list_tools`. Olası değerler: `mcp_list_tools`	Evet

OpenAI.ConversationItemMcpToolCall

MCP sunucusundaki bir aracın çağrılması.

İsim	Türü	Description	Gerekli
approval_request_id	dize veya null		Hayı
arguments	String	Araca geçirilen bağımsız değişkenlerin JSON dizesi.	Evet
hata	dize veya null		Hayı
kimlik	String	Araç çağrısının benzersiz kimliği.	Evet
name	String	Çalıştırılan aracın adı.	Evet
çıktı	dize veya null		Hayı
sunucu etiketi	String	Aracı çalıştıran MCP sunucusunun etiketi.	Evet
durum	OpenAI.MCPToolCallStatus		Hayı
type	enum	Öğenin türü. Her zaman `mcp_call`. Olası değerler: `mcp_call`	Evet

OpenAI.ConversationItemMessage

Modele veya modelden gelen bir ileti.

İsim	Türü	Description	Gerekli
içerik	OpenAI.InputTextContent veya OpenAI.OutputTextContent veya OpenAI.TextContent ya da OpenAI.SummaryTextContent veya OpenAI.ReasoningTextContent ya da OpenAI.RefusalContent veya OpenAI.InputImageContent ya da OpenAI.ComputerScreenshotContent veya OpenAI.InputFileContent dizisi	İletinin içeriği	Evet
kimlik	String	İletinin benzersiz kimliği.	Evet
role	OpenAI.MessageRole		Evet
durum	OpenAI.MessageStatus		Evet
type	enum	İletinin türü. Her zaman `message`olarak ayarlayın. Olası değerler: `message`	Evet

OpenAI.ConversationItemReasoningItem

Bir yanıt oluştururken bir akıl yürütme modeli tarafından kullanılan düşünce zincirinin açıklaması. Eğer konuşmanın sonraki turlarında bu öğeleri input ile manuel olarak konuşuyorsanız, Responses API'ye hesabınıza dahil edin.

İsim	Türü	Description	Gerekli
içerik	OpenAI.ReasoningTextContent dizisi	Metin içeriğini akıl yürütme.	Hayı
encrypted_content	dize veya null		Hayı
kimlik	String	Akıl yürütme içeriğinin benzersiz tanımlayıcısı.	Evet
durum	enum	Öğenin durumu. `in_progress`, `completed`, veya bunlardan biri `incomplete`. Öğeler API aracılığıyla döndürülürken doldurulur. Olası değerler: `in_progress`, `completed`, `incomplete`	Hayı
summary	OpenAI.Summary dizisi	Akıl yürütme özeti içeriği.	Evet
type	enum	Nesnenin türü. Her zaman `reasoning`. Olası değerler: `reasoning`	Evet

OpenAI.ConversationItemType

Mülkiyet Değer

Türü String

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

OpenAI.ConversationItemWebSearchToolCall

Bir web arama aracı çağrısının sonuçları. Daha fazla bilgi için web arama rehberi adresine bakınız.

İsim	Türü	Description	Gerekli
hareket	OpenAI.WebSearchActionSearch veya OpenAI.WebSearchActionOpenPage veya OpenAI.WebSearchActionFind	Bu web arama çağrısında gerçekleştirilen belirli eylemi açıklayan bir nesne. Modelin web'i nasıl kullandığına ilişkin ayrıntıları içerir (arama, open_page, bulma).	Evet
kimlik	String	Web arama aracının benzersiz kimliği çağrı.	Evet
durum	enum	Web arama aracı çağrısının durumu. Olası değerler: `in_progress`, `searching`, `completed`, `failed`	Evet
type	enum	Web arama aracının türü. Her zaman `web_search_call`. Olası değerler: `web_search_call`	Evet

OpenAI.ConversationParam

Bu yanıtın ait olduğu konuşma. Bu konuşmadaki öğeler, bu yanıt isteği için öğesine input_items eklenir. Bu yanıt tamamlandıktan sonra bu yanıttaki giriş öğeleri ve çıkış öğeleri otomatik olarak bu konuşmaya eklenir.

Tür: dize veya OpenAI.ConversationParam-2

OpenAI.ConversationParam-2

Bu yanıtın ait olduğu konuşma.

İsim	Türü	Description	Gerekli	Varsayılan
kimlik	String	Konuşmanın benzersiz kimliği.	Evet

OpenAI.ConversationReference

Bu yanıtın ait olduğu konuşma. Bu yanıttaki giriş öğeleri ve çıkış öğeleri bu konuşmaya otomatik olarak eklendi.

İsim	Türü	Description	Gerekli	Varsayılan
kimlik	String	Bu yanıtın ilişkilendirildiği konuşmanın benzersiz kimliği.	Evet

OpenAI.ConversationResource

İsim	Türü	Description	Gerekli
oluşturulma_tarihi	tamsayı	Unix döneminin ardından saniye cinsinden ölçülen konuşmanın oluşturulduğu zaman.	Evet
kimlik	String	Konuşmanın benzersiz kimliği.	Evet
metadata		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.	Evet
nesne	enum	Her zaman `conversation`olan nesne türü. Olası değerler: `conversation`	Evet

OpenAI.CreateChatCompletionRequestAudio

İsim	Türü	Description	Gerekli	Varsayılan
format	enum	Olası değerler: `wav`, `aac`, `mp3`, `flac`, , `opus`, `pcm16`	Evet
voice	OpenAI.VoiceIdsShared		Evet

OpenAI.CreateChatCompletionRequestResponseFormat

Modelin çıkış yapması gereken biçimi belirten bir nesne. ayarı, { "type": "json_schema", "json_schema": {...} } modelin sağlanan JSON şemanızla eşleşmesini sağlayan Yapılandırılmış Çıkışlar'ı etkinleştirir. Structured Outputs rehberi için daha fazla bilgi edinebilirsiniz. ayarı { "type": "json_object" } , modelin oluşturduğu iletinin geçerli JSON olduğundan emin olan eski JSON modunu etkinleştirir. Destekleyen modeller için json_schema kullanılması tercih edilir.

OpenAI.CreateChatCompletionRequestResponseFormat için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
`json_schema`	OpenAI.ResponseFormatJsonSchema
`text`	OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText
`json_object`	OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.CreateChatCompletionRequestResponseFormatType		Evet

OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject

JSON nesne yanıt biçimi. JSON yanıtları oluşturmanın eski bir yöntemi. Bunu destekleyen modeller için kullanılması json_schema önerilir. Modelin bir sistem veya kullanıcı 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.CreateChatCompletionRequestResponseFormatResponseFormatText

Varsayılan yanıt biçimi. Metin yanıtları oluşturmak için kullanılır.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Tanımlanan yanıt biçiminin türü. Her zaman `text`. Olası değerler: `text`	Evet

OpenAI.CreateChatCompletionRequestResponseFormatType

Mülkiyet	Değer
Türü	String
Değerler	`text` `json_schema` `json_object`

OpenAI.CreateChatCompletionResponseChoices

İsim	Türü	Description	Gerekli
content_filter_results	AzureContentFilterResultForChoice	Üretken bir yapay zeka sistemi tarafından üretilen tek bir yanıt öğesi için içerik filtresi sonucu.	Hayı
bitiş_nedeni	enum	Olası değerler: `stop`, `length`, `tool_calls`, `content_filter`, `function_call`	Evet
indeks	tamsayı		Evet
logprobs	OpenAI.CreateChatCompletionResponseChoicesLogprobs veya null		Evet
mesaj	OpenAI.ChatCompletionResponseMessage	Ses çıkış modu istenirse, bu nesne veri içerir Modelden gelen ses tepkisi hakkında.	Evet

OpenAI.CreateChatCompletionResponseChoicesLogprobs

İsim	Türü	Description	Gerekli	Varsayılan
içerik	OpenAI.ChatCompletionTokenLogprob dizisi veya null		Evet
Ret	OpenAI.ChatCompletionTokenLogprob dizisi veya null		Evet

OpenAI.CreateChatCompletionStreamResponseChoices

İsim	Türü	Description	Gerekli
delta	OpenAI.ChatCompletionStreamResponseDelta	Akışlı model yanıtları tarafından oluşturulan bir sohbet tamamlama deltası.	Evet
bitiş_nedeni	dize veya null		Evet
indeks	tamsayı		Evet
logprobs	OpenAI.CreateChatCompletionStreamResponseChoicesLogprobs veya null		Hayı

OpenAI.CreateChatCompletionStreamResponseChoicesLogprobs

İsim	Türü	Description	Gerekli	Varsayılan
içerik	OpenAI.ChatCompletionTokenLogprob dizisi veya null		Evet
Ret	OpenAI.ChatCompletionTokenLogprob dizisi veya null		Evet

OpenAI.CreateCompletionResponseChoices

İsim	Türü	Description	Gerekli
content_filter_results	AzureContentFilterResultForChoice	Üretken bir yapay zeka sistemi tarafından üretilen tek bir yanıt öğesi için içerik filtresi sonucu.	Hayı
bitiş_nedeni	enum	Olası değerler: `stop`, `length`, `content_filter`	Evet
indeks	tamsayı		Evet
logprobs	OpenAI.CreateCompletionResponseChoicesLogprobs veya null		Evet
text	String		Evet

OpenAI.CreateCompletionResponseChoicesLogprobs

İsim	Türü	Gerekli
text_offset	tamsayı dizisi	Hayı
token_logprobs	sayı dizisi	Hayı
tokens	dize dizisi	Hayı
top_logprobs	nesne dizisi	Hayı

OpenAI.CreateContainerBody

İsim	Türü	Description	Gerekli
sona_erdikten_sonra	OpenAI.CreateContainerBodyExpiresAfter		Hayı
└─ tutturucu	enum	Olası değerler: `last_active_at`	Evet
└─ dakika	tamsayı		Evet
dosya_kimlikleri	dize dizisi	Kapsayıcıya kopyalanacak dosyaların kimlikleri.	Hayı
bellek sınırı	enum	Kapsayıcı için isteğe bağlı bellek sınırı. Varsayılan olarak "1g" olur. Olası değerler: `1g`, `4g`, `16g`, `64g`	Hayı
name	String	Oluşturulacak kapsayıcının adı.	Evet

OpenAI.CreateContainerBodyExpiresAfter

İsim	Türü	Description	Gerekli	Varsayılan
anchor	enum	Olası değerler: `last_active_at`	Evet
minutes	tamsayı		Evet

OpenAI.CreateContainerFileBody

İsim	Türü	Description	Gerekli	Varsayılan
dosya		Karşıya yüklenecek Dosya nesnesi (dosya adı değil).	Hayı
dosya_kimlik	String	Oluşturulacak dosyanın adı.	Hayı

OpenAI.CreateConversationBody

İsim	Türü	Description	Gerekli	Varsayılan
items	OpenAI.InputItem dizisi veya null		Hayı
metadata	OpenAI.Metadata veya null		Hayı

OpenAI.CreateConversationItemsParametersBody

İsim	Türü	Description	Gerekli	Varsayılan
items	OpenAI.InputItem dizisi		Evet

OpenAI.CreateEmbeddingRequest

İsim	Türü	Description	Gerekli
dimensions	tamsayı	Sonuçta elde edilen çıktı eklemelerinin sahip olması gereken boyut sayısı. Yalnızca ve sonraki modellerde `text-embedding-3` desteklenir. Kısıtlamalar: dk: 1	Hayı
encoding_format	enum	Eklemelerin döndürüleceği biçim. veya `float`olabilir`base64`. Olası değerler: `float`, `base64`	Hayı
girdi	dize veya dize dizisi ya da tamsayı dizisi ya da dizi dizisi	Eklemek için metin girin, dize veya belirteç dizisi olarak kodlanmış. Tek bir isteğe birden çok giriş eklemek için bir dizi dize veya belirteç dizisi geçirin. Giriş, model için maksimum giriş belirteçlerini aşmamalıdır (tüm ekleme modelleri için 8.192 belirteç), boş bir dize olamaz ve herhangi bir dizi 2.048 boyut veya daha az olmalıdır. Belirteçleri saymak için örnek Python kodu. Giriş başına belirteç sınırına ek olarak, tüm ekleme modelleri tek bir istekteki tüm girişlerde toplanmış en fazla 300.000 belirteç gerektirir.	Evet
model	String	Kullanılacak modelin kimliği. Kullanılabilir modellerinizin tümünü görmek için Model listesi API'sini kullanabilir veya bunların açıklamaları için Modele genel bakış bilgilerimize bakabilirsiniz.	Evet
user	String	Daha fazla bilgi edinin.	Hayı

OpenAI.CreateEmbeddingResponse

İsim	Türü	Description	Gerekli
veriler	OpenAI.Embedding dizisi	Model tarafından oluşturulan eklemelerin listesi.	Evet
model	String	Eklemeyi oluşturmak için kullanılan modelin adı.	Evet
nesne	enum	Her zaman "liste" olan nesne türü. Olası değerler: `list`	Evet
usage	OpenAI.CreateEmbeddingResponseUsage		Evet
└─ istem_belirteçleri	tamsayı		Evet
└─ toplam_jetonlar	tamsayı		Evet

OpenAI.CreateEmbeddingResponseUsage

İsim	Türü	Description	Gerekli	Varsayılan
prompt_tokens	tamsayı		Evet
total_tokens	tamsayı		Evet

OpenAI.CreateEvalCompletionsRunDataSource

Model örnekleme yapılandırmasını açıklayan CompletionsRunDataSource nesnesi.

İsim	Türü	Description	Gerekli
input_mesajları	OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesTemplate veya OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference	Modelden örnekleme yaparken kullanılır. Modele geçirilen iletilerin yapısını dikte eder. Önceden oluşturulmuş bir yörüngeye (örn `item.input_trajectory`. ) başvuru veya ad alanına değişken başvuruları `item` içeren bir şablon olabilir.	Hayı
model	String	Tamamlanmaları oluşturmak için kullanılacak modelin adı ("o3-mini" gibi).	Hayı
Örnekleme_Parametreleri	AzureCompletionsSamplingParams	Tamamlamaların davranışını denetlemek için örnekleme parametreleri.	Hayı
kaynak	OpenAI.EvalJsonlFileContentSource veya OpenAI.EvalJsonlFileIdSource veya OpenAI.EvalStoredCompletionsSource	Bu çalıştırmanın veri kaynağındaki ad alanını `item` neyin dolduracaklarını belirler.	Evet
type	enum	Çalıştırma veri kaynağının türü. Her zaman `completions`. Olası değerler: `completions`	Evet

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference

İsim	Türü	Description	Gerekli	Varsayılan
item_reference	String		Evet
type	enum	Olası değerler: `item_reference`	Evet

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesTemplate

İsim	Türü	Description	Gerekli	Varsayılan
şablon	OpenAI.EasyInputMessage veya OpenAI.EvalItem dizisi		Evet
type	enum	Olası değerler: `template`	Evet

OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams

İsim	Türü	Description	Gerekli	Varsayılan
max_completion_tokens	tamsayı		Hayı
akıl yürütme çabası	OpenAI.ReasoningEffort	Akıl yürütmeye yönelik çabayı kısıtlar mantık modelleri. Şu anda desteklenen değerler `none`, `minimal`, `low`, `medium`, `high`, ve `xhigh`'dir. Azaltma muhakeme çabası daha hızlı yanıtlara ve daha az belirteç kullanılmasına neden olabilir bir yanıtta mantık yürütme. - `gpt-5.1` varsayılan olarak `none`öğesini kullanır ve mantık yürütmez. Desteklenen gerekçe değerleri `gpt-5.1none`, `low`, `medium`, ve `high`'dir. Araç çağrıları gpt-5.1'deki tüm akıl yürütme değerleri için desteklenir. - Tüm modeller varsayılan olarak akıl yürütme eforu olmadan `gpt-5.1` önce `medium` ve desteklemez`none`. - Model `gpt-5-pro` varsayılan olarak akıl yürütme eforunu kullanır (ve yalnızca destekler `high` ). - `xhigh` , sonrasındaki `gpt-5.1-codex-max`tüm modeller için desteklenir.	Hayı
yanıt formatı	OpenAI.ResponseFormatText veya OpenAI.ResponseFormatJsonSchema veya OpenAI.ResponseFormatJsonObject		Hayı
seed	tamsayı	Bir tohum değeri örnekleme sırasında rastgeleliği başlatır.	Hayı	42
sıcaklık	Numara	Daha yüksek bir sıcaklık çıkışlardaki rastgeleliği artırır.	Hayı	1
araçlar	OpenAI.ChatCompletionTool dizisi		Hayı
top_p	Numara	Çekirdek örneklemesi için sıcaklığa bir alternatif; 1.0 tüm belirteçleri içerir.	Hayı	1

OpenAI.CreateEvalCustomDataSourceConfig

Değerlendirme çalıştırmaları için kullanılan veri kaynağının şemasını tanımlayan customDataSourceConfig nesnesi. Bu şema, aşağıdaki verilerin şeklini tanımlamak için kullanılır:

Test ölçütlerinizi tanımlamak için kullanılır ve
Çalıştırma oluştururken hangi veriler gereklidir?

İsim	Türü	Description	Gerekli
ö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.CreateEvalItem

İstemi veya bağlamı oluşturan bir sohbet iletisi. {{item.name}} gibi ad alanına değişken başvuruları item içerebilir.

İsim	Türü	Description	Gerekli	Varsayılan
içerik	String	İletinin içeriği.	Evet
role	String	İletinin rolü (örneğin, "system", "assistant", "user").	Evet

OpenAI.CreateEvalJsonlRunDataSource

Değerlendirmeyle eşleşen JSONL dosyasını belirten bir JsonlRunDataSource nesnesi

İsim	Türü	Description	Gerekli	Varsayılan
kaynak	OpenAI.EvalJsonlFileContentSource veya OpenAI.EvalJsonlFileIdSource	Veri kaynağındaki ad alanını `item` neyin doldurdığını belirler.	Evet
type	enum	Veri kaynağının türü. Her zaman `jsonl`. Olası değerler: `jsonl`	Evet

OpenAI.CreateEvalLabelModelGrader

Değerlendirmedeki her öğeye etiket atamak için model kullanan bir LabelModelGrader nesnesi.

İsim	Türü	Description	Gerekli
girdi	OpenAI.CreateEvalItem dizisi	İstemi veya bağlamı oluşturan sohbet iletilerinin listesi. {{item.name}} gibi ad alanına değişken başvuruları `item` içerebilir.	Evet
labels	dize dizisi	Değerlendirmedeki her bir öğeyi sınıflandırmak için etiketler.	Evet
model	String	Değerlendirme için kullanılacak model. Yapılandırılmış çıktıları destekleme zorunluluğu vardır.	Evet
name	String	Değerlendiricinin adı.	Evet
geçen etiketler	dize dizisi	Geçen sonucu belirten etiketler. Etiketlerin bir alt kümesi olmalıdır.	Evet
type	enum	Her zaman `label_model`olan nesne türü. Olası değerler: `label_model`	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
input_mesajları	OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate veya OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference	Modelden örnekleme yaparken kullanılır. Modele geçirilen iletilerin yapısını dikte eder. Önceden oluşturulmuş bir yörüngeye (örn `item.input_trajectory`. ) başvuru veya ad alanına değişken başvuruları `item` içeren bir şablon olabilir.	Hayı
model	String	Tamamlanmaları oluşturmak için kullanılacak modelin adı ("o3-mini" gibi).	Hayı
Örnekleme_Parametreleri	AzureResponsesSamplingParams	Yanıtların davranışını denetlemek için örnekleme parametreleri.	Hayı
kaynak	OpenAI.EvalJsonlFileContentSource veya OpenAI.EvalJsonlFileIdSource veya OpenAI.EvalResponsesSource	Bu çalıştırmanın veri kaynağındaki ad alanını `item` neyin dolduracaklarını belirler.	Evet
type	enum	Çalıştırma veri kaynağının türü. Her zaman `responses`. Olası değerler: `responses`	Evet

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference

İsim	Türü	Description	Gerekli	Varsayılan
item_reference	String		Evet
type	enum	Olası değerler: `item_reference`	Evet

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate

İsim	Türü	Description	Gerekli	Varsayılan
şablon	object dizisi veya OpenAI.EvalItem		Evet
type	enum	Olası değerler: `template`	Evet

OpenAI.CreateEvalResponsesRunDataSourceSamplingParams

İsim	Türü	Description	Gerekli	Varsayılan
akıl yürütme çabası	OpenAI.ReasoningEffort	Akıl yürütmeye yönelik çabayı kısıtlar mantık modelleri. Şu anda desteklenen değerler `none`, `minimal`, `low`, `medium`, `high`, ve `xhigh`'dir. Azaltma muhakeme çabası daha hızlı yanıtlara ve daha az belirteç kullanılmasına neden olabilir bir yanıtta mantık yürütme. - `gpt-5.1` varsayılan olarak `none`öğesini kullanır ve mantık yürütmez. Desteklenen gerekçe değerleri `gpt-5.1none`, `low`, `medium`, ve `high`'dir. Araç çağrıları gpt-5.1'deki tüm akıl yürütme değerleri için desteklenir. - Tüm modeller varsayılan olarak akıl yürütme eforu olmadan `gpt-5.1` önce `medium` ve desteklemez`none`. - Model `gpt-5-pro` varsayılan olarak akıl yürütme eforunu kullanır (ve yalnızca destekler `high` ). - `xhigh` , sonrasındaki `gpt-5.1-codex-max`tüm modeller için desteklenir.	Hayı
seed	tamsayı	Bir tohum değeri örnekleme sırasında rastgeleliği başlatır.	Hayı	42
sıcaklık	Numara	Daha yüksek bir sıcaklık çıkışlardaki rastgeleliği artırır.	Hayı	1
text	OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText		Hayı
araçlar	OpenAI.Tool dizisi		Hayı
top_p	Numara	Çekirdek örneklemesi için sıcaklığa bir alternatif; 1.0 tüm belirteçleri içerir.	Hayı	1

OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText

İsim	Türü	Description	Gerekli	Varsayılan
format	OpenAI.TextResponseFormatConfiguration	Modelin çıkış yapması gereken biçimi belirten bir nesne. Yapılandırma `{ "type": "json_schema" }` , Yapılandırılmış Çıkışları etkinleştirir, modelin sağlanan JSON şemanızla eşleşmesini sağlar. Daha fazla bilgi için Varsayılan biçim `{ "type": "text" }` ek seçenek yoktur. gpt-4o ve daha yeni modeller için önerilmez:* `{ "type": "json_object" }` ayarı, eski JSON modunu etkinleştirir. modelin oluşturduğu iletinin geçerli JSON olduğundan emin olur. `json_schema`’ı kullanma Bu özelliği destekleyen modeller için tercih edilir.	Hayı

OpenAI.CreateEvalRunRequest

İsim	Türü	Description	Gerekli
veri_kaynağı	OpenAI.CreateEvalJsonlRunDataSource veya OpenAI.CreateEvalCompletionsRunDataSource veya OpenAI.CreateEvalResponsesRunDataSource	Çalıştırmanın veri kaynağıyla ilgili ayrıntılar.	Evet
metadata	OpenAI.Metadata veya null		Hayı
name	String	Koşunun adı.	Hayı

OpenAI.CreateEvalStoredCompletionsDataSourceConfig

LogsDataSourceConfig lehine kullanım dışı ilan edildi.

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

İsim	Türü	Description	Gerekli
sona_erdikten_sonra	nesne		Evet
└─ tutturucu	AzureFileExpiryAnchor		Evet
└─ saniye	tamsayı		Evet
dosya		Karşıya yüklenecek Dosya nesnesi (dosya adı değil).	Evet
purpose	enum	Yüklenen dosyanın amaçlanan amacı. Bunlardan biri: - `assistants`: Yardımcılar API'sinde kullanılır - `batch`: Batch API'sinde kullanılır - `fine-tune`: hassas ayarlama için kullanılır - `evals`: Değerlendirme veri kümeleri için kullanılır Olası değerler: `assistants`, `batch`, `fine-tune`, `evals`	Evet

OpenAI.CreateFineTuningCheckpointPermissionRequest

İsim	Türü	Description	Gerekli	Varsayılan
project_ids	dize dizisi	Erişim vermek için proje tanımlayıcıları.	Evet

OpenAI.CreateFineTuningJobRequest

Geçerli modeller:

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

İsim	Türü	Description	Gerekli	Varsayılan
hiper parametreler	OpenAI.CreateFineTuningJobRequestHyperparameters		Hayı
└─ yığın boyutu	dize veya tamsayı		Hayı	otomatik
└─ öğrenme oranı çarpanı	dize veya sayı		Hayı
└─ n_epochs	dize veya tamsayı		Hayı	otomatik
Entegrasyonlar	OpenAI.CreateFineTuningJobRequestIntegrations dizisi veya null	İnce ayar işiniz için etkinleştirmek üzere entegrasyonların listesi.	Hayı
metadata	OpenAI.Metadata veya null		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 yapılacak modelin adı. Aşağıdakilerden birini seçebilirsiniz: destekli modeller.	Evet
seed	tamsayı veya null	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	dize veya null	İ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ı
eğitim_dosyası	String	Eğitim verilerini içeren karşıya yüklenen bir dosyanın kimliği. Karşıya dosya yükleme hakkında bilgi için bkz. dosyayı karşıya yükleme. Veri kümeniz JSONL dosyası olarak biçimlendirilmelidir. Ayrıca, dosyanızı amacı `fine-tune`ile karşıya yüklemeniz gerekir. Dosyanın içeriği, modelin sohbet, tamamlanma biçimi veya ince ayar yönteminin tercih biçimini kullanıp kullanmama durumuna bağlı olarak farklılık göstermelidir. Daha fazla detay için ince ayar rehberi sayfasına bakınız.	Evet
doğrulama_dosyası	dize veya null	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, ... içinde görüntülenebilir. Ince ayar sonucu dosyası. Aynı veriler hem eğitme hem de doğrulama dosyalarında bulunmamalıdır. Veri kümeniz JSONL dosyası olarak biçimlendirilmelidir. Dosyanızı amacı `fine-tune`ile karşıya yüklemeniz gerekir. Daha fazla detay için ince ayar rehberi sayfasına bakınız.	Hayı

OpenAI.CreateFineTuningJobRequestHyperparameters

İsim	Türü	Gerekli
küme_boyutu	dize veya tamsayı	Hayı
öğrenme oranı çarpanı	dize veya sayı	Hayı
n_devir	dize veya tamsayı	Hayı

OpenAI.CreateFineTuningJobRequestIntegrations

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olası değerler: `wandb`	Evet
wandb	OpenAI.CreateFineTuningJobRequestIntegrationsWandb		Evet

OpenAI.CreateFineTuningJobRequestIntegrationsWandb

İsim	Türü	Gerekli
varlık	dize veya null	Hayı
name	dize veya null	Hayı
project	String	Evet
tags	dize dizisi	Hayı

OpenAI.CreateMessageRequest

İsim	Türü	Description	Gerekli
attachments	OpenAI.CreateMessageRequestAttachments dizisi veya null		Hayı
içerik	OpenAI.MessageContentImageFileObject veya OpenAI.MessageContentImageUrlObject veya OpenAI.MessageRequestContentTextObject dizesi veya dizisi		Evet
metadata	OpenAI.Metadata veya null		Hayı
role	enum	İletiyi oluşturan varlığın rolü. İzin verilen değerler şunlardır: - `user`: İletinin 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`: İletinin yardımcı tarafından oluşturulduğunu gösterir. Yardımcıdan konuşmaya ileti eklemek için bu değeri kullanın. Olası değerler: `user`, `assistant`	Evet

OpenAI.CreateMessageRequestAttachments

İsim	Türü	Description	Gerekli	Varsayılan
dosya_kimlik	String		Hayı
araçlar	OpenAI.AssistantToolsCode veya OpenAI.AssistantToolsFileSearchTypeOnly dizisi		Hayı

OpenAI.CreateResponse

İsim	Türü	Description	Gerekli
arka plan	boole veya null		Hayı
konuşma	OpenAI.ConversationParam veya null		Hayı
include	OpenAI.IncludeEnum veya null dizisi		Hayı
girdi	OpenAI.InputParam	Yanıt oluşturmak için kullanılan modele metin, görüntü veya dosya girişleri. Daha fazla bilgi edinin: - Metin girişleri ve çıktıları - Görüntü girişleri - Dosya girişleri - Konuşma durumu - fonksiyon çağırıyor	Hayı
instructions	dize veya null		Hayı
max_output_tokens	tamsayı veya null		Hayı
max_tool_calls	tamsayı veya null		Hayı
metadata	OpenAI.Metadata veya null		Hayı
model	String	veya `gpt-4o`gibi `o3` yanıtı oluşturmak için kullanılan model kimliği. OpenAI farklı özelliklere, performansa sahip çok çeşitli modeller sunar özellikleri ve fiyat noktaları. Model kılavuzuna bakın seçeneğine gidin ve kullanılabilir modelleri karşılaştırın.	Hayı
paralel araç çağrıları	boole veya null		Hayı
previous_response_id	dize veya null		Hayı
prompt	OpenAI.Prompt	bir istem şablonuna ve değişkenlerine başvuru. Daha fazla bilgi edinin.	Hayı
prompt_cache_key	String	OpenAI tarafından önbellek isabet hızlarınızı iyileştirmek amacıyla benzer isteklere yönelik yanıtları önbelleğe almak için kullanılır. `user` alanını değiştirir. Daha fazla bilgi edinin.	Hayı
prompt_cache_retention	dize veya null		Hayı
reasoning	OpenAI.Reasoning veya null		Hayı
safety_identifier	String	OpenAI'nin kullanım ilkelerini ihlal eden uygulamanızın kullanıcılarını algılamaya yardımcı olmak için kullanılan kararlı tanımlayıcı. Kimlikler, her kullanıcıyı benzersiz olarak tanımlayan bir dize olmalıdır. Bize herhangi bir tanımlayıcı bilgi göndermemek için kullanıcı adını veya e-posta adresini karma olarak kullanmanızı öneririz. Daha fazla bilgi edinin.	Hayı
store	boole veya null		Hayı
veri akışı	boole veya null		Hayı
stream_options	OpenAI.ResponseStreamOptions veya null		Hayı
sıcaklık	sayı veya null		Hayı
text	OpenAI.ResponseTextParam	Modelden metin yanıtı için yapılandırma seçenekleri. Düz olabilir metin veya yapılandırılmış JSON verileri. Daha fazla bilgi edinin: - Metin girişleri ve çıktıları - Yapılandırılmış Çıktılar	Hayı
tool_choice	OpenAI.ToolChoiceParam	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	OpenAI.ToolsArray	Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Siz parametresini ayarlayarak `tool_choice` hangi aracın kullanılacağını belirtebilir. Aşağıdaki araç kategorilerini destekliyoruz: - Yerleşik araçlar: OpenAI tarafından sağlanan ve işlevselliği genişleten araçlar modelin yetenekleri, örneğin web arama veya file search. Hakkında daha fazla bilgi edinin yerleşik araçlar. - MCP Araçları: Özel MCP sunucuları aracılığıyla üçüncü taraf sistemlerle tümleştirmeler veya Google Drive ve SharePoint gibi önceden tanımlanmış bağlayıcılar. Hakkında daha fazla bilgi edinin MCP Araçları. - İşlev çağrıları (özel araçlar): Sizin tanımladığınız işlevler, modelin kesin olarak yazılan bağımsız değişkenlerle kendi kodunuzu çağırmasını sağlama ve çıkışlarını seçin. Hakkında daha fazla bilgi edinin fonksiyon çağrısı. Ayrıca şunları da kullanabilirsiniz: kendi kodunuzu çağırmak için özel araçlar.	Hayı
top_logprobs	tamsayı veya null		Hayı
top_p	sayı veya null		Hayı
truncation	dize veya null		Hayı
user	dize (kullanım dışı)	Bu alan ve `safety_identifier`ile `prompt_cache_key` değiştiriliyor. Bunun yerine önbelleğe alma iyileştirmelerini korumak için kullanın `prompt_cache_key` . Son kullanıcılarınız için kararlı bir tanımlayıcı. Benzer istekleri daha iyi demetleyerek önbellek isabet oranlarını artırmak ve OpenAI'nin kötüye kullanımı algılayıp önlemesine yardımcı olmak için kullanılır. Daha fazla bilgi edinin.	Hayı

OpenAI.CreateRunRequest

İsim	Türü	Description	Gerekli
additional_instructions	dize veya null	Çalıştırma yönergelerinin sonuna ek yönergeler ekler. Bu, diğer yönergeleri geçersiz kılmadan çalıştırma başına davranışı değiştirmek için kullanışlıdır.	Hayı
additional_messages	OpenAI.CreateMessageRequest veya null dizisi	Çalıştırmayı oluşturmadan önce iş parçacığına ek iletiler ekler.	Hayı
assistant_id	String	Bu çalıştırmayı yürütmek için kullanılacak yardımcının kimliği.	Evet
instructions	dize veya null	Yardımcının yönergelerini geçersiz kılar. Bu, çalışma başına davranışı değiştirmek için kullanışlıdır.	Hayı
max_completion_tokens	tamsayı veya null	Çalıştırma boyunca kullanılabilecek en fazla tamamlanma belirteci sayısı. Çalıştırma, çalıştırmanın birden çok dönüşünde yalnızca belirtilen tamamlanma belirteçlerinin sayısını kullanmak için en iyi çabayı gösterir. Çalıştırma belirtilen tamamlanma belirteçlerinin sayısını aşarsa, çalıştırma durumu `incomplete`ile sona erer. Daha fazla bilgi için bkz. `incomplete_details`.	Hayı
max_prompt_tokens	tamsayı veya null	Çalıştırma boyunca kullanılabilecek en fazla istem belirteci sayısı. Çalıştırma, çalıştırmanın birden çok dönüşünde yalnızca belirtilen istem belirteci sayısını kullanmak için en iyi çabayı gösterir. Çalıştırma belirtilen istem belirteci sayısını aşarsa, çalıştırma durumu `incomplete`ile sona erer. Daha fazla bilgi için bkz. `incomplete_details`.	Hayı
metadata	OpenAI.Metadata veya null		Hayı
model	String	Bu çalıştırmayı yürütmek için kullanılacak Modelin kimliği. Burada bir değer sağlanırsa, yardımcıyla ilişkili modeli geçersiz kılar. Aksi takdirde, yardımcıyla ilişkili model kullanılır.	Hayı
paralel araç çağrıları	OpenAI.ParallelToolCalls	Araç kullanımı sırasında paralel işlev çağrısının etkinleştirilip etkinleştirilmeyileceği.	Hayı
akıl yürütme çabası	OpenAI.ReasoningEffort	Akıl yürütmeye yönelik çabayı kısıtlar mantık modelleri. Şu anda desteklenen değerler `none`, `minimal`, `low`, `medium`, `high`, ve `xhigh`'dir. Azaltma muhakeme çabası daha hızlı yanıtlara ve daha az belirteç kullanılmasına neden olabilir bir yanıtta mantık yürütme. - `gpt-5.1` varsayılan olarak `none`öğesini kullanır ve mantık yürütmez. Desteklenen gerekçe değerleri `gpt-5.1none`, `low`, `medium`, ve `high`'dir. Araç çağrıları gpt-5.1'deki tüm akıl yürütme değerleri için desteklenir. - Tüm modeller varsayılan olarak akıl yürütme eforu olmadan `gpt-5.1` önce `medium` ve desteklemez`none`. - Model `gpt-5-pro` varsayılan olarak akıl yürütme eforunu kullanır (ve yalnızca destekler `high` ). - `xhigh` , sonrasındaki `gpt-5.1-codex-max`tüm modeller için desteklenir.	Hayı
yanıt formatı	OpenAI.AssistantsApiResponseFormatOption	Modelin çıkış yapması gereken biçimi belirtir. GPT-4o, GPT-4 Turbo ve tüm `gpt-3.5-turbo-1106`GPT-3.5 Turbo modelleri ile uyumludur. ayarı, `{ "type": "json_schema", "json_schema": {...} }` modelin sağlanan JSON şemanızla eşleşmesini sağlayan Yapılandırılmış Çıkışlar'ı etkinleştirir. Daha fazla bilgi için ayarı `{ "type": "json_object" }` , modelin oluşturduğu iletinin geçerli bir JSON olduğundan emin olan JSON modunu etkinleştirir. Önemli:* JSON modunu kullanırken, modele bir sistem veya kullanıcı iletisi aracılığıyla kendiniz JSON üretmesini de belirtmeniz gerekir . Bu olmadan model, nesil belirteç sınırına ulaşana kadar bitmeyen bir boşluk akışı oluşturabilir ve bu da uzun süre çalışan ve görünüşe göre "takılmış" bir istekle sonuçlanır. Ayrıca, neslin aşıldığını veya konuşmanın maksimum bağlam uzunluğunu aştığını `finish_reason="length"` gösteren ileti `max_tokens`içeriğinin kısmen kesilebileceğini unutmayın.	Hayı
veri akışı	boole veya null	ise `true`, Sunucu tarafından gönderilen farklı çalıştır olayları sırasında gerçekleşen olayların akışını döndürür ve Çalıştır bir iletiyle `data: [DONE]` bir terminal durumuna girdiğinde sonlandırılır.	Hayı
sıcaklık	sayı veya null	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.	Hayı
tool_choice	OpenAI.AssistantsApiToolChoiceOption	Model tarafından çağrılan aracı (varsa) denetler. `none` modelin herhangi bir araç çağırmayacağı ve bunun yerine bir ileti oluşturduğu anlamına gelir. `auto` varsayılan değerdir ve modelin ileti oluşturma veya bir veya daha fazla araç çağırma arasında seçim yapabileceğiniz anlamına gelir. `required` , modelin kullanıcıya yanıt vermeden önce bir veya daha fazla araç çağırması gerektiği anlamına gelir. veya gibi `{"type": "file_search"}{"type": "function", "function": {"name": "my_function"}}` belirli bir aracı belirtmek, modeli söz konusu aracı çağırmaya zorlar.	Hayı
araçlar	OpenAI.AssistantTool dizisi	Yardımcının bu çalıştırma için kullanabileceği araçları geçersiz kılın. Bu, çalışma başına davranışı değiştirmek için kullanışlıdır.	Hayı
top_p	sayı veya null	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 veya sıcaklığı değiştirmenizi öneririz, ancak ikisini birden değiştirmemenizi öneririz.	Hayı
truncation_strategy	OpenAI.TruncationObject	Bir iş parçacığının çalıştırmadan önce nasıl kesileceğini denetler. Çalıştırmanın ilk bağlam penceresini denetlemek için bunu kullanın.	Hayı

OpenAI.CreateThreadAndRunRequest

İsim	Türü	Description	Gerekli
assistant_id	String	Bu çalıştırmayı yürütmek için kullanılacak yardımcının kimliği.	Evet
instructions	dize veya null	Yardımcının varsayılan sistem iletisini geçersiz kılın. Bu, çalışma başına davranışı değiştirmek için kullanışlıdır.	Hayı
max_completion_tokens	tamsayı veya null	Çalıştırma boyunca kullanılabilecek en fazla tamamlanma belirteci sayısı. Çalıştırma, çalıştırmanın birden çok dönüşünde yalnızca belirtilen tamamlanma belirteçlerinin sayısını kullanmak için en iyi çabayı gösterir. Çalıştırma belirtilen tamamlanma belirteçlerinin sayısını aşarsa, çalıştırma durumu `incomplete`ile sona erer. Daha fazla bilgi için bkz. `incomplete_details`.	Hayı
max_prompt_tokens	tamsayı veya null	Çalıştırma boyunca kullanılabilecek en fazla istem belirteci sayısı. Çalıştırma, çalıştırmanın birden çok dönüşünde yalnızca belirtilen istem belirteci sayısını kullanmak için en iyi çabayı gösterir. Çalıştırma belirtilen istem belirteci sayısını aşarsa, çalıştırma durumu `incomplete`ile sona erer. Daha fazla bilgi için bkz. `incomplete_details`.	Hayı
metadata	OpenAI.Metadata veya null		Hayı
model	String	Bu çalıştırmayı yürütmek için kullanılacak Modelin kimliği. Burada bir değer sağlanırsa, yardımcıyla ilişkili modeli geçersiz kılar. Aksi takdirde, yardımcıyla ilişkili model kullanılır.	Hayı
paralel araç çağrıları	OpenAI.ParallelToolCalls	Araç kullanımı sırasında paralel işlev çağrısının etkinleştirilip etkinleştirilmeyileceği.	Hayı
yanıt formatı	OpenAI.AssistantsApiResponseFormatOption	Modelin çıkış yapması gereken biçimi belirtir. GPT-4o, GPT-4 Turbo ve tüm `gpt-3.5-turbo-1106`GPT-3.5 Turbo modelleri ile uyumludur. ayarı, `{ "type": "json_schema", "json_schema": {...} }` modelin sağlanan JSON şemanızla eşleşmesini sağlayan Yapılandırılmış Çıkışlar'ı etkinleştirir. Daha fazla bilgi için ayarı `{ "type": "json_object" }` , modelin oluşturduğu iletinin geçerli bir JSON olduğundan emin olan JSON modunu etkinleştirir. Önemli:* JSON modunu kullanırken, modele bir sistem veya kullanıcı iletisi aracılığıyla kendiniz JSON üretmesini de belirtmeniz gerekir . Bu olmadan model, nesil belirteç sınırına ulaşana kadar bitmeyen bir boşluk akışı oluşturabilir ve bu da uzun süre çalışan ve görünüşe göre "takılmış" bir istekle sonuçlanır. Ayrıca, neslin aşıldığını veya konuşmanın maksimum bağlam uzunluğunu aştığını `finish_reason="length"` gösteren ileti `max_tokens`içeriğinin kısmen kesilebileceğini unutmayın.	Hayı
veri akışı	boole veya null	ise `true`, Sunucu tarafından gönderilen farklı çalıştır olayları sırasında gerçekleşen olayların akışını döndürür ve Çalıştır bir iletiyle `data: [DONE]` bir terminal durumuna girdiğinde sonlandırılır.	Hayı
sıcaklık	sayı veya null	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.	Hayı
iplik	OpenAI.CreateThreadRequest	Yeni iş parçacığı oluşturma seçenekleri. Bir iş parçacığı çalıştırılırken iş parçacığı sağlanmadıysa isteğinde boş bir iş parçacığı oluşturulur.	Hayı
tool_choice	OpenAI.AssistantsApiToolChoiceOption	Model tarafından çağrılan aracı (varsa) denetler. `none` modelin herhangi bir araç çağırmayacağı ve bunun yerine bir ileti oluşturduğu anlamına gelir. `auto` varsayılan değerdir ve modelin ileti oluşturma veya bir veya daha fazla araç çağırma arasında seçim yapabileceğiniz anlamına gelir. `required` , modelin kullanıcıya yanıt vermeden önce bir veya daha fazla araç çağırması gerektiği anlamına gelir. veya gibi `{"type": "file_search"}{"type": "function", "function": {"name": "my_function"}}` belirli bir aracı belirtmek, modeli söz konusu aracı çağırmaya zorlar.	Hayı
tool_resources	OpenAI.CreateThreadAndRunRequestToolResources veya null	Yardımcının araçları tarafından kullanılan bir kaynak kümesi. Kaynaklar araç türüne özeldir. Örneğin, `code_interpreter` araç bir dosya kimlikleri listesi gerektirirken `file_search` , araç vektör deposu kimliklerinin listesini gerektirir.	Hayı
araçlar	OpenAI.AssistantTool dizisi	Yardımcının bu çalıştırma için kullanabileceği araçları geçersiz kılın. Bu, çalışma başına davranışı değiştirmek için kullanışlıdır.	Hayı
top_p	sayı veya null	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 veya sıcaklığı değiştirmenizi öneririz, ancak ikisini birden değiştirmemenizi öneririz.	Hayı
truncation_strategy	OpenAI.TruncationObject	Bir iş parçacığının çalıştırmadan önce nasıl kesileceğini denetler. Çalıştırmanın ilk bağlam penceresini denetlemek için bunu kullanın.	Hayı

OpenAI.CreateThreadAndRunRequestToolResources

İsim	Türü	Description	Gerekli	Varsayılan
code_interpreter	OpenAI.CreateThreadAndRunRequestToolResourcesCodeInterpreter		Hayı
file_search	OpenAI.CreateThreadAndRunRequestToolResourcesFileSearch		Hayı

OpenAI.CreateThreadAndRunRequestToolResourcesCodeInterpreter

İsim	Türü	Description	Gerekli	Varsayılan
dosya_kimlikleri	dize dizisi		Hayı	[]

OpenAI.CreateThreadAndRunRequestToolResourcesFileSearch

İsim	Türü	Description	Gerekli	Varsayılan
vector_store_ids	dize dizisi		Hayı

OpenAI.CreateThreadRequest

Yeni iş parçacığı oluşturma seçenekleri. bir istek çalıştırılırken iş parçacığı sağlanmazsa boş bir iş parçacığı oluşturulur.

İsim	Türü	Description	Gerekli
Mesajlar	OpenAI.CreateMessageRequest dizisi	İş parçacığını başlatacak iletilerin listesi.	Hayı
metadata	OpenAI.Metadata veya null		Hayı
tool_resources	OpenAI.CreateThreadRequestToolResources veya null		Hayı

OpenAI.CreateThreadRequestToolResources

İsim	Türü	Description	Gerekli	Varsayılan
code_interpreter	OpenAI.CreateThreadRequestToolResourcesCodeInterpreter		Hayı
file_search	nesne veya nesne		Hayı

OpenAI.CreateThreadRequestToolResourcesCodeInterpreter

İsim	Türü	Description	Gerekli	Varsayılan
dosya_kimlikleri	dize dizisi		Hayı

OpenAI.CreateVectorStoreFileBatchRequest

İsim	Türü	Description	Gerekli
attributes	OpenAI.VectorStoreFileAttributes veya null		Hayı
chunking_strategy	OpenAI.ChunkingStrategyRequestParam	Dosya/dosyaları öbeklemek için kullanılan öbekleme stratejisi. Ayarlanmadıysa, stratejiyi `auto` kullanır. Yalnızca `file_ids` boş değilse geçerlidir.	Hayı
dosya_kimlikleri	dize dizisi	Vektör deposunun kullanması gereken Dosya Kimliklerinin listesi. Dosyalara erişebilecek gibi `file_search` araçlar için kullanışlıdır. Sağlanmış veya `chunking_strategy` sağlanmışsa`attributes`, bunlar toplu işteki tüm dosyalara uygulanır. `files` ile birbirini dışlar.	Hayı
files	OpenAI.CreateVectorStoreFileRequest dizisi	Her biri artı isteğe bağlı `attributes` veya `chunking_strategy`içeren `file_id` nesnelerin listesi. Belirli dosyalar için meta verileri geçersiz kılmanız gerektiğinde bunu kullanın. Genel `attributes` veya `chunking_strategy` yoksayılır ve her dosya için belirtilmelidir. `file_ids` ile birbirini dışlar.	Hayı

OpenAI.CreateVectorStoreFileRequest

İsim	Türü	Description	Gerekli
attributes	OpenAI.VectorStoreFileAttributes veya null		Hayı
chunking_strategy	OpenAI.ChunkingStrategyRequestParam	Dosya/dosyaları öbeklemek için kullanılan öbekleme stratejisi. Ayarlanmadıysa, stratejiyi `auto` kullanır. Yalnızca `file_ids` boş değilse geçerlidir.	Hayı
dosya_kimlik	String	Vektör deposunun kullanması gereken dosya kimliği. Dosyalara erişebilecek gibi `file_search` araçlar için kullanışlıdır.	Evet

OpenAI.CreateVectorStoreRequest

İsim	Türü	Description	Gerekli
chunking_strategy	OpenAI.ChunkingStrategyRequestParam	Dosya/dosyaları öbeklemek için kullanılan öbekleme stratejisi. Ayarlanmadıysa, stratejiyi `auto` kullanır. Yalnızca `file_ids` boş değilse geçerlidir.	Hayı
açıklama	String	Vektör deposu için bir açıklama. Vektör deposunun amacını açıklamak için kullanılabilir.	Hayı
sona_erdikten_sonra	OpenAI.VectorStoreExpirationAfter	Vektör deposu için sona erme politikası.	Hayı
dosya_kimlikleri	dize dizisi	Vektör deposunun kullanması gereken Dosya Kimliklerinin listesi. Dosyalara erişebilecek gibi `file_search` araçlar için kullanışlıdır.	Hayı
metadata	OpenAI.Metadata veya null		Hayı
name	String	Vektör deposunun adı.	Hayı

OpenAI.CustomGrammarFormatParam

Kullanıcı tarafından tanımlanan bir dilbilgisi.

İsim	Türü	Description	Gerekli
tanım	String	Dilbilgisi tanımı.	Evet
syntax	OpenAI.GrammarSyntax1		Evet
type	enum	Dilbilgisi formatı. Her zaman `grammar`. Olası değerler: `grammar`	Evet

OpenAI.CustomTextFormatParam

Sınırsız serbest biçimli metin.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Sınırsız metin formatı. Her zaman `text`. Olası değerler: `text`	Evet

OpenAI.CustomToolChatCompletions

Belirli bir formatla girdiyi işleyen özel bir araç.

İsim	Türü	Description	Gerekli
custom	OpenAI.CustomToolChatCompletionsCustom		Evet
└─ açıklama	String		Hayı
└─ biçimi	OpenAI.CustomToolChatCompletionsCustomFormatText veya OpenAI.CustomToolChatCompletionsCustomFormatGrammar		Hayı
└─ ad	String		Evet
type	enum	Özel aracın türü. Her zaman `custom`. Olası değerler: `custom`	Evet

OpenAI.CustomToolChatCompletionsCustom

İsim	Türü	Gerekli
açıklama	String	Hayı
format	OpenAI.CustomToolChatCompletionsCustomFormatText veya OpenAI.CustomToolChatCompletionsCustomFormatGrammar	Hayı
name	String	Evet

OpenAI.CustomToolChatCompletionsCustomFormatGrammar

İsim	Türü	Description	Gerekli
Dilbilgisi	OpenAI.CustomToolChatCompletionsCustomFormatGrammarGrammar		Evet
└─ tanımı	String		Evet
└─ söz dizimi	enum	Olası değerler: `lark`, `regex`	Evet
type	enum	Olası değerler: `grammar`	Evet

OpenAI.CustomToolChatCompletionsCustomFormatGrammarGrammar

İsim	Türü	Description	Gerekli	Varsayılan
tanım	String		Evet
syntax	enum	Olası değerler: `lark`, `regex`	Evet

OpenAI.CustomToolChatCompletionsCustomFormatText

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olası değerler: `text`	Evet

OpenAI.CustomToolParam

Belirli bir formatla girdiyi işleyen özel bir araç. özel araçlar

İsim	Türü	Description	Gerekli
açıklama	String	Daha fazla bağlam sağlamak için kullanılan özel aracın isteğe bağlı açıklaması.	Hayı
format	OpenAI.CustomToolParamFormat	Özel araç için giriş formatı. Varsayılan metin sınırsız olur.	Hayı
└─ türü	OpenAI.CustomToolParamFormatType		Evet
name	String	Özel aracın adı, aracı çağırmalarda tanımlamak için kullanılır.	Evet
type	enum	Özel aracın türü. Her zaman `custom`. Olası değerler: `custom`	Evet

OpenAI.CustomToolParamFormat

Özel araç için giriş formatı. Varsayılan metin sınırsız olur.

OpenAI.CustomToolParamFormat için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
`text`	OpenAI.CustomTextFormatParam
`grammar`	OpenAI.CustomGrammarFormatParam

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.CustomToolParamFormatType		Evet

OpenAI.CustomToolParamFormatType

Mülkiyet	Değer
Türü	String
Değerler	`text` `grammar`

OpenAI.DeleteFileResponse

İsim	Türü	Description	Gerekli
silindi	Boolean		Evet
kimlik	String		Evet
nesne	enum	Olası değerler: `file`	Evet

OpenAI.DeleteFineTuningCheckpointPermissionResponse

İsim	Türü	Description	Gerekli
silindi	Boolean	hassas ayarlı model denetim noktası izninin başarıyla silinip silinmediği.	Evet
kimlik	String	Silinen ince ayarlı model denetim noktası izninin kimliği.	Evet
nesne	enum	Her zaman "checkpoint.permission" olan nesne türü. Olası değerler: `checkpoint.permission`	Evet

OpenAI.DeleteMessageResponse

İsim	Türü	Description	Gerekli
silindi	Boolean		Evet
kimlik	String		Evet
nesne	enum	Olası değerler: `thread.message.deleted`	Evet

OpenAI.DeleteModelResponse

İsim	Türü	Gerekli
silindi	Boolean	Evet
kimlik	String	Evet
nesne	String	Evet

OpenAI.DeleteThreadResponse

İsim	Türü	Description	Gerekli
silindi	Boolean		Evet
kimlik	String		Evet
nesne	enum	Olası değerler: `thread.deleted`	Evet

OpenAI.DeleteVectorStoreFileResponse

İsim	Türü	Description	Gerekli
silindi	Boolean		Evet
kimlik	String		Evet
nesne	enum	Olası değerler: `vector_store.file.deleted`	Evet

OpenAI.DeleteVectorStoreResponse

İsim	Türü	Description	Gerekli
silindi	Boolean		Evet
kimlik	String		Evet
nesne	enum	Olası değerler: `vector_store.deleted`	Evet

OpenAI.DeletedConversationResource

İsim	Türü	Description	Gerekli
silindi	Boolean		Evet
kimlik	String		Evet
nesne	enum	Olası değerler: `conversation.deleted`	Evet

OpenAI.DoubleClickAction

Çift tıklama eylemi.

İsim	Türü	Description	Gerekli
type	enum	Olay türünü belirtir. Çift tıklama eylemi için bu özellik her zaman olarak `double_click`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.Drag

Sürükleme eylemi.

İsim	Türü	Description	Gerekli	Varsayılan
path	OpenAI.DragPoint dizisi	Sürükleme eyleminin yolunu temsil eden koordinat dizisi. Koordinatlar bir dizi olarak görünür nesnelerin, örneğin `<br> [<br> { x: 100, y: 200 },<br> { x: 200, y: 300 }<br> ]<br>`	Evet
type	enum	Olay türünü belirtir. Sürükleme eylemi için bu özellik her zaman `drag` olarak ayarlanır. Olası değerler: `drag`	Evet

OpenAI.DragPoint

X/y koordinat çifti, örneğin. { x: 100, y: 200 }

İsim	Türü	Description	Gerekli	Varsayılan
x	tamsayı	X koordinatı.	Evet
y	tamsayı	Y koordinatı.	Evet

OpenAI.EasyInputMessage

Modele, hiyerarşiyi izleyen yönergeyi belirten bir rol içeren bir ileti girişi. developer veya system rolüyle verilen yönergeler, user rolüyle verilen yönergelerden önceliklidir. assistant rolüne sahip iletilerin, önceki etkileşimlerde model tarafından oluşturulduğu varsayılır.

İsim	Türü	Description	Gerekli
içerik	string veya OpenAI.InputMessageContentList	Yanıt oluşturmak için kullanılan modele metin, görüntü veya ses girişi. Önceki yardımcı yanıtlarını da içerebilir.	Evet
role	enum	İleti girişinin rolü. `user`, `assistant`, `system`'den biri `developer`. Olası değerler: `user`, `assistant`, `system`, `developer`	Evet
type	enum	İleti girişinin türü. Her zaman `message`. Olası değerler: `message`	Evet

OpenAI.Embedding

Ekleme uç noktası tarafından döndürülen ekleme vektörlerini temsil eder.

İsim	Türü	Description	Gerekli
embedding	sayı dizisi	Kayanların listesi olan ekleme vektörünün adı. Vektör uzunluğu , ekleme kılavuzunda listelenen modele bağlıdır.	Evet
indeks	tamsayı	Eklemeler listesindeki ekleme dizini.	Evet
nesne	enum	Her zaman "ekleme" olan nesne türü. Olası değerler: `embedding`	Evet

OpenAI.Eval

Veri kaynağı yapılandırması ve test ölçütlerine sahip bir Değerlendirme nesnesi. Değerlendirme, LLM tümleştirmeniz için yapılacak bir görevi temsil eder. Beğen:

Sohbet botlarımın kalitesini artırma
Sohbet botlarımın müşteri desteğini ne kadar iyi işlediğini görün
O4-mini'nin benim kullanım alanımda gpt-4o'dan daha iyi olup olmadığını denetleyin

İsim	Türü	Description	Gerekli
oluşturulma_tarihi	tamsayı	Değerlendirmenin oluşturulduğu zaman için Unix zaman damgası (saniye olarak).	Evet
veri_kaynağı_yapılandırması	OpenAI.EvalCustomDataSourceConfig veya OpenAI.EvalLogsDataSourceConfig veya OpenAI.EvalStoredCompletionsDataSourceConfig	Değerlendirme çalıştırmalarında kullanılan veri kaynaklarının yapılandırması.	Evet
kimlik	String	Değerlendirme için benzersiz tanımlayıcı.	Evet
metadata	OpenAI.Metadata veya null		Evet
name	String	Değerlendirmenin adı.	Evet
nesne	enum	Nesne türü. Olası değerler: `eval`	Evet
test kriterleri	OpenAI.CreateEvalLabelModelGrader veya OpenAI.EvalGraderStringCheck ya da OpenAI.EvalGraderTextSimilarity veya OpenAI.EvalGraderPython ya da OpenAI.EvalGraderScoreModel veya EvalGraderEndpoint dizisi	Test ölçütlerinin listesi.	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.EvalCustomDataSourceConfig

"item şemasını ve isteğe bağlı olarak sample ad alanlarınızı belirten CustomDataSourceConfig." Yanıt şeması, aşağıdaki verilerin şeklini tanımlar:

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
şema	nesne	Çalıştırma veri kaynağı öğelerinin json şeması. JSON şemaları oluşturmayı buradan öğrenin.	Evet
type	enum	Veri kaynağının türü. Her zaman `custom`. Olası değerler: `custom`	Evet

OpenAI.EvalGraderPython

İsim	Türü	Description	Gerekli
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ş	Numara	Puan eşiği.	Hayı
kaynak	String	Python betiğinin kaynak kodu.	Evet
type	enum	Her zaman `python`olan nesne türü. Olası değerler: `python`	Evet

OpenAI.EvalGraderScoreModel

İsim	Türü	Description	Gerekli	Varsayılan
girdi	OpenAI.EvalItem dizisi	Not veren tarafından değerlendirilen giriş iletileri. Metin, çıkış metni, giriş görüntüsü ve giriş ses içerik bloklarını destekler ve şablon dizeleri içerebilir.	Evet
model	String	Değerlendirme için kullanılacak model.	Evet
name	String	Değerlendiricinin adı.	Evet
eşik_geçiş	Numara	Puan eşiği.	Hayı
menzil	sayı dizisi	Puan aralığı. Varsayılan olarak `[0, 1]` değerini alır.	Hayı
Örnekleme_Parametreleri	OpenAI.EvalGraderScoreModelSamplingParams		Hayı
└─ max_completions_tokens	tamsayı veya null		Hayı
└─ akıl yürütme çabası	OpenAI.ReasoningEffort	Akıl yürütmeye yönelik çabayı kısıtlar mantık modelleri. Şu anda desteklenen değerler `none`, `minimal`, `low`, `medium`, `high`, ve `xhigh`'dir. Azaltma muhakeme çabası daha hızlı yanıtlara ve daha az belirteç kullanılmasına neden olabilir bir yanıtta mantık yürütme. - `gpt-5.1` varsayılan olarak `none`öğesini kullanır ve mantık yürütmez. Desteklenen gerekçe değerleri `gpt-5.1none`, `low`, `medium`, ve `high`'dir. Araç çağrıları gpt-5.1'deki tüm akıl yürütme değerleri için desteklenir. - Tüm modeller varsayılan olarak akıl yürütme eforu olmadan `gpt-5.1` önce `medium` ve desteklemez`none`. - Model `gpt-5-pro` varsayılan olarak akıl yürütme eforunu kullanır (ve yalnızca destekler `high` ). - `xhigh` , sonrasındaki `gpt-5.1-codex-max`tüm modeller için desteklenir.	Hayı
└─ tohum	tamsayı veya null		Hayı
└─ sıcaklık	sayı veya null		Hayı
└─ top_p	sayı veya null		Hayı	1
type	enum	Her zaman `score_model`olan nesne türü. Olası değerler: `score_model`	Evet

OpenAI.EvalGraderScoreModelSamplingParams

İsim	Türü	Description	Gerekli
max_completions_tokens	tamsayı veya null		Hayı
akıl yürütme çabası	OpenAI.ReasoningEffort	Akıl yürütmeye yönelik çabayı kısıtlar mantık modelleri. Şu anda desteklenen değerler `none`, `minimal`, `low`, `medium`, `high`, ve `xhigh`'dir. Azaltma muhakeme çabası daha hızlı yanıtlara ve daha az belirteç kullanılmasına neden olabilir bir yanıtta mantık yürütme. - `gpt-5.1` varsayılan olarak `none`öğesini kullanır ve mantık yürütmez. Desteklenen gerekçe değerleri `gpt-5.1none`, `low`, `medium`, ve `high`'dir. Araç çağrıları gpt-5.1'deki tüm akıl yürütme değerleri için desteklenir. - Tüm modeller varsayılan olarak akıl yürütme eforu olmadan `gpt-5.1` önce `medium` ve desteklemez`none`. - Model `gpt-5-pro` varsayılan olarak akıl yürütme eforunu kullanır (ve yalnızca destekler `high` ). - `xhigh` , sonrasındaki `gpt-5.1-codex-max`tüm modeller için desteklenir.	Hayı
seed	tamsayı veya null		Hayı
sıcaklık	sayı veya null		Hayı
top_p	sayı veya null		Hayı

OpenAI.EvalGraderStringCheck

İsim	Türü	Description	Gerekli
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_check`olan nesne türü. Olası değerler: `string_check`	Evet

OpenAI.EvalGraderTextSimilarity

İsim	Türü	Description	Gerekli
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ş	Numara	Puan eşiği.	Evet
referans	String	Değerlendirmenin yapıldığı metin.	Evet
type	enum	Not verenin türü. Olası değerler: `text_similarity`	Evet

OpenAI.EvalItem

İsim	Türü	Description	Gerekli
içerik	OpenAI.EvalItemContent	Modele girişler - şablon dizeleri içerebilir. Tek bir öğe veya öğe dizisi olarak metin, çıkış metni, giriş görüntüleri ve giriş sesini destekler.	Evet
role	enum	İleti girişinin rolü. `user`, `assistant`, `system`'den biri `developer`. Olası değerler: `user`, `assistant`, `system`, `developer`	Evet
type	enum	İleti girişinin türü. Her zaman `message`. Olası değerler: `message`	Hayı

OpenAI.EvalItemContent

Modele girişler - şablon dizeleri içerebilir. Tek bir öğe veya öğe dizisi olarak metin, çıkış metni, giriş görüntüleri ve giriş sesini destekler.

Tür: OpenAI.EvalItemContentItem veya OpenAI.EvalItemContentArray

Modele girişler - şablon dizeleri içerebilir. Tek bir öğe veya öğe dizisi olarak metin, çıkış metni, giriş görüntüleri ve giriş sesini destekler.

OpenAI.EvalItemContentArray

Her biri giriş metni, çıkış metni, giriş görüntüsü veya giriş ses nesnesi olabilecek girişlerin listesi.

Dizisi: OpenAI.EvalItemContentItem

OpenAI.EvalItemContentItem

Tek bir içerik öğesi: giriş metni, çıkış metni, giriş görüntüsü veya giriş sesi.

Tür: OpenAI.EvalItemContentText veya OpenAI.EvalItemContentItemObject

Tek bir içerik öğesi: giriş metni, çıkış metni, giriş görüntüsü veya giriş sesi.

OpenAI.EvalItemContentItemObject

Tek bir içerik öğesi: giriş metni, çıkış metni, giriş görüntüsü veya giriş sesi.

OpenAI.EvalItemContentItemObject için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
`output_text`	OpenAI.EvalItemContentOutputText
`input_image`	OpenAI.EvalItemInputImage
`input_audio`	OpenAI.InputAudio
`input_text`	OpenAI.EvalItemContentItemObjectInputTextContent

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.EvalItemContentItemObjectType		Evet

OpenAI.EvalItemContentItemObjectInputTextContent

Modele metin girişi.

İsim	Türü	Description	Gerekli	Varsayılan
text	String	Modele metin girişi.	Evet
type	enum	Giriş öğesinin türü. Her zaman `input_text`. Olası değerler: `input_text`	Evet

OpenAI.EvalItemContentItemObjectType

Mülkiyet	Değer
Türü	String
Değerler	`input_text` `output_text` `input_image` `input_audio`

OpenAI.EvalItemContentOutputText

Modelden bir metin çıktısı.

İsim	Türü	Description	Gerekli	Varsayılan
text	String	Modelden metin çıkışı.	Evet
type	enum	Çıkış metninin türü. Her zaman `output_text`. Olası değerler: `output_text`	Evet

OpenAI.EvalItemContentText

Modele metin girişi.

Tür: dize

OpenAI.EvalItemInputImage

EvalItem içerik dizilerinde kullanılan bir görüntü giriş bloğu.

İsim	Türü	Description	Gerekli
detail	String	Modele gönderilecek görüntünün ayrıntı düzeyi. `high`, `low`veya `auto`. Varsayılan olarak `auto` değerini alır.	Hayı
image_url	String	Görüntü girişinin URL'si.	Evet
type	enum	Görüntü girişinin türü. Her zaman `input_image`. Olası değerler: `input_image`	Evet

OpenAI.EvalJsonlFileContentSource

İsim	Türü	Description	Gerekli	Varsayılan
içerik	OpenAI.EvalJsonlFileContentSourceContent dizisi	jsonl dosyasının içeriği.	Evet
type	enum	Jsonl kaynağının türü. Her zaman `file_content`. Olası değerler: `file_content`	Evet

OpenAI.EvalJsonlFileContentSourceContent

İsim	Türü	Description	Gerekli	Varsayılan
öğe	nesne		Evet
örnek	nesne		Hayı

OpenAI.EvalJsonlFileIdSource

İsim	Türü	Description	Gerekli	Varsayılan
kimlik	String	Dosyanın tanımlayıcısı.	Evet
type	enum	Jsonl kaynağının türü. Her zaman `file_id`. Olası değerler: `file_id`	Evet

OpenAI.EvalList

Bir değerlendirme listesini temsil eden bir nesne.

İsim	Türü	Description	Gerekli
veriler	OpenAI.Eval dizisi	Bir dizi eval objeleri.	Evet
ilk_kimlik	String	Veri dizisindeki ilk değerlendirmenin tanımlayıcısı.	Evet
daha_fazla	Boolean	Daha fazla değerlendirme mevcut olup olmadığını gösterir.	Evet
son_kimlik	String	Veri dizisindeki son değerlendirmenin tanımlayıcısı.	Evet
nesne	enum	Bu nesnenin türü. Her zaman "liste" olarak ayarlanır. Olası değerler: `list`	Evet

OpenAI.EvalLogsDataSourceConfig

LogsDataSourceConfig, günlükler sorgunuzun meta veri özelliğini belirler. Bu genellikle usecase=chatbot, prompt-version=v2 gibi meta verilerdir. Bu veri kaynağı yapılandırması tarafından döndürülen şema, değerlendirmelerinizde hangi değişkenlerin kullanılabilir olduğunu tanımlamada kullanılmıştır. item ve sample her ikisi de bu veri kaynağı yapılandırması kullanılırken tanımlanır.

İsim	Türü	Description	Gerekli
metadata	OpenAI.Metadata veya null		Hayı
şema	nesne	Çalıştırma veri kaynağı öğelerinin json şeması. JSON şemaları oluşturmayı buradan öğrenin.	Evet
type	enum	Veri kaynağının türü. Her zaman `logs`. Olası değerler: `logs`	Evet

OpenAI.EvalResponsesSource

Çalıştırma veri kaynağı yapılandırmasını açıklayan bir EvalResponsesSource nesnesi.

İsim	Türü	Description	Gerekli
oluşturulma_tarihi_sonrası	tamsayı veya null		Hayı
önceden oluşturulmuş	tamsayı veya null		Hayı
talimatlar_arama	dize veya null		Hayı
metadata	object veya null		Hayı
model	dize veya null		Hayı
akıl yürütme çabası	OpenAI.ReasoningEffort veya null		Hayı
sıcaklık	sayı veya null		Hayı
araçlar	dize dizisi veya null		Hayı
top_p	sayı veya null		Hayı
type	enum	Çalıştırma veri kaynağının türü. Her zaman `responses`. Olası değerler: `responses`	Evet
users	dize dizisi veya null		Hayı

OpenAI.EvalRun

Değerlendirme oturumunu temsil eden şema.

İsim	Türü	Description	Gerekli
oluşturulma_tarihi	tamsayı	Değerlendirme çalıştırması oluşturulduğunda Unix zaman damgası (saniye olarak).	Evet
veri_kaynağı	OpenAI.CreateEvalJsonlRunDataSource veya OpenAI.CreateEvalCompletionsRunDataSource veya OpenAI.CreateEvalResponsesRunDataSource	Çalıştırmanın veri kaynağı hakkında bilgi.	Evet
hata	OpenAI.EvalApiError	Değerlendirme API'sinden bir hata yanıtını temsil eden nesne.	Evet
eval_id	String	İlişkili değerlendirmenin tanımlayıcısı.	Evet
kimlik	String	Değerlendirme çalışması için benzersiz tanımlayıcı.	Evet
metadata	OpenAI.Metadata veya null		Evet
model	String	Değerlendirilen model, eğer uygulanabiliyorsa.	Evet
name	String	Değerlendirme çalıştırmasının adı.	Evet
nesne	enum	Nesnenin türü. Her zaman "eval.run". Olası değerler: `eval.run`	Evet
model_başına_kullanım	OpenAI.EvalRunPerModelUsage dizisi	Değerlendirme çalıştırması sırasında her model için kullanım istatistikleri.	Evet
test_kriterlerine_göre_sonuçlar	OpenAI.EvalRunPerTestingCriteriaResults dizisi	Değerlendirme çalıştırması sırasında uygulanan test kriterlerine göre sonuçlar.	Evet
rapor_url	String	kullanıcı arabirimi panosunda görüntülenen değerlendirme raporunun URL'si.	Evet
sonuç_sayıları	OpenAI.EvalRunResultCounts		Evet
└─ hata	tamsayı		Evet
└─ başarısız oldu	tamsayı		Evet
└─ geçti	tamsayı		Evet
└─ toplam	tamsayı		Evet
durum	String	Çalıştırma değerlendirmesinin durumu.	Evet

OpenAI.EvalRunList

Değerlendirme için çalıştırma listesini temsil eden nesne.

İsim	Türü	Description	Gerekli
veriler	OpenAI.EvalRun dizisi	Değerlendirme çalıştırma nesnelerinden oluşan bir dizi.	Evet
ilk_kimlik	String	Veri dizisindeki ilk değerlendirme çalıştırmasının tanımlayıcısı.	Evet
daha_fazla	Boolean	Daha fazla değerlendirme mevcut olup olmadığını gösterir.	Evet
son_kimlik	String	Veri dizisindeki son değerlendirme çalıştırmasının tanımlayıcısı.	Evet
nesne	enum	Bu nesnenin türü. Her zaman "liste" olarak ayarlanır. Olası değerler: `list`	Evet

OpenAI.EvalRunOutputItem

Değerlendirme çalıştırmasının çıkış öğesini temsil eden bir şema.

İsim	Türü	Description	Gerekli
oluşturulma_tarihi	tamsayı	Değerlendirme çalıştırması oluşturulduğunda Unix zaman damgası (saniye olarak).	Evet
veri kaynağı öğesi	nesne	Giriş veri kaynağı öğesinin ayrıntıları.	Evet
veri_kaynağı_öğe_kimliği	tamsayı	Veri kaynağı öğesinin tanımlayıcısı.	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	OpenAI.EvalRunOutputItemResult dizisi	Bu çıkış öğesi için not veren sonuçlarının listesi.	Evet
run_id	String	Bu çıkış öğesiyle ilişkili değerlendirme çalıştırmasının tanımlayıcısı.	Evet
örnek	OpenAI.EvalRunOutputItemSample		Evet
└─ hata	OpenAI.EvalApiError	Değerlendirme API'sinden bir hata yanıtını temsil eden nesne.	Evet
└─ bitiş_nedeni	String		Evet
└─ giriş	OpenAI.EvalRunOutputItemSampleInput dizisi		Evet
└─ maksimum_önem_bitim_kodları	tamsayı		Evet
└─ modeli	String		Evet
└─ çıkış	OpenAI.EvalRunOutputItemSampleOutput dizisi		Evet
└─ tohum	tamsayı		Evet
└─ sıcaklık	Numara		Evet
└─ top_p	Numara		Evet
└─ kullanımı	OpenAI.EvalRunOutputItemSampleUsage		Evet
durum	String	Çalıştırma değerlendirmesinin durumu.	Evet

OpenAI.EvalRunOutputItemList

Değerlendirme çalıştırması için çıkış öğelerinin listesini temsil eden nesne.

İsim	Türü	Description	Gerekli
veriler	OpenAI.EvalRunOutputItem dizisi	Değerlendirme çalıştırma çıktısı öğe nesnelerinin bir dizisi.	Evet
ilk_kimlik	String	Veri dizisindeki ilk değerlendirme çalıştırması çıkış öğesinin tanımlayıcısı.	Evet
daha_fazla	Boolean	Kullanılabilir daha fazla değerlendirme çalıştırması çıktı öğesi olup olmadığını gösterir.	Evet
son_kimlik	String	Veri dizisindeki son değerlendirme çalıştırması çıkış öğesinin tanımlayıcısı.	Evet
nesne	enum	Bu nesnenin türü. Her zaman "liste" olarak ayarlanır. Olası değerler: `list`	Evet

OpenAI.EvalRunOutputItemResult

Değerlendirme çalıştırması çıkış öğesi için tek bir not veren sonucu.

İsim	Türü	Description	Gerekli
name	String	Değerlendiricinin adı.	Evet
Geçirilen	Boolean	Not verenin çıkışı bir geçiş olarak değerlendirip değerlendirmediği.	Evet
örnek	object veya null	Not veren tarafından üretilen isteğe bağlı örnek veya ara veriler.	Hayı
Puan	Numara	Not veren tarafından üretilen sayısal puan.	Evet
type	String	Not veren türü (örneğin, "string-check-grader").	Hayı

OpenAI.EvalRunOutputItemSample

İsim	Türü	Description	Gerekli
hata	OpenAI.EvalApiError	Değerlendirme API'sinden bir hata yanıtını temsil eden nesne.	Evet
bitiş_nedeni	String		Evet
girdi	OpenAI.EvalRunOutputItemSampleInput dizisi		Evet
max_completion_tokens	tamsayı		Evet
model	String		Evet
çıktı	OpenAI.EvalRunOutputItemSampleOutput dizisi		Evet
seed	tamsayı		Evet
sıcaklık	Numara		Evet
top_p	Numara		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ü	Gerekli
cached_tokens	tamsayı	Evet
completion_tokens	tamsayı	Evet
prompt_tokens	tamsayı	Evet
total_tokens	tamsayı	Evet

OpenAI.EvalRunPerModelUsage

İsim	Türü	Gerekli
cached_tokens	tamsayı	Evet
completion_tokens	tamsayı	Evet
invocation_count	tamsayı	Evet
model_name	String	Evet
prompt_tokens	tamsayı	Evet
total_tokens	tamsayı	Evet

OpenAI.EvalRunPerTestingCriteriaResults

İsim	Türü	Gerekli
başarısız	tamsayı	Evet
Geçirilen	tamsayı	Evet
test kriterleri	String	Evet

OpenAI.EvalRunResultCounts

İsim	Türü	Gerekli
hata oluştu	tamsayı	Evet
başarısız	tamsayı	Evet
Geçirilen	tamsayı	Evet
toplam	tamsayı	Evet

OpenAI.EvalStoredCompletionsDataSourceConfig

LogsDataSourceConfig lehine kullanım dışı ilan edildi.

İsim	Türü	Description	Gerekli
metadata	OpenAI.Metadata veya null		Hayı
şema	nesne	Çalıştırma veri kaynağı öğelerinin json şeması. JSON şemaları oluşturmayı buradan öğrenin.	Evet
type	enum	Veri kaynağının türü. Her zaman `stored_completions`. Olası değerler: `stored_completions`	Evet

OpenAI.EvalStoredCompletionsSource

Bir filtre kümesini açıklayan StoredCompletionsRunDataSource yapılandırması

İsim	Türü	Description	Gerekli
oluşturulma_tarihi_sonrası	tamsayı veya null		Hayı
önceden oluşturulmuş	tamsayı veya null		Hayı
limit	tamsayı veya null		Hayı
metadata	OpenAI.Metadata veya null		Hayı
model	dize veya null		Hayı
type	enum	Kaynak türü. Her zaman `stored_completions`. Olası değerler: `stored_completions`	Evet

OpenAI.FileCitationBody

Bir dosyaya referans.

İsim	Türü	Description	Gerekli
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.FilePath

Bir dosyaya giden yol.

İsim	Türü	Description	Gerekli
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.FileSearchRanker

Dosya araması için kullanılacak dereceleyici. Belirtilmezse auto ranker kullanılır.

Mülkiyet	Değer
Türü	String
Değerler	`auto` `default_2024_08_21`

OpenAI.FileSearchRankingOptions

Dosya araması için derecelendirme seçenekleri. Belirtilmezse, dosya arama aracı derecelendiriciyi auto ve 0 score_threshold kullanır. Daha fazla bilgi için dosya arama aracı belgelerine bakın.

İsim	Türü	Description	Gerekli	Varsayılan
sıralayıcı	OpenAI.FileSearchRanker	Dosya araması için kullanılacak dereceleyici. Belirtilmezse `auto` ranker kullanılır.	Hayı
puan_eşik_değeri	Numara	Dosya araması için puan eşiği. Tüm değerler 0 ile 1 arasında kayan noktalı bir sayı olmalıdır. Kısıtlamalar: min: 0, max: 1	Evet

OpenAI.FileSearchTool

Yüklenen dosyalardan ilgili içeriği arayan bir araç.

İsim	Türü	Description	Gerekli
filters	OpenAI.Filters veya null		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	OpenAI.RankingOptions		Hayı
└─ hybrid_search	OpenAI.HybridSearchOptions	Hibrit arama etkinleştirildiğinde karşılıklı sıralama birleşiminin anlamsal gömütme eşleşmeleri ile seyrek anahtar kelime eşleşmelerini nasıl dengelediğini kontrol eden ağırlıklar.	Hayı
└─ sıralama yapıcı	OpenAI.RankerVersionType	Dosya araması için kullanılacak dereceleyici.	Hayı
└─ skor_eşiği	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	dize dizisi	Aranacak vektör depolarının kimlikleri.	Evet

OpenAI.FileSearchToolCallResults

İsim	Türü	Gerekli
attributes	OpenAI.VectorStoreFileAttributes veya null	Hayı
dosya_kimlik	String	Hayı
filename	String	Hayı
Puan	Numara	Hayı
text	String	Hayı

OpenAI.Filters

Tür: OpenAI.ComparisonFilter veya OpenAI.CompoundFilter

OpenAI.FineTuneDPOHyperparameters

DPO ince ayar işi için kullanılan hiperparametreler.

İsim	Türü	Description	Gerekli
küme_boyutu	dize veya tamsayı	Her toplu işlemdeki örnek sayısı. Daha büyük bir toplu iş boyutu, model parametrelerinin daha az sıklıkta, ancak daha düşük varyansla güncelleştirildiğini gösterir.	Hayı
beta	dize veya sayı	DPO yönteminin beta değeri. Daha yüksek bir beta değeri, ilke ve başvuru modeli arasındaki cezanın ağırlığını artırır.	Hayı
öğrenme oranı çarpanı	dize veya sayı	Öğrenme oranı için ölçeklendirme faktörü. Aşırı uydurmayı önlemek için daha düşük bir öğrenme oranı yararlı olabilir.	Hayı
n_devir	dize veya tamsayı	Modelin eğitileceği epok sayısı. Dönem, eğitim veri kümesindeki bir tam döngüyü ifade eder.	Hayı

OpenAI.FineTuneDPOMethod

DPO ince ayarlama yöntemi için yapılandırma.

İsim	Türü	Description	Gerekli	Varsayılan
hiper parametreler	OpenAI.FineTuneDPOHyperparameters	DPO ince ayar işi için kullanılan hiperparametreler.	Hayı

OpenAI.FineTuneMethod

İnce ayar için kullanılan yöntem.

İsim	Türü	Description	Gerekli
dpo	OpenAI.FineTuneDPOMethod	DPO ince ayarlama yöntemi için yapılandırma.	Hayı
Takviye	AzureFineTuneReinforcementMethod		Hayı
Denetimli	OpenAI.FineTuneSupervisedMethod	Denetimli ince ayar yöntemi için yapılandırma.	Hayı
type	enum	Yöntemin türü. `supervised`, `dpo`veya `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
küme_boyutu	dize veya tamsayı	Her toplu işlemdeki örnek sayısı. Daha büyük bir toplu iş boyutu, model parametrelerinin daha az sıklıkta, ancak daha düşük varyansla güncelleştirildiğini gösterir.	Hayı
compute_multiplier	dize veya sayı	Eğitim sırasında arama alanını keşfetmek için kullanılan işlem miktarının çarpanı.	Hayı
değerlendirme_aralığı	dize veya tamsayı	Değerlendirme çalıştırmaları arasındaki eğitim adımlarının sayısı.	Hayı
değerlendirme_örnekleri	dize veya tamsayı	Eğitim adımı başına oluşturulacak değerlendirme örneklerinin sayısı.	Hayı
öğrenme oranı çarpanı	dize veya sayı	Öğrenme oranı için ölçeklendirme faktörü. Aşırı uydurmayı önlemek için daha düşük bir öğrenme oranı yararlı olabilir.	Hayı
n_devir	dize veya tamsayı	Modelin eğitileceği epok sayısı. Dönem, eğitim veri kümesindeki bir tam döngüyü ifade eder.	Hayı
akıl yürütme çabası	enum	Akıl yürütme çabası düzeyi. Olası değerler: `default`, `low`, `medium`, `high`	Hayı

OpenAI.FineTuneSupervisedHyperparameters

İnce ayar işi için kullanılan hiper parametreler.

İsim	Türü	Description	Gerekli
küme_boyutu	dize veya tamsayı	Her toplu işlemdeki örnek sayısı. Daha büyük bir toplu iş boyutu, model parametrelerinin daha az sıklıkta, ancak daha düşük varyansla güncelleştirildiğini gösterir.	Hayı
öğrenme oranı çarpanı	dize veya sayı	Öğrenme oranı için ölçeklendirme faktörü. Aşırı uydurmayı önlemek için daha düşük bir öğrenme oranı yararlı olabilir.	Hayı
n_devir	dize veya tamsayı	Modelin eğitileceği epok sayısı. Dönem, eğitim veri kümesindeki bir tam döngüyü ifade eder.	Hayı

OpenAI.FineTuneSupervisedMethod

Denetimli ince ayar yöntemi için yapılandırma.

İsim	Türü	Description	Gerekli	Varsayılan
hiper parametreler	OpenAI.FineTuneSupervisedHyperparameters	İnce ayar işi için kullanılan hiper parametreler.	Hayı

OpenAI.FineTuningCheckpointPermission

nesnesi, checkpoint.permission ince ayarlanmış bir model denetim noktası için bir izni temsil eder.

İsim	Türü	Description	Gerekli
oluşturulma_tarihi	tamsayı	İzin oluşturulduğu zaman için Unix zaman damgası (saniye olarak).	Evet
kimlik	String	API uç noktalarına başvurulabilen izin tanımlayıcısı.	Evet
nesne	enum	Her zaman "checkpoint.permission" olan nesne türü. Olası değerler: `checkpoint.permission`	Evet
project_id	String	İznin ait olduğu proje tanımlayıcısı.	Evet

OpenAI.FineTuningIntegration (OpenAI İnce Ayar Entegrasyonu)

İsim	Türü	Description	Gerekli
type	enum	İnce ayar işi için etkinleştirilen entegrasyon türü Olası değerler: `wandb`	Evet
wandb	OpenAI.FineTuningIntegrationWandb		Evet
└─ varlık	dize veya null		Hayı
└─ ad	dize veya null		Hayı
└─ proje	String		Evet
└─ etiketleri	dize dizisi		Hayı

OpenAI.FineTuningIntegrationWandb

İsim	Türü	Gerekli
varlık	dize veya null	Hayı
name	dize veya null	Hayı
project	String	Evet
tags	dize dizisi	Hayı

OpenAI.FineTuningJob

nesnesi, fine_tuning.job API aracılığıyla oluşturulmuş bir ince ayar işini temsil eder.

İsim	Türü	Description	Gerekli	Varsayılan
oluşturulma_tarihi	tamsayı	Unix zaman damgası (saniye cinsinden), hassas ayarlama işinin oluşturulduğu zamanı belirtir.	Evet
hata	OpenAI.FineTuningJobError veya null		Evet
tahmini_bitiş	dize veya null		Hayı
fine_tuned_model	dize veya null		Evet
tamamlandı	dize veya null		Evet
hiper parametreler	OpenAI.FineTuningJobHyperparameters		Evet
└─ yığın boyutu	dize veya tamsayı veya null		Hayı	otomatik
└─ öğrenme oranı çarpanı	dize veya sayı		Hayı
└─ n_epochs	dize veya tamsayı		Hayı	otomatik
kimlik	String	API uç noktalarına başvurulabilen nesne tanımlayıcısı.	Evet
Entegrasyonlar	OpenAI.FineTuningIntegration veya null dizisi		Hayı
metadata	OpenAI.Metadata veya null		Hayı
method	OpenAI.FineTuneMethod	İnce ayar için kullanılan yöntem.	Hayı
model	String	İnce ayar yapılan temel model.	Evet
nesne	enum	Her zaman "fine_tuning.job" olan nesne türü. Olası değerler: `fine_tuning.job`	Evet
organizasyon_id	String	İnce ayar işinin sahibi olan kuruluş.	Evet
sonuç_dosyaları	dize dizisi	İnce ayar işi için derlenmiş sonuç dosyası kimliği/belgeleri. Sonuçları Dosyalar API'siyle alabilirsiniz.	Evet
seed	tamsayı	İnce ayar işi için kullanılan tohum.	Evet
durum	enum	, veya `validating_files`olabilir`queuedrunningsucceededfailed`, ince ayarlama işinin `cancelled`geçerli durumu. Olası değerler: `validating_files`, `queued`, `running`, `succeeded`, , `failed`, `cancelled`	Evet
eğitilmiş_jetonlar	tamsayı veya null		Evet
eğitim_dosyası	String	Eğitim için kullanılan dosya kimliği. Eğitim verilerini Dosyalar API'siyle alabilirsiniz.	Evet
doğrulama_dosyası	dize veya null		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
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 ayarlı denetim noktası modelinin adı.	Evet
ince_ayarlama_iş_id	String	Bu denetim noktasının oluşturulduğu ince ayar işinin adı.	Evet
kimlik	String	API uç noktalarında başvurulabilen denetim noktası tanımlayıcısı.	Evet
metrics	OpenAI.FineTuningJobCheckpointMetrics		Evet
tam doğrulama kaybı (full_valid_loss)	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.FineTuningJobCheckpointMetrics

İsim	Türü	Gerekli
full_valid_loss	Numara	Hayı
full_valid_mean_token_accuracy	Numara	Hayı
adım	Numara	Hayı
train_loss	Numara	Hayı
train_mean_token_accuracy	Numara	Hayı
valid_loss	Numara	Hayı
valid_mean_token_accuracy	Numara	Hayı

OpenAI.FineTuningJobError

İsim	Türü	Gerekli
kod	String	Evet
mesaj	String	Evet
param	dize veya null	Evet

OpenAI.FineTuningJobEvent

İş olayı nesnesine ince ayar

İsim	Türü	Description	Gerekli
oluşturulma_tarihi	tamsayı	Unix zaman damgası (saniye cinsinden), hassas ayarlama işinin oluşturulduğu zamanı belirtir.	Evet
veriler	OpenAI.FineTuningJobEventData		Hayı
kimlik	String	Nesne tanımlayıcısı.	Evet
seviye	enum	Olayın günlük düzeyi. Olası değerler: `info`, `warn`, `error`	Evet
mesaj	String	Olayın iletisi.	Evet
nesne	enum	Nesne türü, her zaman "fine_tuning.job.event" şeklindedir. Olası değerler: `fine_tuning.job.event`	Evet
type	enum	Olayın türü. Olası değerler: `message`, `metrics`	Hayı

OpenAI.FineTuningJobEventData

Tür: nesne

OpenAI.FineTuningJobHyperparameters

İsim	Türü	Gerekli
küme_boyutu	dize veya tamsayı veya null	Hayı
öğrenme oranı çarpanı	dize veya sayı	Hayı
n_devir	dize veya tamsayı	Hayı

OpenAI.FunctionAndCustomToolCallOutput

OpenAI.FunctionAndCustomToolCallOutput için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
`input_text`	OpenAI.FunctionAndCustomToolCallOutputInputTextContent
`input_image`	OpenAI.FunctionAndCustomToolCallOutputInputImageContent
`input_file`	OpenAI.FunctionAndCustomToolCallOutputInputFileContent

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.FunctionAndCustomToolCallOutputType		Evet

OpenAI.FunctionAndCustomToolCallOutputInputFileContent

Modele bir dosya girişi.

İsim	Türü	Description	Gerekli
file_data	String	Modele gönderilecek dosyanın içeriği.	Hayı
dosya_kimlik	dize veya null		Hayı
file_url	String	Modele gönderilecek dosyanın URL'si.	Hayı
filename	String	Modele gönderilecek dosyanın adı.	Hayı
type	enum	Giriş öğesinin türü. Her zaman `input_file`. Olası değerler: `input_file`	Evet

OpenAI.FunctionAndCustomToolCallOutputInputImageContent

Modele bir görüntü girişi. image girişleri hakkında bilgi edinin.

İsim	Türü	Description	Gerekli
detail	OpenAI.ImageDetail		Evet
dosya_kimlik	dize veya null		Hayı
image_url	dize veya null		Hayı
type	enum	Giriş öğesinin türü. Her zaman `input_image`. Olası değerler: `input_image`	Evet

OpenAI.FunctionAndCustomToolCallOutputInputTextContent

Modele metin girişi.

İsim	Türü	Description	Gerekli	Varsayılan
text	String	Modele metin girişi.	Evet
type	enum	Giriş öğesinin türü. Her zaman `input_text`. Olası değerler: `input_text`	Evet

OpenAI.FunctionAndCustomToolCallOutputType

Mülkiyet	Değer
Türü	String
Değerler	`input_text` `input_image` `input_file`

OpenAI.FunctionObject

İsim	Türü	Description	Gerekli
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ı. 64 karaktere kadar a-z, A-Z, 0-9, alt çizgi veya kısa çizgi içermelidir.	Evet
parameters	OpenAI.FunctionParameters	İşlevlerin kabullediği, JSON Şeması nesnesi olarak tanımlanan parametreler. Örnekler için guide ve format hakkında dokümantasyon için JSON Schema reference adresine bakınız. Atlama `parameters` , boş parametre listesi olan bir işlevi tanımlar.	Hayı
Kesin	boole veya null		Hayı

OpenAI.FunctionParameters

İşlevlerin kabullediği, JSON Şeması nesnesi olarak tanımlanan parametreler. Örnekler için guide ve format hakkında dokümantasyon için JSON Schema reference adresine bakınız. Atlama parameters , boş parametre listesi olan bir işlevi tanımlar.

Tür: nesne

OpenAI.FunctionShellAction

Bir kabuk komutu yürütür.

İsim	Türü	Gerekli
commands	dize dizisi	Evet
max_output_length	tamsayı veya null	Evet
zaman_aşımı_ms	tamsayı veya null	Evet

OpenAI.FunctionShellCallOutputContent

Bir kabuk aracının içeriği, yayılan çağrı çıkışını çağırır.

İsim	Türü	Description	Gerekli
Oluşturan	String	Öğeyi oluşturan aktörün tanımlayıcısı.	Hayı
sonuç	OpenAI.FunctionShellCallOutputOutcome	Bir çıkış sonucunu (çıkış koduyla) veya kabuk çağrısı çıkış öbekleri için zaman aşımı sonucunu temsil eder.	Evet
└─ türü	OpenAI.FunctionShellCallOutputOutcomeType		Evet
Stderr	String	Yakalanan standart hata çıkışı.	Evet
stdout	String	Yakalanan standart çıkış.	Evet

OpenAI.FunctionShellCallOutputExitOutcome

Shell komutlarının tamamlandığını ve çıkış kodunu döndürdüğünü gösterir.

İsim	Türü	Description	Gerekli	Varsayılan
exit_code	tamsayı	Kabuk işleminden çıkış kodu.	Evet
type	enum	Sonuç türü. Her zaman `exit`. Olası değerler: `exit`	Evet

OpenAI.FunctionShellCallOutputOutcome

Bir çıkış sonucunu (çıkış koduyla) veya kabuk çağrısı çıkış öbekleri için zaman aşımı sonucunu temsil eder.

OpenAI.FunctionShellCallOutputOutcome için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
`timeout`	OpenAI.FunctionShellCallOutputTimeoutOutcome
`exit`	OpenAI.FunctionShellCallOutputExitOutcome

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.FunctionShellCallOutputOutcomeType		Evet

OpenAI.FunctionShellCallOutputOutcomeType

Mülkiyet	Değer
Türü	String
Değerler	`timeout` `exit`

OpenAI.FunctionShellCallOutputTimeoutOutcome

Shell çağrısının ayarlanmış zaman sınırını aştığını gösterir.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Sonuç türü. Her zaman `timeout`. Olası değerler: `timeout`	Evet

OpenAI.FunctionShellToolParam

Modelin shell komutlarını çalıştırmasına olanak tanıyan bir araç.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Kabuk aracının türü. Her zaman `shell`. Olası değerler: `shell`	Evet

OpenAI.FunctionTool

Modelin çağırmayı seçebileceği kendi kodunuzda bir işlev tanımlar.

İsim	Türü	Description	Gerekli
açıklama	dize veya null		Hayı
name	String	Çağrılacak işlevin adı.	Evet
parameters	object veya null		Evet
Kesin	boole veya null		Evet
type	enum	İşlev aracının türü. Her zaman `function`. Olası değerler: `function`	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
çıktıyı_hesapla	String	Not veren sonuçlarına göre çıkışı hesaplamak için bir formül.	Evet
Öğrenciler	OpenAI.GraderStringCheck veya OpenAI.GraderTextSimilarity veya OpenAI.GraderScoreModel veya GraderEndpoint		Evet
name	String	Değerlendiricinin adı.	Evet
type	enum	Her zaman `multi`olan 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
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 `python`olan nesne türü. Olası değerler: `python`	Evet

OpenAI.GraderScoreModel

Girişe puan atamak için model kullanan scoreModelGrader nesnesi.

İsim	Türü	Description	Gerekli	Varsayılan
girdi	OpenAI.EvalItem dizisi	Not veren tarafından değerlendirilen giriş iletileri. Metin, çıkış metni, giriş görüntüsü ve giriş ses içerik bloklarını destekler ve şablon dizeleri içerebilir.	Evet
model	String	Değerlendirme için kullanılacak model.	Evet
name	String	Değerlendiricinin adı.	Evet
menzil	sayı dizisi	Puan aralığı. Varsayılan olarak `[0, 1]` değerini alır.	Hayı
Örnekleme_Parametreleri	OpenAI.EvalGraderScoreModelSamplingParams		Hayı
└─ max_completions_tokens	tamsayı veya null		Hayı
└─ akıl yürütme çabası	OpenAI.ReasoningEffort	Akıl yürütmeye yönelik çabayı kısıtlar mantık modelleri. Şu anda desteklenen değerler `none`, `minimal`, `low`, `medium`, `high`, ve `xhigh`'dir. Azaltma muhakeme çabası daha hızlı yanıtlara ve daha az belirteç kullanılmasına neden olabilir bir yanıtta mantık yürütme. - `gpt-5.1` varsayılan olarak `none`öğesini kullanır ve mantık yürütmez. Desteklenen gerekçe değerleri `gpt-5.1none`, `low`, `medium`, ve `high`'dir. Araç çağrıları gpt-5.1'deki tüm akıl yürütme değerleri için desteklenir. - Tüm modeller varsayılan olarak akıl yürütme eforu olmadan `gpt-5.1` önce `medium` ve desteklemez`none`. - Model `gpt-5-pro` varsayılan olarak akıl yürütme eforunu kullanır (ve yalnızca destekler `high` ). - `xhigh` , sonrasındaki `gpt-5.1-codex-max`tüm modeller için desteklenir.	Hayı
└─ tohum	tamsayı veya null		Hayı
└─ sıcaklık	sayı veya null		Hayı
└─ top_p	sayı veya null		Hayı	1
type	enum	Her zaman `score_model`olan 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
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_check`olan 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
değerlendirme ölçütü	enum	Kullanılacak değerlendirme ölçümü. `cosine`, , `fuzzy_match`, `bleu`, `gleu`, `meteor`, `rouge_1`, , `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, veya `rouge_l`. Olası değerler: `cosine`, `fuzzy_match`, `bleu`, , `gleu`, `meteor`, , `rouge_1`, `rouge_2rouge_3`, `rouge_4rouge_5`,`rouge_l`	Evet
girdi	String	Notlanan metin.	Evet
name	String	Değerlendiricinin adı.	Evet
referans	String	Değerlendirmenin yapıldığı metin.	Evet
type	enum	Not verenin türü. Olası değerler: `text_similarity`	Evet

OpenAI.GrammarSyntax1

Mülkiyet	Değer
Türü	String
Değerler	`lark` `regex`

OpenAI.HybridSearchOptions

İsim	Türü	Description	Gerekli	Varsayılan
embedding_weight	Numara	Karşılıklı sıralama füzyonundaki gömülen ağırlığı.	Evet
text_weight	Numara	Karşılıklı sıralama birleşimindeki metnin ağırlığı.	Evet

OpenAI.ImageDetail

Mülkiyet	Değer
Türü	String
Değerler	`low` `high` `auto`

OpenAI.ImageGenTool

GPT görüntü modelleriyle görüntü üreten bir araç.

Geçerli modeller:

gpt-image-1
gpt-image-1-mini

İsim	Türü	Description	Gerekli	Varsayılan
arka plan	enum	Oluşturulan görüntünün arka plan türü. Bunlardan biri `transparent` `opaque`veya `auto`. Varsayılan: `auto`. Olası değerler: `transparent`, `opaque`, `auto`	Hayı
input_fidelity	OpenAI.InputFidelity veya null		Hayı
girdi_görüntü_maskesi	OpenAI.ImageGenToolInputImageMask		Hayı
└─ dosya_kimliği	String		Hayı
└─ image_url (görsel URL'si)	String		Hayı
model	dize (aşağıdaki geçerli modellere bakın)		Hayı
moderation	enum	Oluşturulan görüntü için denetim düzeyi. Varsayılan: `auto`. Olası değerler: `auto`, `low`	Hayı
çıktı sıkıştırma	tamsayı	Çıkış görüntüsü için sıkıştırma düzeyi. Varsayılan: 100. Kısıtlamalar: min: 0, max: 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ı. Kısıtlamalar: min: 0, max: 3	Hayı
nitelik	enum	Oluşturulan görüntünün kalitesi. `low`, , `medium`, `high`, veya `auto`. Varsayılan: `auto`. Olası değerler: `low`, `medium`, `high`, `auto`	Hayı
boyut	enum	Oluşturulan görüntünün boyutu. , , `1024x1024`' lerden `1024x1536`biri `1536x1024`veya `auto`. Varsayılan: `auto`. Olası değerler: `1024x1024`, `1024x1536`, `1536x1024`, `auto`	Hayı
type	enum	Görüntü oluşturma aracının türü. Her zaman `image_generation`. Olası değerler: `image_generation`	Evet

OpenAI.ImageGenToolInputImageMask

İsim	Türü	Description	Gerekli	Varsayılan
dosya_kimlik	String		Hayı
image_url	String		Hayı

OpenAI.IncludeEnum

Model yanıtına eklenecek ek çıktı verilerini belirtin. Şu anda desteklenen değerler şunlardır:

web_search_call.action.sources: Web arama aracı çağrısının kaynaklarını ekleyin.
code_interpreter_call.outputs: Kod yorumlayıcı aracı çağrı öğelerinde python kod yürütme çıktılarını içerir.
computer_call_output.output.image_url: Bilgisayar çağrısı çıkışından görüntü URL'lerini ekleyin.
file_search_call.results: Dosya arama aracı çağrısının arama sonuçlarını ekleyin.
message.input_image.image_url: Giriş iletisinden görüntü URL'lerini ekleyin.
message.output_text.logprobs: Yardımcı iletilerine logprobs ekleyin.
reasoning.encrypted_content: Akıl yürütme öğesi çıkışlarında akıl yürütme belirteçlerinin şifrelenmiş bir sürümünü içerir. Bu, Yanıtlar API'sini durum bilgisi olmadan kullanırken (örneğin, store parametresi false olarak ayarlandığında veya bir kuruluş sıfır veri saklama programına kaydedildiğinde) akıl yürütme öğelerinin çok aşamalı konuşmalarda kullanılmasını sağlar.

Mülkiyet	Değer
Açıklama	Model yanıtına eklenecek ek çıktı verilerini belirtin. Şu anda desteklenen değerler şunlardır:

web_search_call.action.sources: Web arama aracı çağrısının kaynaklarını ekleyin.
code_interpreter_call.outputs: Kod yorumlayıcı aracı çağrı öğelerinde python kod yürütme çıktılarını içerir.
computer_call_output.output.image_url: Bilgisayar çağrısı çıkışından görüntü URL'lerini ekleyin.
file_search_call.results: Dosya arama aracı çağrısının arama sonuçlarını ekleyin.
message.input_image.image_url: Giriş iletisinden görüntü URL'lerini ekleyin.
message.output_text.logprobs: Yardımcı iletilerine logprobs ekleyin.
reasoning.encrypted_content: Akıl yürütme öğesi çıkışlarında akıl yürütme belirteçlerinin şifrelenmiş bir sürümünü içerir. Bu, Yanıtlar API'sini durum bilgisi olmadan kullanırken (örneğin, store parametresi false olarak ayarlandığında veya bir kuruluş sıfır veri saklama programına kaydedildiğinde) akıl yürütme öğelerinin çok aşamalı konuşmalarda kullanılmasını sağlar. | | Tür | string | | Değerler | file_search_call.results
web_search_call.results
web_search_call.action.sources
message.input_image.image_url
computer_call_output.output.image_url
code_interpreter_call.outputs
reasoning.encrypted_content
message.output_text.logprobs |

OpenAI.InputAudio

Modele ses girişi.

İsim	Türü	Description	Gerekli	Varsayılan
input_audio	OpenAI.InputAudioInputAudio		Evet
type	enum	Giriş öğesinin türü. Her zaman `input_audio`. Olası değerler: `input_audio`	Evet

OpenAI.InputAudioInputAudio

İsim	Türü	Description	Gerekli	Varsayılan
veriler	String		Evet
format	enum	Olası değerler: `mp3`, `wav`	Evet

OpenAI.InputContent

OpenAI.InputContent için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
`input_text`	OpenAI.InputContentInputTextContent
`input_image`	OpenAI.InputContentInputImageContent
`input_file`	OpenAI.InputContentInputFileContent

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.InputContentType		Evet

OpenAI.InputContentInputFileContent

Modele bir dosya girişi.

İsim	Türü	Description	Gerekli
file_data	String	Modele gönderilecek dosyanın içeriği.	Hayı
dosya_kimlik	dize veya null		Hayı
file_url	String	Modele gönderilecek dosyanın URL'si.	Hayı
filename	String	Modele gönderilecek dosyanın adı.	Hayı
type	enum	Giriş öğesinin türü. Her zaman `input_file`. Olası değerler: `input_file`	Evet

OpenAI.InputContentInputImageContent

Modele bir görüntü girişi. image girişleri hakkında bilgi edinin.

İsim	Türü	Description	Gerekli
detail	OpenAI.ImageDetail		Evet
dosya_kimlik	dize veya null		Hayı
image_url	dize veya null		Hayı
type	enum	Giriş öğesinin türü. Her zaman `input_image`. Olası değerler: `input_image`	Evet

OpenAI.InputContentInputTextContent

Modele metin girişi.

İsim	Türü	Description	Gerekli	Varsayılan
text	String	Modele metin girişi.	Evet
type	enum	Giriş öğesinin türü. Her zaman `input_text`. Olası değerler: `input_text`	Evet

OpenAI.InputContentType

Mülkiyet	Değer
Türü	String
Değerler	`input_text` `input_image` `input_file`

OpenAI.InputFidelity

Modelin giriş görüntülerinin stil ve özellikleriyle, özellikle yüz özellikleriyle eşleşmesi için ne kadar çaba göstereceğini kontrol edin. Bu parametre yalnızca için gpt-image-1desteklenir. için gpt-image-1-minidesteklenmiyor. high ve lowdestekler. Varsayılan olarak low değerini alır.

Mülkiyet	Değer
Türü	String
Değerler	`high` `low`

OpenAI.InputFileContent

Modele bir dosya girişi.

İsim	Türü	Description	Gerekli
file_data	String	Modele gönderilecek dosyanın içeriği.	Hayı
dosya_kimlik	dize veya null		Hayı
file_url	String	Modele gönderilecek dosyanın URL'si.	Hayı
filename	String	Modele gönderilecek dosyanın adı.	Hayı
type	enum	Giriş öğesinin türü. Her zaman `input_file`. Olası değerler: `input_file`	Evet

OpenAI.InputImageContent

Modele bir görüntü girişi. image girişleri hakkında bilgi edinin.

İsim	Türü	Description	Gerekli
detail	OpenAI.ImageDetail		Evet
dosya_kimlik	dize veya null		Hayı
image_url	dize veya null		Hayı
type	enum	Giriş öğesinin türü. Her zaman `input_image`. Olası değerler: `input_image`	Evet

OpenAI.InputItem

OpenAI.InputItem için Ayrıştırıcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
`message`	OpenAI.EasyInputMessage
`item_reference`	OpenAI.ItemReferenceParam

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.InputItemType		Evet

OpenAI.InputItemType

Mülkiyet	Değer
Türü	String
Değerler	`message` `item_reference`

OpenAI.InputMessageContentList

Modelde farklı içerik türleri içeren bir veya birden çok giriş öğesinin listesi.

Dizisi: OpenAI.InputContent

OpenAI.InputMessageResource

İsim	Türü	Description	Gerekli
içerik	OpenAI.InputMessageContentList	Modelde farklı içerik içeren bir veya birden çok giriş öğesinin listesi types.	Evet
kimlik	String	İleti girişinin benzersiz kimliği.	Evet
role	enum	İleti girişinin rolü. `user`, `system`veya `developer`. Olası değerler: `user`, `system`, `developer`	Evet
durum	enum	Öğenin durumu. `in_progress`, `completed`, veya bunlardan biri `incomplete`. Öğeler API aracılığıyla döndürülürken doldurulur. Olası değerler: `in_progress`, `completed`, `incomplete`	Hayı
type	enum	İleti girişinin türü. Her zaman `message`olarak ayarlayın. Olası değerler: `message`	Evet

OpenAI.InputParam

Yanıt oluşturmak için kullanılan modele metin, görüntü veya dosya girişleri. Daha fazla bilgi edinin:

Tür: OpenAI.InputItem dizesi veya dizisi

Yanıt oluşturmak için kullanılan modele metin, görüntü veya dosya girişleri. Daha fazla bilgi edinin:

OpenAI.InputTextContent

Modele metin girişi.

İsim	Türü	Description	Gerekli	Varsayılan
text	String	Modele metin girişi.	Evet
type	enum	Giriş öğesinin türü. Her zaman `input_text`. Olası değerler: `input_text`	Evet

OpenAI.ItemReferenceParam

Başvurulacak bir öğenin iç tanımlayıcısı.

İsim	Türü	Description	Gerekli	Varsayılan
kimlik	String	Başvurulacak öğenin kimliği.	Evet
type	enum	Başvurulacak öğenin türü. Her zaman `item_reference`. Olası değerler: `item_reference`	Evet

OpenAI.ItemResource

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

OpenAI.ItemResource için Ayrıştırıcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
`message`	OpenAI.InputMessageResource
`output_message`	OpenAI.ItemResourceOutputMessage
`file_search_call`	OpenAI.ItemResourceFileSearchToolCall
`computer_call`	OpenAI.ItemResourceComputerToolCall
`computer_call_output`	OpenAI.ItemResourceComputerToolCallOutputResource
`web_search_call`	OpenAI.ItemResourceWebSearchToolCall
`function_call`	OpenAI.ItemResourceFunctionToolCallResource
`function_call_output`	OpenAI.ItemResourceFunctionToolCallOutputResource
`image_generation_call`	OpenAI.ItemResourceImageGenToolCall
`code_interpreter_call`	OpenAI.ItemResourceCodeInterpreterToolCall
`local_shell_call`	OpenAI.ItemResourceLocalShellToolCall
`local_shell_call_output`	OpenAI.ItemResourceLocalShellToolCallOutput
`shell_call`	OpenAI.ItemResourceFunctionShellCall
`shell_call_output`	OpenAI.ItemResourceFunctionShellCallOutput
`apply_patch_call`	OpenAI.ItemResourceApplyPatchToolCall
`apply_patch_call_output`	OpenAI.ItemResourceApplyPatchToolCallOutput
`mcp_list_tools`	OpenAI.ItemResourceMcpListTools
`mcp_approval_request`	OpenAI.ItemResourceMcpApprovalRequest
`mcp_approval_response`	OpenAI.ItemResourceMcpApprovalResponseResource
`mcp_call`	OpenAI.ItemResourceMcpToolCall

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.ItemResourceType		Evet

OpenAI.ItemResourceApplyPatchToolCall

Dosya oluşturarak, silerek veya güncelleştirerek dosya farklarını uygulayan bir araç çağrısı.

İsim	Türü	Description	Gerekli
call_id	String	Model tarafından oluşturulan uygulama yama aracı çağrısının benzersiz kimliği.	Evet
Oluşturan	String	Bu araç çağrısını oluşturan varlığın kimliği.	Hayı
kimlik	String	Düzeltme eki uygulama aracı çağrısının benzersiz kimliği. Bu öğe, API aracılığıyla iade edildiğinde doldurulur.	Evet
Operasyon	OpenAI.ApplyPatchFileOperation	apply_patch aracılığıyla uygulanan create_file, delete_file veya update_file işlemlerinden biri.	Evet
└─ türü	OpenAI.ApplyPatchFileOperationType		Evet
durum	OpenAI.ApplyPatchCallStatus		Evet
type	enum	Öğenin türü. Her zaman `apply_patch_call`. Olası değerler: `apply_patch_call`	Evet

OpenAI.ItemResourceApplyPatchToolCallOutput

Bir düzeltme eki uygulama aracı çağrısı tarafından yayılan çıkış.

İsim	Türü	Description	Gerekli
call_id	String	Model tarafından oluşturulan uygulama yama aracı çağrısının benzersiz kimliği.	Evet
Oluşturan	String	Bu aracı oluşturan varlığın kimliği çağrı çıktısı.	Hayı
kimlik	String	Düzeltme eki uygulama aracı çağrı çıkışının benzersiz kimliği. Bu öğe, API aracılığıyla iade edildiğinde doldurulur.	Evet
çıktı	dize veya null		Hayı
durum	OpenAI.ApplyPatchCallOutputStatus		Evet
type	enum	Öğenin türü. Her zaman `apply_patch_call_output`. Olası değerler: `apply_patch_call_output`	Evet

OpenAI.ItemResourceCodeInterpreterToolCall

Kodu çalıştırmak için bir araç çağrısı.

İsim	Türü	Description	Gerekli
kod	dize veya null		Evet
container_id	String	Kodu çalıştırmak için kullanılan kapsayıcının kimliği.	Evet
kimlik	String	Kod yorumlayıcısı araç çağrısının benzersiz kimliği.	Evet
Çıktılar	OpenAI.CodeInterpreterOutputLogs dizisi veya OpenAI.CodeInterpreterOutputImage veya null		Evet
durum	enum	Kod yorumlayıcı aracı çağrısının durumu. Geçerli değerler : `in_progress`, `completed`, `incomplete`, `interpreting`ve `failed`. Olası değerler: `in_progress`, `completed`, `incomplete`, `interpreting`, `failed`	Evet
type	enum	Kod yorumlayıcı aracı çağrısının türü. Her zaman `code_interpreter_call`. Olası değerler: `code_interpreter_call`	Evet

OpenAI.ItemResourceComputerToolCall

Bilgisayar kullanım araçlarına bir araç komutu verme. Daha fazla bilgi için bilgisayar kullanım rehberi adresine bakınız.

İsim	Türü	Description	Gerekli
hareket	OpenAI.ComputerAction		Evet
call_id	String	Çıkış verisi ile araç çağrısına yanıt verirken kullanılan tanımlayıcı.	Evet
kimlik	String	Bilgisayar çağrısının benzersiz tanımlayıcısı.	Evet
pending_safety_checks	OpenAI.ComputerCallSafetyCheckParam dizisi	Bilgisayar çağrısı için bekleyen güvenlik denetimleri.	Evet
durum	enum	Öğenin durumu. `in_progress`, `completed`, veya bunlardan biri `incomplete`. Öğeler API aracılığıyla döndürülürken doldurulur. Olası değerler: `in_progress`, `completed`, `incomplete`	Evet
type	enum	Bilgisayar çağrısının türü. Her zaman `computer_call`. Olası değerler: `computer_call`	Evet

OpenAI.ItemResourceComputerToolCallOutputResource

İsim	Türü	Description	Gerekli
acknowledged_safety_checks	OpenAI.ComputerCallSafetyCheckParam dizisi	API tarafından bildirilen ve kabul edilen güvenlik kontrolleri geliştirici.	Hayı
call_id	String	Çıktı üreten bilgisayar aracı çağrısının kimliği.	Evet
kimlik	String	Bilgisayar aracı çağrısı çıkış kimliği.	Hayı
çıktı	OpenAI.ComputerScreenshotImage	Bilgisayar kullanım aracıyla kullanılan bir bilgisayar ekran görüntüsü.	Evet
durum	enum	İleti girişinin durumu. `in_progress`, `completed`, veya bunlardan biri `incomplete`. API aracılığıyla giriş öğeleri döndürüldüğünde doldurulur. Olası değerler: `in_progress`, `completed`, `incomplete`	Hayı
type	enum	Bilgisayar araçlarının çağrı çıktısının türü. Her zaman `computer_call_output`. Olası değerler: `computer_call_output`	Evet

OpenAI.ItemResourceFileSearchToolCall

Dosya arama aracı çağrısının sonuçları. Daha fazla bilgi için dosya arama rehberi adresine bakınız.

İsim	Türü	Description	Gerekli
kimlik	String	Dosya arama aracı çağrısının benzersiz kimliği.	Evet
queries	dize dizisi	Dosyaları aramak için kullanılan sorgular.	Evet
results	OpenAI.FileSearchToolCallResults veya null dizisi		Hayı
durum	enum	Dosya arama aracı çağrısının durumu. Bunlardan biri `in_progress` `searching`, `incomplete` veya `failed`, Olası değerler: `in_progress`, `searching`, `completed`, `incomplete`, `failed`	Evet
type	enum	Dosya arama aracı çağrısının türü. Her zaman `file_search_call`. Olası değerler: `file_search_call`	Evet

OpenAI.ItemResourceFunctionShellCall

Yönetilen bir ortamda bir veya daha fazla kabuk komutu yürüten bir araç çağrısı.

İsim	Türü	Description	Gerekli
hareket	OpenAI.FunctionShellAction	Bir kabuk komutu yürütür.	Evet
└─ komutları	dize dizisi		Evet
└─ max_output_length	tamsayı veya null		Evet
└─ timeout_ms	tamsayı veya null		Evet
call_id	String	Model tarafından oluşturulan shell araç çağrısının benzersiz kimliği.	Evet
Oluşturan	String	Bu araç çağrısını oluşturan varlığın kimliği.	Hayı
kimlik	String	Kabuk aracı çağrısının benzersiz kimliği. Bu öğe, API aracılığıyla iade edildiğinde doldurulur.	Evet
durum	OpenAI.LocalShellCallStatus		Evet
type	enum	Öğenin türü. Her zaman `shell_call`. Olası değerler: `shell_call`	Evet

OpenAI.ItemResourceFunctionShellCallOutput

Yayılan bir kabuk aracı çağrısının çıktısı.

İsim	Türü	Description	Gerekli
call_id	String	Model tarafından oluşturulan shell araç çağrısının benzersiz kimliği.	Evet
Oluşturan	String	Öğeyi oluşturan aktörün tanımlayıcısı.	Hayı
kimlik	String	Kabuk çağrısı çıkışının benzersiz kimliği. Bu öğe, API aracılığıyla iade edildiğinde doldurulur.	Evet
max_output_length	tamsayı veya null		Evet
çıktı	OpenAI.FunctionShellCallOutputContent dizisi	Kabuk çağrısı çıkış içeriği dizisi	Evet
type	enum	Kabuk çağrısı çıkışının türü. Her zaman `shell_call_output`. Olası değerler: `shell_call_output`	Evet

OpenAI.ItemResourceFunctionToolCallOutputResource

İsim	Türü	Description	Gerekli
call_id	String	Model tarafından oluşturulan işlev aracı çağrısının benzersiz kimliği.	Evet
kimlik	String	İşlev aracının çağrı çıkışının benzersiz kimliği. Bu öğe doldurulduğunda API aracılığıyla döndürülür.	Hayı
çıktı	OpenAI.FunctionAndCustomToolCallOutput dizesi veya dizisi	Kodunuz tarafından oluşturulan işlev çağrısının çıktısı. Bir dize veya çıkış içeriği listesi olabilir.	Evet
durum	enum	Öğenin durumu. `in_progress`, `completed`, veya bunlardan biri `incomplete`. Öğeler API aracılığıyla döndürülürken doldurulur. Olası değerler: `in_progress`, `completed`, `incomplete`	Hayı
type	enum	İşlev aracının çağrı çıktısının türü. Her zaman `function_call_output`. Olası değerler: `function_call_output`	Evet

OpenAI.ItemResourceFunctionToolCallResource

İsim	Türü	Description	Gerekli
arguments	String	İşleve geçirecek bağımsız değişkenlerin JSON dizesi.	Evet
call_id	String	Model tarafından oluşturulan işlev aracı çağrısının benzersiz kimliği.	Evet
kimlik	String	İşlev aracı çağrısının benzersiz kimliği.	Hayı
name	String	Çalıştırılacak işlevin adı.	Evet
durum	enum	Öğenin durumu. `in_progress`, `completed`, veya bunlardan biri `incomplete`. Öğeler API aracılığıyla döndürülürken doldurulur. Olası değerler: `in_progress`, `completed`, `incomplete`	Hayı
type	enum	İşlev aracı çağrısının türü. Her zaman `function_call`. Olası değerler: `function_call`	Evet

OpenAI.ItemResourceImageGenToolCall

Model tarafından yapılan bir görüntü oluşturma isteği.

İsim	Türü	Description	Gerekli
kimlik	String	Görüntü oluşturma çağrısının benzersiz kimliği.	Evet
sonuç	dize veya null		Evet
durum	enum	Görüntü oluşturma çağrısının durumu. Olası değerler: `in_progress`, `completed`, `generating`, `failed`	Evet
type	enum	Görüntü oluşturma çağrısının türü. Her zaman `image_generation_call`. Olası değerler: `image_generation_call`	Evet

OpenAI.ItemResourceLocalShellToolCall

Yerel kabukta komut çalıştırmak için bir araç çağrısı.

İsim	Türü	Description	Gerekli
hareket	OpenAI.LocalShellExecAction	Sunucuda bir komut satırı komutunu çalıştır.	Evet
call_id	String	Model tarafından oluşturulan yerel kabuk aracı çağrısının benzersiz kimliği.	Evet
kimlik	String	Yerel shell çağrısının benzersiz kimliği.	Evet
durum	enum	Yerel shell çağrısının durumu. Olası değerler: `in_progress`, `completed`, `incomplete`	Evet
type	enum	Yerel shell call'ın türü. Her zaman `local_shell_call`. Olası değerler: `local_shell_call`	Evet

OpenAI.ItemResourceLocalShellToolCallOutput

Yerel kabuk aracı çağrısının çıktısı.

İsim	Türü	Description	Gerekli
kimlik	String	Model tarafından oluşturulan yerel kabuk aracı çağrısının benzersiz kimliği.	Evet
çıktı	String	Yerel kabuk aracı çağrısının çıkışına ait bir JSON dizesi.	Evet
durum	dize veya null		Hayı
type	enum	Yerel kabuk aracı çağrı çıkışının türü. Her zaman `local_shell_call_output`. Olası değerler: `local_shell_call_output`	Evet

OpenAI.ItemResourceMcpApprovalRequest

Bir araç çağrısı işlemi için insan onayı isteği.

İsim	Türü	Description	Gerekli
arguments	String	Araç için bir JSON bağımsız değişken dizesi.	Evet
kimlik	String	Onay talebinin benzersiz kimliği.	Evet
name	String	Çalıştırılacak aracın adı.	Evet
sunucu etiketi	String	İsteği yapan MCP sunucusunun etiketi.	Evet
type	enum	Öğenin türü. Her zaman `mcp_approval_request`. Olası değerler: `mcp_approval_request`	Evet

OpenAI.ItemResourceMcpApprovalResponseResource

MCP onay isteğine yanıt.

İsim	Türü	Description	Gerekli
approval_request_id	String	Yanıtlanan onay isteğinin ID'si.	Evet
approve	Boolean	İsteğin onaylanıp onaylanmadı.	Evet
kimlik	String	Onay yanıtının benzersiz kimliği	Evet
sebep	dize veya null		Hayı
type	enum	Öğenin türü. Her zaman `mcp_approval_response`. Olası değerler: `mcp_approval_response`	Evet

OpenAI.ItemResourceMcpListTools

MCP sunucusunda kullanılabilen araçların listesi.

İsim	Türü	Description	Gerekli
hata	dize veya null		Hayı
kimlik	String	Listenin benzersiz kimliği.	Evet
sunucu etiketi	String	MCP sunucusunun etiketi.	Evet
araçlar	OpenAI.MCPListToolsTool dizisi	Sunucuda bulunan araçlar.	Evet
type	enum	Öğenin türü. Her zaman `mcp_list_tools`. Olası değerler: `mcp_list_tools`	Evet

OpenAI.ItemResourceMcpToolCall

MCP sunucusundaki bir aracın çağrılması.

İsim	Türü	Description	Gerekli
approval_request_id	dize veya null		Hayı
arguments	String	Araca geçirilen bağımsız değişkenlerin JSON dizesi.	Evet
hata	dize veya null		Hayı
kimlik	String	Araç çağrısının benzersiz kimliği.	Evet
name	String	Çalıştırılan aracın adı.	Evet
çıktı	dize veya null		Hayı
sunucu etiketi	String	Aracı çalıştıran MCP sunucusunun etiketi.	Evet
durum	OpenAI.MCPToolCallStatus		Hayı
type	enum	Öğenin türü. Her zaman `mcp_call`. Olası değerler: `mcp_call`	Evet

OpenAI.ItemResourceOutputMessage

Modelden bir çıkış iletisi.

İsim	Türü	Description	Gerekli
içerik	OpenAI.OutputMessageContent dizisi	Çıkış iletisinin içeriği.	Evet
kimlik	String	Çıkış iletisinin benzersiz kimliği.	Evet
role	enum	Çıkış iletisinin rolü. Her zaman `assistant`. Olası değerler: `assistant`	Evet
durum	enum	İleti girişinin durumu. `in_progress`, `completed`, veya bunlardan biri `incomplete`. API aracılığıyla giriş öğeleri döndürüldüğünde doldurulur. Olası değerler: `in_progress`, `completed`, `incomplete`	Evet
type	enum	Çıkış iletisinin türü. Her zaman `message`. Olası değerler: `output_message`	Evet

OpenAI.ItemResourceType

Mülkiyet	Değer
Türü	String
Değerler	`message` `output_message` `file_search_call` `computer_call` `computer_call_output` `web_search_call` `function_call` `function_call_output` `image_generation_call` `code_interpreter_call` `local_shell_call` `local_shell_call_output` `shell_call` `shell_call_output` `apply_patch_call` `apply_patch_call_output` `mcp_list_tools` `mcp_approval_request` `mcp_approval_response` `mcp_call`

OpenAI.ItemResourceWebSearchToolCall

Bir web arama aracı çağrısının sonuçları. Daha fazla bilgi için web arama rehberi adresine bakınız.

İsim	Türü	Description	Gerekli
hareket	OpenAI.WebSearchActionSearch veya OpenAI.WebSearchActionOpenPage veya OpenAI.WebSearchActionFind	Bu web arama çağrısında gerçekleştirilen belirli eylemi açıklayan bir nesne. Modelin web'i nasıl kullandığına ilişkin ayrıntıları içerir (arama, open_page, bulma).	Evet
kimlik	String	Web arama aracının benzersiz kimliği çağrı.	Evet
durum	enum	Web arama aracı çağrısının durumu. Olası değerler: `in_progress`, `searching`, `completed`, `failed`	Evet
type	enum	Web arama aracının türü. Her zaman `web_search_call`. Olası değerler: `web_search_call`	Evet

OpenAI.KeyPressAction

Modelin gerçekleştirmek istediği tuş baskıları koleksiyonu.

İsim	Türü	Description	Gerekli	Varsayılan
keys	dize dizisi	Modelin basılmasını istediği tuş kombinasyonu. Bu, her biri bir anahtarı temsil eden bir dize dizisidir.	Evet
type	enum	Olay türünü belirtir. Bir tuşa basma eylemi için bu özellik her zaman olarak `keypress`ayarlanır. Olası değerler: `keypress`	Evet

OpenAI.ListBatchesResponse

İsim	Türü	Description	Gerekli
veriler	OpenAI.Batch dizisi		Evet
ilk_kimlik	String		Hayı
daha_fazla	Boolean		Evet
son_kimlik	String		Hayı
nesne	enum	Olası değerler: `list`	Evet

OpenAI.ListFilesResponse

İsim	Türü	Gerekli
veriler	OpenAI.OpenAIFile dizisi	Evet
ilk_kimlik	String	Evet
daha_fazla	Boolean	Evet
son_kimlik	String	Evet
nesne	String	Evet

OpenAI.ListFineTuningCheckpointPermissionResponse

İsim	Türü	Description	Gerekli
veriler	OpenAI.FineTuningCheckpointPermission dizisi		Evet
ilk_kimlik	dize veya null		Hayı
daha_fazla	Boolean		Evet
son_kimlik	dize veya null		Hayı
nesne	enum	Olası değerler: `list`	Evet

OpenAI.ListFineTuningJobCheckpointsResponse

İsim	Türü	Description	Gerekli
veriler	OpenAI.FineTuningJobCheckpoint dizisi		Evet
ilk_kimlik	dize veya null		Hayı
daha_fazla	Boolean		Evet
son_kimlik	dize veya null		Hayı
nesne	enum	Olası değerler: `list`	Evet

OpenAI.ListFineTuningJobEventsResponse

İsim	Türü	Description	Gerekli
veriler	OpenAI.FineTuningJobEvent dizisi		Evet
daha_fazla	Boolean		Evet
nesne	enum	Olası değerler: `list`	Evet

OpenAI.ListMessagesResponse

İsim	Türü	Gerekli
veriler	OpenAI.MessageObject dizisi	Evet
ilk_kimlik	String	Evet
daha_fazla	Boolean	Evet
son_kimlik	String	Evet
nesne	String	Evet

OpenAI.ListModelsResponse

İsim	Türü	Description	Gerekli	Varsayılan
veriler	OpenAI.Model dizisi		Evet
nesne	enum	Olası değerler: `list`	Evet

OpenAI.ListPaginatedFineTuningJobsResponse

İsim	Türü	Description	Gerekli
veriler	OpenAI.FineTuningJob dizisi		Evet
daha_fazla	Boolean		Evet
nesne	enum	Olası değerler: `list`	Evet

OpenAI.ListRunStepsResponse

İsim	Türü	Gerekli
veriler	OpenAI.RunStepObject dizisi	Evet
ilk_kimlik	String	Evet
daha_fazla	Boolean	Evet
son_kimlik	String	Evet
nesne	String	Evet

OpenAI.ListRunsResponse

İsim	Türü	Gerekli
veriler	OpenAI.RunObject dizisi	Evet
ilk_kimlik	String	Evet
daha_fazla	Boolean	Evet
son_kimlik	String	Evet
nesne	String	Evet

OpenAI.ListVectorStoreFilesResponse

İsim	Türü	Gerekli
veriler	OpenAI.VectorStoreFileObject dizisi	Evet
ilk_kimlik	String	Evet
daha_fazla	Boolean	Evet
son_kimlik	String	Evet
nesne	String	Evet

OpenAI.ListVectorStoresResponse

İsim	Türü	Gerekli
veriler	OpenAI.VectorStoreObject dizisi	Evet
ilk_kimlik	String	Evet
daha_fazla	Boolean	Evet
son_kimlik	String	Evet
nesne	String	Evet

OpenAI.LocalShellCallStatus

Mülkiyet	Değer
Türü	String
Değerler	`in_progress` `completed` `incomplete`

OpenAI.LocalShellExecAction

Sunucuda bir komut satırı komutunu çalıştır.

İsim	Türü	Description	Gerekli
komut	dize dizisi	Çalıştırılacak komut.	Evet
env	nesne	Komutu için ayarlanacağı ortam değişkenleri.	Evet
zaman_aşımı_ms	tamsayı veya null		Hayı
type	enum	Yerel kabuk eyleminin türü. Her zaman `exec`. Olası değerler: `exec`	Evet
user	dize veya null		Hayı
çalışma_dizini	dize veya null		Hayı

OpenAI.LocalShellToolParam

Modelin yerel bir ortamda kabuk komutlarını yürütmesine izin veren bir araç.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Yerel kabuk aracının türü. Her zaman `local_shell`. Olası değerler: `local_shell`	Evet

OpenAI.LogProb

Belirtecin logaritmik olasılığı.

İsim	Türü	Gerekli
bytes	tamsayı dizisi	Evet
logprob	Numara	Evet
token	String	Evet
top_logprobs	OpenAI.TopLogProb dizisi	Evet

OpenAI.MCPListToolsTool

MCP sunucusunda kullanılabilen bir araç.

İsim	Türü	Description	Gerekli
Açıklamalar	OpenAI.MCPListToolsToolAnnotations veya null		Hayı
açıklama	dize veya null		Hayı
input_schema	OpenAI.MCPListToolsToolInputSchema		Evet
name	String	Araç adı.	Evet

OpenAI.MCPListToolsToolAnnotations

Tür: nesne

OpenAI.MCPListToolsToolInputSchema

Tür: nesne

OpenAI.MCPTool

Modele uzak Model Bağlam Protokolü (MCP) sunucuları aracılığıyla ek araçlara erişim verin. MCP.

İsim	Türü	Description	Gerekli
izin verilen araçlar	dize dizisi veya OpenAI.MCPToolFilter veya null		Hayı
yetkilendirme	String	Uzak bir MCP sunucusuyla kullanılabilen bir OAuth access token, şu iki özel bir MCP sunucu URL'si veya hizmet bağlayıcısı ile. Uygulamanız OAuth yetkilendirme akışını işlemesi ve belirteci burada sağlaması gerekir.	Hayı
connector_id	enum	ChatGPT'de bulunanlara benzer hizmet bağlayıcıları için tanımlayıcı. Bunlardan biri `server_url` veya `connector_id` sağlanmalıdır. Hizmet hakkında daha fazla bilgi edinin Bağlayıcılar burada. Şu anda desteklenen `connector_id` değerler şunlardır: -Dropbox: `connector_dropbox` -Gmail: `connector_gmail` - Google Takvim: `connector_googlecalendar` - Google Drive: `connector_googledrive` - Microsoft Teams: `connector_microsoftteams` - Outlook Takvimi: `connector_outlookcalendar` - Outlook E-postası: `connector_outlookemail` -Sharepoint: `connector_sharepoint` Olası değerler: `connector_dropbox`, `connector_gmail`, `connector_googlecalendar`, `connector_googledrive`, `connector_microsoftteams`, `connector_outlookcalendar`, `connector_outlookemail`, `connector_sharepoint`	Hayı
headers	object veya null		Hayı
onay_gerektir	OpenAI.MCPToolRequireApproval veya dize veya null		Hayı
server_description	String	MCP sunucusunun isteğe bağlı açıklaması, daha fazla bağlam sağlamak için kullanılır.	Hayı
sunucu etiketi	String	Bu MCP sunucusu için araç çağrılarında tanımlamak için kullanılan bir etiket.	Evet
sunucu_url	String	MCP sunucusunun URL'si. `server_url` Bunlardan biri veya `connector_id` olması gerekir Sağlanan.	Hayı
type	enum	MCP aracının türü. Her zaman `mcp`. Olası değerler: `mcp`	Evet

OpenAI.MCPToolCallStatus

Mülkiyet	Değer
Türü	String
Değerler	`in_progress` `completed` `incomplete` `calling` `failed`

OpenAI.MCPToolFilter

Hangi araçların izin verildiğini belirtmek için bir filtre nesnesi.

İsim	Türü	Description	Gerekli	Varsayılan
read_only	Boolean	Bir aracın veriyi değiştirip değiştirmediğini veya sadece okunabilir olup olmadığını gösterir. Bir MCP sunucusuna ile `readOnlyHint`ek açıklama eklenir. bu filtreyle eşleşecektir.	Hayı
tool_names	dize dizisi	İzin verilen araç adlarının listesi.	Hayı

OpenAI.MCPToolRequireApproval

İsim	Türü	Description	Gerekli	Varsayılan
always	OpenAI.MCPToolFilter	Hangi araçların izin verildiğini belirtmek için bir filtre nesnesi.	Hayı
hiç	OpenAI.MCPToolFilter	Hangi araçların izin verildiğini belirtmek için bir filtre nesnesi.	Hayı

OpenAI.MessageContent

OpenAI.MessageContent için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
`image_url`	OpenAI.MessageContentImageUrlObject
`text`	OpenAI.MessageContentTextObject
`refusal`	OpenAI.MessageContentRefusalObject

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.MessageContentType		Evet

OpenAI.MessageContentImageFileObject

İletinin içeriğindeki bir görüntü Dosyasına başvurur.

İsim	Türü	Description	Gerekli	Varsayılan
image_file	OpenAI.MessageContentImageFileObjectImageFile		Evet
type	enum	Her zaman `image_file`. Olası değerler: `image_file`	Evet

OpenAI.MessageContentImageFileObjectImageFile

İsim	Türü	Description	Gerekli	Varsayılan
detail	enum	Olası değerler: `auto`, `low`, `high`	Hayı
dosya_kimlik	String		Evet

OpenAI.MessageContentImageUrlObject

İletinin içeriğindeki bir resim URL'sine başvurur.

İsim	Türü	Description	Gerekli	Varsayılan
image_url	OpenAI.MessageContentImageUrlObjectImageUrl		Evet
type	enum	İçerik bölümünün türü. Olası değerler: `image_url`	Evet

OpenAI.MessageContentImageUrlObjectImageUrl

İsim	Türü	Description	Gerekli	Varsayılan
detail	enum	Olası değerler: `auto`, `low`, `high`	Hayı
url	String		Evet

OpenAI.MessageContentRefusalObject

Yardımcı tarafından oluşturulan reddetme içeriği.

İsim	Türü	Description	Gerekli	Varsayılan
Ret	String		Evet
type	enum	Her zaman `refusal`. Olası değerler: `refusal`	Evet

OpenAI.MessageContentTextAnnotationsFileCitationObject

İletinin içinde, yardımcıyla veya iletiyle ilişkilendirilmiş belirli bir Dosyadan belirli bir alıntıya işaret eden alıntı. Yardımcı dosyaları aramak için "file_search" aracını kullandığında oluşturulur.

İsim	Türü	Description	Gerekli
end_index	tamsayı	Kısıtlamalar: dk: 0	Evet
file_citation	OpenAI.MessageContentTextAnnotationsFileCitationObjectFileCitation		Evet
start_index	tamsayı	Kısıtlamalar: dk: 0	Evet
text	String	İleti içeriğindeki değiştirilmesi gereken metin.	Evet
type	enum	Her zaman `file_citation`. Olası değerler: `file_citation`	Evet

OpenAI.MessageContentTextAnnotationsFileCitationObjectFileCitation

İsim	Türü	Description	Gerekli	Varsayılan
dosya_kimlik	String		Evet

OpenAI.MessageContentTextAnnotationsFilePathObject

Yardımcı bir dosya oluşturmak için aracı kullandığında code_interpreter oluşturulan dosyanın URL'si.

İsim	Türü	Description	Gerekli
end_index	tamsayı	Kısıtlamalar: dk: 0	Evet
file_path	OpenAI.MessageContentTextAnnotationsFilePathObjectFilePath		Evet
start_index	tamsayı	Kısıtlamalar: dk: 0	Evet
text	String	İleti içeriğindeki değiştirilmesi gereken metin.	Evet
type	enum	Her zaman `file_path`. Olası değerler: `file_path`	Evet

OpenAI.MessageContentTextAnnotationsFilePathObjectFilePath

İsim	Türü	Description	Gerekli	Varsayılan
dosya_kimlik	String		Evet

OpenAI.MessageContentTextObject

İletinin parçası olan metin içeriği.

İsim	Türü	Description	Gerekli	Varsayılan
text	OpenAI.MessageContentTextObjectText		Evet
type	enum	Her zaman `text`. Olası değerler: `text`	Evet

OpenAI.MessageContentTextObjectText

İsim	Türü	Description	Gerekli	Varsayılan
Açıklamalar	OpenAI.TextAnnotation dizisi		Evet
değer	String		Evet

OpenAI.MessageContentType

Mülkiyet	Değer
Türü	String
Değerler	`image_file` `image_url` `text` `refusal`

OpenAI.MessageObject

İş parçacığı içindeki bir iletiyi temsil eder.

İsim	Türü	Description	Gerekli
assistant_id	dize veya null		Evet
attachments	OpenAI.MessageObjectAttachments dizisi veya null		Evet
tamamlanma_tarihi	dize veya null		Evet
içerik	OpenAI.MessageContent dizisi	İletinin metin ve/veya resim dizisi içindeki içeriği.	Evet
oluşturulma_tarihi	tamsayı	İletinin oluşturulduğu zaman için Unix zaman damgası (saniye olarak).	Evet
kimlik	String	API uç noktalarında başvurulabilen tanımlayıcı.	Evet
incomplete_at	dize veya null		Evet
incomplete_details	OpenAI.MessageObjectIncompleteDetails veya null		Evet
metadata	OpenAI.Metadata veya null		Evet
nesne	enum	Her zaman `thread.message`olan nesne türü. Olası değerler: `thread.message`	Evet
role	enum	İletiyi oluşturan varlık. `user` veya `assistant`'den biri. Olası değerler: `user`, `assistant`	Evet
run_id	dize veya null		Evet
durum	enum	İletinin durumu , veya `in_progress`olabilir`incompletecompleted`. Olası değerler: `in_progress`, `incomplete`, `completed`	Evet
thread_id	String	Bu iletinin ait olduğu iş parçacığı kimliği.	Evet

OpenAI.MessageObjectAttachments

İsim	Türü	Description	Gerekli	Varsayılan
dosya_kimlik	String		Hayı
araçlar	OpenAI.AssistantToolsCode veya OpenAI.AssistantToolsFileSearchTypeOnly dizisi		Hayı

OpenAI.MessageObjectIncompleteDetails

İsim	Türü	Description	Gerekli	Varsayılan
sebep	enum	Olası değerler: `content_filter`, `max_tokens`, `run_cancelled`, `run_expired`, `run_failed`	Evet

OpenAI.MessageRequestContentTextObject

İletinin parçası olan metin içeriği.

İsim	Türü	Description	Gerekli	Varsayılan
text	String	Modele gönderilecek metin içeriği	Evet
type	enum	Her zaman `text`. Olası değerler: `text`	Evet

OpenAI.MessageRole

Mülkiyet	Değer
Türü	String
Değerler	`unknown` `user` `assistant` `system` `critic` `discriminator` `developer` `tool`

OpenAI.MessageStatus

Mülkiyet	Değer
Türü	String
Değerler	`in_progress` `completed` `incomplete`

OpenAI.Metadata

Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, nesne hakkında ek bilgileri yapılandırılmış biçimde depolamak ve API veya pano aracılığıyla nesneleri sorgulamak için yararlı olabilir. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler, uzunluğu en fazla 512 karakter olan dizelerdir.

Tür: nesne

OpenAI.Model

API ile kullanılabilecek bir OpenAI model teklifini açıklar.

İsim	Türü	Description	Gerekli
created	tamsayı	Modelin oluşturulduğu Unix zaman damgası (saniye).	Evet
kimlik	String	API uç noktalarına başvurulabilen model tanımlayıcısı.	Evet
nesne	enum	Her zaman "model" olan nesne türü. Olası değerler: `model`	Evet
sahibi	String	Modelin sahibi olan kuruluş.	Evet

OpenAI.ModifyMessageRequest

İsim	Türü	Description	Gerekli	Varsayılan
metadata	OpenAI.Metadata veya null		Hayı

OpenAI.ModifyRunRequest

İsim	Türü	Description	Gerekli	Varsayılan
metadata	OpenAI.Metadata veya null		Hayı

OpenAI.ModifyThreadRequest

İsim	Türü	Description	Gerekli	Varsayılan
metadata	OpenAI.Metadata veya null		Hayı
tool_resources	OpenAI.ModifyThreadRequestToolResources veya null		Hayı

OpenAI.ModifyThreadRequestToolResources

İsim	Türü	Description	Gerekli	Varsayılan
code_interpreter	OpenAI.ModifyThreadRequestToolResourcesCodeInterpreter		Hayı
file_search	OpenAI.ModifyThreadRequestToolResourcesFileSearch		Hayı

OpenAI.ModifyThreadRequestToolResourcesCodeInterpreter

İsim	Türü	Description	Gerekli	Varsayılan
dosya_kimlikleri	dize dizisi		Hayı

OpenAI.ModifyThreadRequestToolResourcesFileSearch

İsim	Türü	Description	Gerekli	Varsayılan
vector_store_ids	dize dizisi		Hayı

OpenAI.Move

Fare hareket ettirme eylemi.

İsim	Türü	Description	Gerekli
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.NoiseReductionType

Gürültü azaltma türü. near_field kulaklık gibi yakın konuşan mikrofonlar için, far_field dizüstü bilgisayar veya konferans odası mikrofonları gibi uzak alan mikrofonları içindir.

Mülkiyet	Değer
Türü	String
Değerler	`near_field` `far_field`

OpenAI.OpenAIFile

nesnesi, File OpenAI'ye yüklenmiş bir belgeyi temsil eder.

İsim	Türü	Description	Gerekli
bytes	tamsayı	Dosyanın bayt cinsinden boyutu.	Evet
oluşturulma_tarihi	tamsayı	Dosyanın oluşturulduğu zaman için Unix zaman damgası (saniye olarak).	Evet
sona_erdigi_tarih	tamsayı	Dosyanın süresinin dolacağı zaman için Unix zaman damgası (saniye olarak).	Hayı
filename	String	Dosyanın adı.	Evet
kimlik	String	API uç noktalarında başvurulabilen dosya tanımlayıcısı.	Evet
nesne	enum	Her zaman `file`olan nesne türü. Olası değerler: `file`	Evet
purpose	enum	Dosyanın amaçlanan amacı. Desteklenen değerler , , `assistantsassistants_output`, `batchbatch_output` ve `fine-tune`değerleridir`fine-tune-results`. Olası değerler: `assistants`, `assistants_output`, `batch`, , `batch_output`, `fine-tune`, `fine-tune-results`, `evals`	Evet
durum	enum	Olası değerler: `uploaded`, `pending`, `running`, , `processed`, `error`, `deleting`, `deleted`	Evet
durum_detayları	dize (kullanım dışı)	Deprecated. Hassas ayarlama eğitim dosyasının doğrulamada neden başarısız olduğu hakkında ayrıntılı bilgi için üzerindeki `error`alanına bakın`fine_tuning.job`.	Hayı

OpenAI.OtherChunkingStrategyResponseParam

Bilinmeyen bir öbekleme stratejisi olduğunda bu döndürülür. Bunun nedeni genellikle dosyanın API'de kavram kullanılmadan önce chunking_strategy dizine eklenmiş olmasıdır.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Her zaman `other`. Olası değerler: `other`	Evet

OpenAI.OutputContent

OpenAI.OutputContent için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
`output_text`	OpenAI.OutputContentOutputTextContent
`refusal`	OpenAI.OutputContentRefusalContent

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.OutputContentType		Evet

OpenAI.OutputContentOutputTextContent

Modelden bir metin çıktısı.

İsim	Türü	Description	Gerekli
Açıklamalar	OpenAI.Annotation dizisi	Metin çıkışının ek açıklamaları.	Evet
logprobs	OpenAI.LogProb dizisi		Hayı
text	String	Modelden metin çıkışı.	Evet
type	enum	Çıkış metninin türü. Her zaman `output_text`. Olası değerler: `output_text`	Evet

OpenAI.OutputContentRefusalContent

Model tarafından reddedilme.

İsim	Türü	Description	Gerekli	Varsayılan
Ret	String	Modelin sunduğu reddetme gerekçesi.	Evet
type	enum	Reddetmenin türü. Her zaman `refusal`. Olası değerler: `refusal`	Evet

OpenAI.OutputContentType

Mülkiyet	Değer
Türü	String
Değerler	`output_text` `refusal` `reasoning_text`

OpenAI.OutputItem

OpenAI.OutputItem için Ayrıştırıcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
`output_message`	OpenAI.OutputItemOutputMessage
`file_search_call`	OpenAI.OutputItemFileSearchToolCall
`function_call`	OpenAI.OutputItemFunctionToolCall
`web_search_call`	OpenAI.OutputItemWebSearchToolCall
`computer_call`	OpenAI.OutputItemComputerToolCall
`reasoning`	OpenAI.OutputItemReasoningItem
`compaction`	OpenAI.OutputItemCompactionBody
`image_generation_call`	OpenAI.OutputItemImageGenToolCall
`code_interpreter_call`	OpenAI.OutputItemCodeInterpreterToolCall
`local_shell_call`	OpenAI.OutputItemLocalShellToolCall
`shell_call`	OpenAI.OutputItemFunctionShellCall
`shell_call_output`	OpenAI.OutputItemFunctionShellCallOutput
`apply_patch_call`	OpenAI.OutputItemApplyPatchToolCall
`apply_patch_call_output`	OpenAI.OutputItemApplyPatchToolCallOutput
`mcp_call`	OpenAI.OutputItemMcpToolCall
`mcp_list_tools`	OpenAI.OutputItemMcpListTools
`mcp_approval_request`	OpenAI.OutputItemMcpApprovalRequest
`custom_tool_call`	OpenAI.OutputItemCustomToolCall

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.OutputItemType		Evet

OpenAI.OutputItemApplyPatchToolCall

Dosya oluşturarak, silerek veya güncelleştirerek dosya farklarını uygulayan bir araç çağrısı.

İsim	Türü	Description	Gerekli
call_id	String	Model tarafından oluşturulan uygulama yama aracı çağrısının benzersiz kimliği.	Evet
Oluşturan	String	Bu araç çağrısını oluşturan varlığın kimliği.	Hayı
kimlik	String	Düzeltme eki uygulama aracı çağrısının benzersiz kimliği. Bu öğe, API aracılığıyla iade edildiğinde doldurulur.	Evet
Operasyon	OpenAI.ApplyPatchFileOperation	apply_patch aracılığıyla uygulanan create_file, delete_file veya update_file işlemlerinden biri.	Evet
└─ türü	OpenAI.ApplyPatchFileOperationType		Evet
durum	OpenAI.ApplyPatchCallStatus		Evet
type	enum	Öğenin türü. Her zaman `apply_patch_call`. Olası değerler: `apply_patch_call`	Evet

OpenAI.OutputItemApplyPatchToolCallOutput

Bir düzeltme eki uygulama aracı çağrısı tarafından yayılan çıkış.

İsim	Türü	Description	Gerekli
call_id	String	Model tarafından oluşturulan uygulama yama aracı çağrısının benzersiz kimliği.	Evet
Oluşturan	String	Bu aracı oluşturan varlığın kimliği çağrı çıktısı.	Hayı
kimlik	String	Düzeltme eki uygulama aracı çağrı çıkışının benzersiz kimliği. Bu öğe, API aracılığıyla iade edildiğinde doldurulur.	Evet
çıktı	dize veya null		Hayı
durum	OpenAI.ApplyPatchCallOutputStatus		Evet
type	enum	Öğenin türü. Her zaman `apply_patch_call_output`. Olası değerler: `apply_patch_call_output`	Evet

OpenAI.OutputItemCodeInterpreterToolCall

Kodu çalıştırmak için bir araç çağrısı.

İsim	Türü	Description	Gerekli
kod	dize veya null		Evet
container_id	String	Kodu çalıştırmak için kullanılan kapsayıcının kimliği.	Evet
kimlik	String	Kod yorumlayıcısı araç çağrısının benzersiz kimliği.	Evet
Çıktılar	OpenAI.CodeInterpreterOutputLogs dizisi veya OpenAI.CodeInterpreterOutputImage veya null		Evet
durum	enum	Kod yorumlayıcı aracı çağrısının durumu. Geçerli değerler : `in_progress`, `completed`, `incomplete`, `interpreting`ve `failed`. Olası değerler: `in_progress`, `completed`, `incomplete`, `interpreting`, `failed`	Evet
type	enum	Kod yorumlayıcı aracı çağrısının türü. Her zaman `code_interpreter_call`. Olası değerler: `code_interpreter_call`	Evet

OpenAI.OutputItemCompactionBody

API tarafından v1/responses/compactoluşturulan bir sıkıştırma öğesi.

İsim	Türü	Description	Gerekli
Oluşturan	String	Öğeyi oluşturan aktörün tanımlayıcısı.	Hayı
encrypted_content	String	Sıkıştırma tarafından oluşturulan şifrelenmiş içerik.	Evet
kimlik	String	Sıkıştırma öğesinin benzersiz kimliği.	Evet
type	enum	Öğenin türü. Her zaman `compaction`. Olası değerler: `compaction`	Evet

OpenAI.OutputItemComputerToolCall

Bilgisayar kullanım araçlarına bir araç komutu verme. Daha fazla bilgi için bilgisayar kullanım rehberi adresine bakınız.

İsim	Türü	Description	Gerekli
hareket	OpenAI.ComputerAction		Evet
call_id	String	Çıkış verisi ile araç çağrısına yanıt verirken kullanılan tanımlayıcı.	Evet
kimlik	String	Bilgisayar çağrısının benzersiz tanımlayıcısı.	Evet
pending_safety_checks	OpenAI.ComputerCallSafetyCheckParam dizisi	Bilgisayar çağrısı için bekleyen güvenlik denetimleri.	Evet
durum	enum	Öğenin durumu. `in_progress`, `completed`, veya bunlardan biri `incomplete`. Öğeler API aracılığıyla döndürülürken doldurulur. Olası değerler: `in_progress`, `completed`, `incomplete`	Evet
type	enum	Bilgisayar çağrısının türü. Her zaman `computer_call`. Olası değerler: `computer_call`	Evet

OpenAI.OutputItemCustomToolCall

Model tarafından oluşturulan özel bir araca çağrı.

İsim	Türü	Description	Gerekli
call_id	String	Bu özel araç çağrısını bir araç çağrısı çıktısına eşlemek için kullanılan bir tanımlayıcı.	Evet
kimlik	String	OpenAI platformundaki özel araç çağrısının benzersiz kimliği.	Hayı
girdi	String	Model tarafından oluşturulan özel araç çağrısı için girdi.	Evet
name	String	Çağrılan özel aracın adı.	Evet
type	enum	Özel araç çağrısının türü. Her zaman `custom_tool_call`. Olası değerler: `custom_tool_call`	Evet

OpenAI.OutputItemFileSearchToolCall

Dosya arama aracı çağrısının sonuçları. Daha fazla bilgi için dosya arama rehberi adresine bakınız.

İsim	Türü	Description	Gerekli
kimlik	String	Dosya arama aracı çağrısının benzersiz kimliği.	Evet
queries	dize dizisi	Dosyaları aramak için kullanılan sorgular.	Evet
results	OpenAI.FileSearchToolCallResults veya null dizisi		Hayı
durum	enum	Dosya arama aracı çağrısının durumu. Bunlardan biri `in_progress` `searching`, `incomplete` veya `failed`, Olası değerler: `in_progress`, `searching`, `completed`, `incomplete`, `failed`	Evet
type	enum	Dosya arama aracı çağrısının türü. Her zaman `file_search_call`. Olası değerler: `file_search_call`	Evet

OpenAI.OutputItemFunctionShellCall

Yönetilen bir ortamda bir veya daha fazla kabuk komutu yürüten bir araç çağrısı.

İsim	Türü	Description	Gerekli
hareket	OpenAI.FunctionShellAction	Bir kabuk komutu yürütür.	Evet
└─ komutları	dize dizisi		Evet
└─ max_output_length	tamsayı veya null		Evet
└─ timeout_ms	tamsayı veya null		Evet
call_id	String	Model tarafından oluşturulan shell araç çağrısının benzersiz kimliği.	Evet
Oluşturan	String	Bu araç çağrısını oluşturan varlığın kimliği.	Hayı
kimlik	String	Kabuk aracı çağrısının benzersiz kimliği. Bu öğe, API aracılığıyla iade edildiğinde doldurulur.	Evet
durum	OpenAI.LocalShellCallStatus		Evet
type	enum	Öğenin türü. Her zaman `shell_call`. Olası değerler: `shell_call`	Evet

OpenAI.OutputItemFunctionShellCallOutput

Yayılan bir kabuk aracı çağrısının çıktısı.

İsim	Türü	Description	Gerekli
call_id	String	Model tarafından oluşturulan shell araç çağrısının benzersiz kimliği.	Evet
Oluşturan	String	Öğeyi oluşturan aktörün tanımlayıcısı.	Hayı
kimlik	String	Kabuk çağrısı çıkışının benzersiz kimliği. Bu öğe, API aracılığıyla iade edildiğinde doldurulur.	Evet
max_output_length	tamsayı veya null		Evet
çıktı	OpenAI.FunctionShellCallOutputContent dizisi	Kabuk çağrısı çıkış içeriği dizisi	Evet
type	enum	Kabuk çağrısı çıkışının türü. Her zaman `shell_call_output`. Olası değerler: `shell_call_output`	Evet

OpenAI.OutputItemFunctionToolCall

Bir fonksiyonu çalıştırmak için bir araç çağrısı. Daha fazla bilgi için function çağrı rehberi adresine bakınız.

İsim	Türü	Description	Gerekli
arguments	String	İşleve geçirecek bağımsız değişkenlerin JSON dizesi.	Evet
call_id	String	Model tarafından oluşturulan işlev aracı çağrısının benzersiz kimliği.	Evet
kimlik	String	İşlev aracı çağrısının benzersiz kimliği.	Hayı
name	String	Çalıştırılacak işlevin adı.	Evet
durum	enum	Öğenin durumu. `in_progress`, `completed`, veya bunlardan biri `incomplete`. Öğeler API aracılığıyla döndürülürken doldurulur. Olası değerler: `in_progress`, `completed`, `incomplete`	Hayı
type	enum	İşlev aracı çağrısının türü. Her zaman `function_call`. Olası değerler: `function_call`	Evet

OpenAI.OutputItemImageGenToolCall

Model tarafından yapılan bir görüntü oluşturma isteği.

İsim	Türü	Description	Gerekli
kimlik	String	Görüntü oluşturma çağrısının benzersiz kimliği.	Evet
sonuç	dize veya null		Evet
durum	enum	Görüntü oluşturma çağrısının durumu. Olası değerler: `in_progress`, `completed`, `generating`, `failed`	Evet
type	enum	Görüntü oluşturma çağrısının türü. Her zaman `image_generation_call`. Olası değerler: `image_generation_call`	Evet

OpenAI.OutputItemLocalShellToolCall

Yerel kabukta komut çalıştırmak için bir araç çağrısı.

İsim	Türü	Description	Gerekli
hareket	OpenAI.LocalShellExecAction	Sunucuda bir komut satırı komutunu çalıştır.	Evet
call_id	String	Model tarafından oluşturulan yerel kabuk aracı çağrısının benzersiz kimliği.	Evet
kimlik	String	Yerel shell çağrısının benzersiz kimliği.	Evet
durum	enum	Yerel shell çağrısının durumu. Olası değerler: `in_progress`, `completed`, `incomplete`	Evet
type	enum	Yerel shell call'ın türü. Her zaman `local_shell_call`. Olası değerler: `local_shell_call`	Evet

OpenAI.OutputItemMcpApprovalRequest

Bir araç çağrısı işlemi için insan onayı isteği.

İsim	Türü	Description	Gerekli
arguments	String	Araç için bir JSON bağımsız değişken dizesi.	Evet
kimlik	String	Onay talebinin benzersiz kimliği.	Evet
name	String	Çalıştırılacak aracın adı.	Evet
sunucu etiketi	String	İsteği yapan MCP sunucusunun etiketi.	Evet
type	enum	Öğenin türü. Her zaman `mcp_approval_request`. Olası değerler: `mcp_approval_request`	Evet

OpenAI.OutputItemMcpListTools

MCP sunucusunda kullanılabilen araçların listesi.

İsim	Türü	Description	Gerekli
hata	dize veya null		Hayı
kimlik	String	Listenin benzersiz kimliği.	Evet
sunucu etiketi	String	MCP sunucusunun etiketi.	Evet
araçlar	OpenAI.MCPListToolsTool dizisi	Sunucuda bulunan araçlar.	Evet
type	enum	Öğenin türü. Her zaman `mcp_list_tools`. Olası değerler: `mcp_list_tools`	Evet

OpenAI.OutputItemMcpToolCall

MCP sunucusundaki bir aracın çağrılması.

İsim	Türü	Description	Gerekli
approval_request_id	dize veya null		Hayı
arguments	String	Araca geçirilen bağımsız değişkenlerin JSON dizesi.	Evet
hata	dize veya null		Hayı
kimlik	String	Araç çağrısının benzersiz kimliği.	Evet
name	String	Çalıştırılan aracın adı.	Evet
çıktı	dize veya null		Hayı
sunucu etiketi	String	Aracı çalıştıran MCP sunucusunun etiketi.	Evet
durum	OpenAI.MCPToolCallStatus		Hayı
type	enum	Öğenin türü. Her zaman `mcp_call`. Olası değerler: `mcp_call`	Evet

OpenAI.OutputItemOutputMessage

Modelden bir çıkış iletisi.

İsim	Türü	Description	Gerekli
içerik	OpenAI.OutputMessageContent dizisi	Çıkış iletisinin içeriği.	Evet
kimlik	String	Çıkış iletisinin benzersiz kimliği.	Evet
role	enum	Çıkış iletisinin rolü. Her zaman `assistant`. Olası değerler: `assistant`	Evet
durum	enum	İleti girişinin durumu. `in_progress`, `completed`, veya bunlardan biri `incomplete`. API aracılığıyla giriş öğeleri döndürüldüğünde doldurulur. Olası değerler: `in_progress`, `completed`, `incomplete`	Evet
type	enum	Çıkış iletisinin türü. Her zaman `message`. Olası değerler: `output_message`	Evet

OpenAI.OutputItemReasoningItem

İsim	Türü	Description	Gerekli
içerik	OpenAI.ReasoningTextContent dizisi	Metin içeriğini akıl yürütme.	Hayı
encrypted_content	dize veya null		Hayı
kimlik	String	Akıl yürütme içeriğinin benzersiz tanımlayıcısı.	Evet
durum	enum	Öğenin durumu. `in_progress`, `completed`, veya bunlardan biri `incomplete`. Öğeler API aracılığıyla döndürülürken doldurulur. Olası değerler: `in_progress`, `completed`, `incomplete`	Hayı
summary	OpenAI.Summary dizisi	Akıl yürütme özeti içeriği.	Evet
type	enum	Nesnenin türü. Her zaman `reasoning`. Olası değerler: `reasoning`	Evet

OpenAI.OutputItemType

Mülkiyet	Değer
Türü	String
Değerler	`output_message` `file_search_call` `function_call` `web_search_call` `computer_call` `reasoning` `compaction` `image_generation_call` `code_interpreter_call` `local_shell_call` `shell_call` `shell_call_output` `apply_patch_call` `apply_patch_call_output` `mcp_call` `mcp_list_tools` `mcp_approval_request` `custom_tool_call`

OpenAI.OutputItemWebSearchToolCall

Bir web arama aracı çağrısının sonuçları. Daha fazla bilgi için web arama rehberi adresine bakınız.

İsim	Türü	Description	Gerekli
hareket	OpenAI.WebSearchActionSearch veya OpenAI.WebSearchActionOpenPage veya OpenAI.WebSearchActionFind	Bu web arama çağrısında gerçekleştirilen belirli eylemi açıklayan bir nesne. Modelin web'i nasıl kullandığına ilişkin ayrıntıları içerir (arama, open_page, bulma).	Evet
kimlik	String	Web arama aracının benzersiz kimliği çağrı.	Evet
durum	enum	Web arama aracı çağrısının durumu. Olası değerler: `in_progress`, `searching`, `completed`, `failed`	Evet
type	enum	Web arama aracının türü. Her zaman `web_search_call`. Olası değerler: `web_search_call`	Evet

OpenAI.OutputMessageContent

OpenAI.OutputMessageContent için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
`output_text`	OpenAI.OutputMessageContentOutputTextContent
`refusal`	OpenAI.OutputMessageContentRefusalContent

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.OutputMessageContentType		Evet

OpenAI.OutputMessageContentOutputTextContent

Modelden bir metin çıktısı.

İsim	Türü	Description	Gerekli
Açıklamalar	OpenAI.Annotation dizisi	Metin çıkışının ek açıklamaları.	Evet
logprobs	OpenAI.LogProb dizisi		Hayı
text	String	Modelden metin çıkışı.	Evet
type	enum	Çıkış metninin türü. Her zaman `output_text`. Olası değerler: `output_text`	Evet

OpenAI.OutputMessageContentRefusalContent

Model tarafından reddedilme.

İsim	Türü	Description	Gerekli	Varsayılan
Ret	String	Modelin sunduğu reddetme gerekçesi.	Evet
type	enum	Reddetmenin türü. Her zaman `refusal`. Olası değerler: `refusal`	Evet

OpenAI.OutputMessageContentType

Mülkiyet	Değer
Türü	String
Değerler	`output_text` `refusal`

OpenAI.OutputTextContent

Modelden bir metin çıktısı.

İsim	Türü	Description	Gerekli
Açıklamalar	OpenAI.Annotation dizisi	Metin çıkışının ek açıklamaları.	Evet
logprobs	OpenAI.LogProb dizisi		Hayı
text	String	Modelden metin çıkışı.	Evet
type	enum	Çıkış metninin türü. Her zaman `output_text`. Olası değerler: `output_text`	Evet

OpenAI.ParallelToolCalls

Araç kullanımı sırasında paralel işlev çağrısının etkinleştirilip etkinleştirilmeyileceği.

Tür: bool

OpenAI.PredictionContent

Yeniden oluşturulan bir metin dosyasının içeriği gibi statik tahmin edilen çıkış içeriği.

İsim	Türü	Description	Gerekli	Varsayılan
içerik	OpenAI.ChatCompletionRequestMessageContentPartText dizesi veya dizisi	Model yanıtı oluşturulurken eşleşmesi gereken içerik. Oluşturulan belirteçler bu içerikle eşleşirse tüm model yanıtı çok daha hızlı döndürülebilir.	Evet
type	enum	Sağlamak istediğiniz tahmin edilen içeriğin türü. Bu tür şu anda her zaman `content`. Olası değerler: `content`	Evet

OpenAI.Prompt

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

İsim	Türü	Description	Gerekli
kimlik	String	Kullanılacak istem şablonunun benzersiz tanımlayıcısı.	Evet
değişkenler	OpenAI.ResponsePromptVariables veya null		Hayı
version	dize veya null		Hayı

OpenAI.RankerVersionType

Mülkiyet	Değer
Türü	String
Değerler	`auto` `default-2024-11-15`

OpenAI.RankingOptions

İsim	Türü	Description	Gerekli
hybrid_search	OpenAI.HybridSearchOptions		Hayı
└─ embedding_weight	Numara	Karşılıklı sıralama füzyonundaki gömülen ağırlığı.	Evet
└─ text_weight	Numara	Karşılıklı sıralama birleşimindeki metnin ağırlığı.	Evet
sıralayıcı	OpenAI.RankerVersionType		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.RealtimeAudioFormats

OpenAI.RealtimeAudioFormats 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
`audio/pcm`	OpenAI.RealtimeAudioFormatsAudioPcm
`audio/pcmu`	OpenAI.RealtimeAudioFormatsAudioPcmu
`audio/pcma`	OpenAI.RealtimeAudioFormatsAudioPcma

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.RealtimeAudioFormatsType		Evet

OpenAI.RealtimeAudioFormatsAudioPcm

İsim	Türü	Description	Gerekli	Varsayılan
oran	enum	Olası değerler: `24000`	Hayı
type	enum	Olası değerler: `audio/pcm`	Evet

OpenAI.RealtimeAudioFormatsAudioPcma

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olası değerler: `audio/pcma`	Evet

OpenAI.RealtimeAudioFormatsAudioPcmu

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olası değerler: `audio/pcmu`	Evet

OpenAI.RealtimeAudioFormatsType

Mülkiyet	Değer
Türü	String
Değerler	`audio/pcm` `audio/pcmu` `audio/pcma`

OpenAI.RealtimeCallCreateRequest

İsim	Türü	Description	Gerekli	Varsayılan
Sdp	String	Arayan tarafından oluşturulan WebRTC Oturum Açıklaması Protokolü (SDP) teklifi.	Evet
oturum	OpenAI.RealtimeSessionCreateRequestGA	Gerçek zamanlı oturum nesnesi yapılandırması.	Hayı
└─ ses	OpenAI.RealtimeSessionCreateRequestGAAudio	Giriş ve çıkış sesi yapılandırması.	Hayı
└─ include	dize dizisi	Sunucu çıkışlarına eklenecek ek alanlar. `item.input_audio_transcription.logprobs`: Giriş ses transkripsiyonu için logprobs ekleyin.	Hayı
└─ yönerge	String	Varsayılan sistem talimatları (sistem iletisi), model çağrılarına önceden eklenir. Bu alan, istemcinin istenen yanıtlarda modele yol göstermesine olanak tanır. Modele yanıt içeriği ve biçimi (örneğin "son derece kısa", "harekete geçin", "iyi yanıt örnekleri verilmiştir" gibi) ve ses davranışı (örneğin" hızlı konuşma", "sesinize duygu ekleme", "sık sık gülme") hakkında bilgi verilebilir. Yönergelerin model tarafından takip edilmesi garanti değildir, ancak istenen davranışla ilgili modele rehberlik sağlar. Sunucunun, bu alan ayarlanmamışsa kullanılacak varsayılan talimatları belirlediğini ve oturumun başında olayda görüneceğini `session.created` unutmayın.	Hayı
└─ maksimum_çıkış_jetonları	integer (aşağıdaki geçerli modellere bakın)	Tek bir yardımcı yanıtı için en fazla çıkış belirteci sayısı, araç çağrıları dahil. 1 ile 4096 arasında bir tamsayı sağlayın çıkış belirteçlerini sınırlama veya `inf` bir verilen model. Varsayılan olarak `inf` değerini alır.	Hayı
└─ modeli	String	Bu oturum için kullanılan Gerçek zamanlı model.	Hayı
└─ output_modalities	dize dizisi	Modelin yanıt verebileceği modalite kümesi. Varsayılan olarak `["audio"]`öğesini belirtir. modelin ses ve transkript ile yanıt vermesini sağlayın. `["text"]` yapmak için kullanılabilir model yalnızca metinle yanıt verir. Hem hem de `textaudio` aynı anda istekte bulunmak mümkün değildir.	Hayı	['audio']
└─ istemi	OpenAI.Prompt	bir istem şablonuna ve değişkenlerine başvuru. Daha fazla bilgi edinin.	Hayı
└─ araç seçimi	OpenAI.ToolChoiceOptions veya OpenAI.ToolChoiceFunction veya OpenAI.ToolChoiceMCP	Modelin araçları seçme şekli. Dize modlarından birini sağlama veya belirli bir modu zorlama işlev/MCP aracı.	Hayı	otomatik
└─ araçları	OpenAI.RealtimeFunctionTool veya OpenAI.MCPTool dizisi	Modelde kullanılabilen araçlar.	Hayı
└─ izleme	string veya OpenAI.RealtimeSessionCreateRequestGATracing veya null	"" İzlemeyi devre dışı bırakmak için null olarak ayarlayın. Bir kez izleme bir oturum için etkinleştirilir, yapılandırma değiştirilemez. `auto` oturum için varsayılan değerlerle bir izleme oluşturur iş akışı adı, grup kimliği ve meta veriler.	Hayı	otomatik
└─ kısaltma	OpenAI.RealtimeTruncation	Konuşmadaki belirteç sayısı modelin giriş belirteci sınırını aştığında konuşma kesilir, yani iletiler (en eskisinden başlayarak) modelin bağlamında yer almayacaktır. En fazla 4.096 çıkış belirtecini içeren 32k bağlam modeli, kesme gerçekleşmeden önce bağlama yalnızca 28.224 belirteç içerebilir. İstemciler, belirteç kullanımını ve maliyetini denetlemenin etkili bir yolu olan daha düşük bir maksimum belirteç sınırıyla kesilme davranışını yapılandırabilir. İletiler bağlamın başından bırakıldığından, kesme işlemi bir sonraki dönüşte önbelleğe alınmış belirteç sayısını azaltır (önbelleği daraltma). Bununla birlikte, istemciler iletileri en büyük bağlam boyutunun bir bölümüne kadar saklayacak şekilde kesmeyi de yapılandırabilir; bu da gelecekteki kesmelere olan ihtiyacı azaltır ve böylece önbellek hızını artırır. Kesme tamamen devre dışı bırakılabilir, yani sunucu hiçbir zaman kesilmez, ancak konuşma modelin giriş belirteci sınırını aşarsa hata döndürür.	Hayı
└─ türü	enum	Oluşturulacak oturum türü. Her zaman `realtime` Gerçek Zamanlı API için. Olası değerler: `realtime`	Evet

OpenAI.RealtimeCallReferRequest

Realtime API'sini kullanarak SIP çağrısını yeni bir hedefe aktarmak için gereken parametreler.

İsim	Türü	Description	Gerekli	Varsayılan
target_uri	String	SIP Refer-To üst bilgisinde görünmesi gereken URI. Gibi değerleri destekler `tel:+14155550123` veya `sip:agent\@example.com`.	Evet

OpenAI.RealtimeCallRejectRequest

Realtime API tarafından işlenen gelen SIP çağrısını reddetmek için kullanılan parametreler.

İsim	Türü	Description	Gerekli	Varsayılan
status_code	tamsayı	Arayana geri gönderilecek SIP yanıt kodu. Varsayılan değer : `603` (Reddet) atlandığında.	Hayı

OpenAI.RealtimeCreateClientSecretRequest

Realtime API için bir oturum ve istemci gizli dizisi oluşturun. İstek gerçek zamanlı veya transkripsiyon oturumu yapılandırması belirtebilir. Gerçek Zamanlı API hakkında daha fazla bilgi edinin.

İsim	Türü	Description	Gerekli	Varsayılan
sona_erdikten_sonra	OpenAI.RealtimeCreateClientSecretRequestExpiresAfter		Hayı
└─ tutturucu	enum	Olası değerler: `created_at`	Hayı
└─ saniye	tamsayı	Kısıtlamalar: dk: 10, maksimum: 7200	Hayı	600
oturum	OpenAI.RealtimeSessionCreateRequestUnion		Hayı
└─ türü	OpenAI.RealtimeSessionCreateRequestUnionType		Evet

OpenAI.RealtimeCreateClientSecretRequestExpiresAfter

İsim	Türü	Description	Gerekli	Varsayılan
anchor	enum	Olası değerler: `created_at`	Hayı
saniye	tamsayı	Kısıtlamalar: dk: 10, maksimum: 7200	Hayı	600

OpenAI.RealtimeCreateClientSecretResponse

Gerçek Zamanlı API için oturum ve istemci gizli dizisi oluşturma yanıtı.

İsim	Türü	Description	Gerekli
sona_erdigi_tarih	tamsayı	İstemci gizli dizisi için süre sonu zaman damgası, dönem boyunca saniyeler içinde.	Evet
oturum	OpenAI.RealtimeSessionCreateResponseUnion		Evet
└─ türü	OpenAI.RealtimeSessionCreateResponseUnionType		Evet
değer	String	Oluşturulan istemci gizli anahtarı değeri.	Evet

OpenAI.RealtimeFunctionTool

İsim	Türü	Description	Gerekli
açıklama	String	Ne zaman ve nasıl yapılacağını gösteren yönergeler de dahil olmak üzere işlevin açıklaması çağrısı yapmak ve ararken kullanıcıya ne söyleyeceği konusunda rehberlik (herhangi bir şey varsa).	Hayı
name	String	İşlevin adı.	Hayı
parameters	OpenAI.RealtimeFunctionToolParameters		Hayı
type	enum	Aracın türü, örneğin. `function` Olası değerler: `function`	Hayı

OpenAI.RealtimeFunctionToolParameters

Tür: nesne

OpenAI.RealtimeSessionCreateRequest

Geçici anahtarla yeni bir gerçek zamanlı oturum yapılandırması. Anahtarlar için varsayılan TTL bir dakikadır.

İsim	Türü	Description	Gerekli	Varsayılan
client_secret	OpenAI.RealtimeSessionCreateRequestClientSecret		Evet
└─ sona_erme_tarihi	tamsayı		Evet
└─ değer	String		Evet
input_audio_format	String	Giriş sesinin biçimi. Seçenekler , `pcm16`veya `g711_ulaw`şeklindedir`g711_alaw`.	Hayı
input_audio_transcription	OpenAI.RealtimeSessionCreateRequestInputAudioTranscription		Hayı
└─ modeli	String		Hayı
instructions	String	Varsayılan sistem talimatları (sistem iletisi), model çağrılarına önceden eklenir. Bu alan, istemcinin istenen yanıtlarda modele yol göstermesine olanak tanır. Modele yanıt içeriği ve biçimi (örneğin "son derece kısa", "harekete geçin", "iyi yanıt örnekleri verilmiştir" gibi) ve ses davranışı (örneğin" hızlı konuşma", "sesinize duygu ekleme", "sık sık gülme") hakkında bilgi verilebilir. Yönergelerin model tarafından takip edilmesi garanti değildir, ancak istenen davranışla ilgili modele rehberlik sağlar. Sunucunun, bu alan ayarlanmamışsa kullanılacak varsayılan talimatları belirlediğini ve oturumun başında olayda görüneceğini `session.created` unutmayın.	Hayı
max_response_output_tokens	integer (aşağıdaki geçerli modellere bakın)	Tek bir yardımcı yanıtı için en fazla çıkış belirteci sayısı, araç çağrıları dahil. 1 ile 4096 arasında bir tamsayı sağlayın çıkış belirteçlerini sınırlama veya `inf` bir verilen model. Varsayılan olarak `inf` değerini alır.	Hayı
yöntemler	dize dizisi	Modelin yanıt verebileceği modalite kümesi. Sesi devre dışı bırakmak için bunu ["text"] olarak ayarlayın.	Hayı	['text', 'audio']
output_audio_format	String	Çıkış sesinin biçimi. Seçenekler , `pcm16`veya `g711_ulaw`şeklindedir`g711_alaw`.	Hayı
prompt	OpenAI.Prompt	bir istem şablonuna ve değişkenlerine başvuru. Daha fazla bilgi edinin.	Hayı
speed	Numara	Modelin konuşulan yanıtının hızı. 1.0 varsayılan hızdır. 0,25 en düşük hız. 1,5 maksimum hızdır. Bu değer yalnızca değiştirilebilir yanıt devam ederken değil model dönüşleri arasında. Kısıtlamalar: dk: 0,25, maksimum: 1,5	Hayı	1
sıcaklık	Numara	[0,6, 1,2] ile sınırlı olan model için örnekleme sıcaklığı. Varsayılan değer 0,8'tir.	Hayı
tool_choice	String	Modelin araçları seçme şekli. Seçenekler : `auto`, `none`, `required`veya bir işlev belirtin.	Hayı
araçlar	OpenAI.RealtimeSessionCreateRequestTools dizisi	Modelde kullanılabilen araçlar (işlevler).	Hayı
izleme	dize veya nesne	İzleme için yapılandırma seçenekleri. İzlemeyi devre dışı bırakmak için null olarak ayarlayın. Bir kez izleme bir oturum için etkinleştirilir, yapılandırma değiştirilemez. `auto` oturum için varsayılan değerlerle bir izleme oluşturur iş akışı adı, grup kimliği ve meta veriler.	Hayı
truncation	OpenAI.RealtimeTruncation	Konuşmadaki belirteç sayısı modelin giriş belirteci sınırını aştığında konuşma kesilir, yani iletiler (en eskisinden başlayarak) modelin bağlamında yer almayacaktır. En fazla 4.096 çıkış belirtecini içeren 32k bağlam modeli, kesme gerçekleşmeden önce bağlama yalnızca 28.224 belirteç içerebilir. İstemciler, belirteç kullanımını ve maliyetini denetlemenin etkili bir yolu olan daha düşük bir maksimum belirteç sınırıyla kesilme davranışını yapılandırabilir. İletiler bağlamın başından bırakıldığından, kesme işlemi bir sonraki dönüşte önbelleğe alınmış belirteç sayısını azaltır (önbelleği daraltma). Bununla birlikte, istemciler iletileri en büyük bağlam boyutunun bir bölümüne kadar saklayacak şekilde kesmeyi de yapılandırabilir; bu da gelecekteki kesmelere olan ihtiyacı azaltır ve böylece önbellek hızını artırır. Kesme tamamen devre dışı bırakılabilir, yani sunucu hiçbir zaman kesilmez, ancak konuşma modelin giriş belirteci sınırını aşarsa hata döndürür.	Hayı
turn_detection	OpenAI.RealtimeSessionCreateRequestTurnDetection		Hayı
└─ ön_ek_yastıklama_ms	tamsayı		Hayı
└─ sessizlik_süresi_ms	tamsayı		Hayı
└─ eşik	Numara		Hayı
└─ türü	String		Hayı
type	enum	Olası değerler: `realtime`	Evet
voice	OpenAI.VoiceIdsShared		Hayı

OpenAI.RealtimeSessionCreateRequestClientSecret

İsim	Türü	Description	Gerekli	Varsayılan
sona_erdigi_tarih	tamsayı		Evet
değer	String		Evet

OpenAI.RealtimeSessionCreateRequestGA

Gerçek zamanlı oturum nesnesi yapılandırması.

İsim	Türü	Description	Gerekli	Varsayılan
audio	OpenAI.RealtimeSessionCreateRequestGAAudio		Hayı
└─ giriş	OpenAI.RealtimeSessionCreateRequestGAAudioInput		Hayı
└─ çıkış	OpenAI.RealtimeSessionCreateRequestGAAudioOutput		Hayı
include	dize dizisi	Sunucu çıkışlarına eklenecek ek alanlar. `item.input_audio_transcription.logprobs`: Giriş ses transkripsiyonu için logprobs ekleyin.	Hayı
instructions	String	Varsayılan sistem talimatları (sistem iletisi), model çağrılarına önceden eklenir. Bu alan, istemcinin istenen yanıtlarda modele yol göstermesine olanak tanır. Modele yanıt içeriği ve biçimi (örneğin "son derece kısa", "harekete geçin", "iyi yanıt örnekleri verilmiştir" gibi) ve ses davranışı (örneğin" hızlı konuşma", "sesinize duygu ekleme", "sık sık gülme") hakkında bilgi verilebilir. Yönergelerin model tarafından takip edilmesi garanti değildir, ancak istenen davranışla ilgili modele rehberlik sağlar. Sunucunun, bu alan ayarlanmamışsa kullanılacak varsayılan talimatları belirlediğini ve oturumun başında olayda görüneceğini `session.created` unutmayın.	Hayı
max_output_tokens	integer (aşağıdaki geçerli modellere bakın)	Tek bir yardımcı yanıtı için en fazla çıkış belirteci sayısı, araç çağrıları dahil. 1 ile 4096 arasında bir tamsayı sağlayın çıkış belirteçlerini sınırlama veya `inf` bir verilen model. Varsayılan olarak `inf` değerini alır.	Hayı
model	String	Bu oturum için kullanılan Gerçek zamanlı model.	Hayı
çıkış modaliteleri	dize dizisi	Modelin yanıt verebileceği modalite kümesi. Varsayılan olarak `["audio"]`öğesini belirtir. modelin ses ve transkript ile yanıt vermesini sağlayın. `["text"]` yapmak için kullanılabilir model yalnızca metinle yanıt verir. Hem hem de `textaudio` aynı anda istekte bulunmak mümkün değildir.	Hayı	['audio']
prompt	OpenAI.Prompt	bir istem şablonuna ve değişkenlerine başvuru. Daha fazla bilgi edinin.	Hayı
tool_choice	OpenAI.ToolChoiceOptions veya OpenAI.ToolChoiceFunction veya OpenAI.ToolChoiceMCP	Modelin araçları seçme şekli. Dize modlarından birini sağlama veya belirli bir modu zorlama işlev/MCP aracı.	Hayı
araçlar	OpenAI.RealtimeFunctionTool veya OpenAI.MCPTool dizisi	Modelde kullanılabilen araçlar.	Hayı
izleme	string veya OpenAI.RealtimeSessionCreateRequestGATracing veya null	"" İzlemeyi devre dışı bırakmak için null olarak ayarlayın. Bir kez izleme bir oturum için etkinleştirilir, yapılandırma değiştirilemez. `auto` oturum için varsayılan değerlerle bir izleme oluşturur iş akışı adı, grup kimliği ve meta veriler.	Hayı
truncation	OpenAI.RealtimeTruncation	Konuşmadaki belirteç sayısı modelin giriş belirteci sınırını aştığında konuşma kesilir, yani iletiler (en eskisinden başlayarak) modelin bağlamında yer almayacaktır. En fazla 4.096 çıkış belirtecini içeren 32k bağlam modeli, kesme gerçekleşmeden önce bağlama yalnızca 28.224 belirteç içerebilir. İstemciler, belirteç kullanımını ve maliyetini denetlemenin etkili bir yolu olan daha düşük bir maksimum belirteç sınırıyla kesilme davranışını yapılandırabilir. İletiler bağlamın başından bırakıldığından, kesme işlemi bir sonraki dönüşte önbelleğe alınmış belirteç sayısını azaltır (önbelleği daraltma). Bununla birlikte, istemciler iletileri en büyük bağlam boyutunun bir bölümüne kadar saklayacak şekilde kesmeyi de yapılandırabilir; bu da gelecekteki kesmelere olan ihtiyacı azaltır ve böylece önbellek hızını artırır. Kesme tamamen devre dışı bırakılabilir, yani sunucu hiçbir zaman kesilmez, ancak konuşma modelin giriş belirteci sınırını aşarsa hata döndürür.	Hayı
type	enum	Oluşturulacak oturum türü. Her zaman `realtime` Gerçek Zamanlı API için. Olası değerler: `realtime`	Evet

OpenAI.RealtimeSessionCreateRequestGAAudio

İsim	Türü	Description	Gerekli	Varsayılan
girdi	OpenAI.RealtimeSessionCreateRequestGAAudioInput		Hayı
çıktı	OpenAI.RealtimeSessionCreateRequestGAAudioOutput		Hayı

OpenAI.RealtimeSessionCreateRequestGAAudioInput

İsim	Türü	Gerekli
format	OpenAI.RealtimeAudioFormats	Hayı
noise_reduction	OpenAI.RealtimeSessionCreateRequestGAAudioInputNoiseReduction	Hayı
Transkripsiyon	OpenAI.AudioTranscription	Hayı
turn_detection	OpenAI.RealtimeTurnDetection	Hayı

OpenAI.RealtimeSessionCreateRequestGAAudioInputNoiseReduction

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.NoiseReductionType	Gürültü azaltma türü. `near_field` kulaklık gibi yakın konuşan mikrofonlar için, `far_field` dizüstü bilgisayar veya konferans odası mikrofonları gibi uzak alan mikrofonları içindir.	Hayı

OpenAI.RealtimeSessionCreateRequestGAAudioOutput

İsim	Türü	Description	Gerekli	Varsayılan
format	OpenAI.RealtimeAudioFormats		Hayı
speed	Numara	Kısıtlamalar: dk: 0,25, maksimum: 1,5	Hayı	1
voice	OpenAI.VoiceIdsShared		Hayı

OpenAI.RealtimeSessionCreateRequestGATracing

İsim	Türü	Gerekli
group_id	String	Hayı
metadata	nesne	Hayı
workflow_name	String	Hayı

OpenAI.RealtimeSessionCreateRequestInputAudioTranscription

İsim	Türü	Description	Gerekli	Varsayılan
model	String		Hayı

OpenAI.RealtimeSessionCreateRequestTools

İsim	Türü	Description	Gerekli
açıklama	String		Hayı
name	String		Hayı
parameters	OpenAI.RealtimeSessionCreateRequestToolsParameters		Hayı
type	enum	Olası değerler: `function`	Hayı

OpenAI.RealtimeSessionCreateRequestToolsParameters

Tür: nesne

OpenAI.RealtimeSessionCreateRequestTurnDetection

İsim	Türü	Gerekli
prefix_padding_ms	tamsayı	Hayı
silence_duration_ms	tamsayı	Hayı
threshold	Numara	Hayı
type	String	Hayı

OpenAI.RealtimeSessionCreateRequestUnion

OpenAI.RealtimeSessionCreateRequestUnion 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
`realtime`	OpenAI.RealtimeSessionCreateRequest
`transcription`	OpenAI.RealtimeTranscriptionSessionCreateRequest

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.RealtimeSessionCreateRequestUnionType		Evet

OpenAI.RealtimeSessionCreateRequestUnionType

Mülkiyet	Değer
Türü	String
Değerler	`realtime` `transcription`

OpenAI.RealtimeSessionCreateResponse

Gerçek zamanlı oturum yapılandırma nesnesi.

İsim	Türü	Description	Gerekli
audio	OpenAI.RealtimeSessionCreateResponseAudio		Hayı
└─ giriş	OpenAI.RealtimeSessionCreateResponseAudioInput		Hayı
└─ çıkış	OpenAI.RealtimeSessionCreateResponseAudioOutput		Hayı
sona_erdigi_tarih	tamsayı	Oturum için süre sonu zaman damgası, dönem boyunca saniye olarak.	Hayı
kimlik	String	Gibi `sess_1234567890abcdef`görünen oturumun benzersiz tanımlayıcısı.	Hayı
include	dize dizisi	Sunucu çıkışlarına eklenecek ek alanlar. - `item.input_audio_transcription.logprobs`: Giriş ses transkripsiyonu için logprobs ekleyin.	Hayı
instructions	String	Varsayılan sistem yönergeleri (örn. sistem iletisi) modele eklenmiştir Aramalar. Bu alan, istemcinin modele istenen şekilde kılavuzluk etmesini sağlar Yanıt. Modele yanıt içeriği ve biçimi hakkında talimat veilebilir, (örneğin, "son derece özlü olun", "cana yakın davran", "aşağıda iyi örnekler verilmiştir yanıtlar") ve ses davranışında (örneğin "hızlı konuşma", "duygu ekleme" sesinize", "sık sık gül"). Yönergeler garanti değildir modeli takip etmek için, ancak modele istenen davranış. Sunucunun varsayılan yönergeleri ayarladığına dikkat edin. alanı ayarlanmadı ve `session.created` oturumunu başlatın.	Hayı
max_output_tokens	integer (aşağıdaki geçerli modellere bakın)	Tek bir yardımcı yanıtı için en fazla çıkış belirteci sayısı, araç çağrıları dahil. 1 ile 4096 arasında bir tamsayı sağlayın çıkış belirteçlerini sınırlama veya `inf` bir verilen model. Varsayılan olarak `inf` değerini alır.	Hayı
model	String	Bu oturum için kullanılan Gerçek zamanlı model.	Hayı
nesne	String	Nesne türü. Her zaman `realtime.session`.	Hayı
çıkış modaliteleri	dize dizisi	Modelin yanıt verebileceği modalite kümesi. Sesi devre dışı bırakmak için bunu ["text"] olarak ayarlayın.	Hayı
tool_choice	String	Modelin araçları seçme şekli. Seçenekler : `auto`, `none`, `required`veya bir işlev belirtin.	Hayı
araçlar	OpenAI.RealtimeFunctionTool dizisi	Modelde kullanılabilen araçlar (işlevler).	Hayı
izleme	dize veya nesne	İzleme için yapılandırma seçenekleri. İzlemeyi devre dışı bırakmak için null olarak ayarlayın. Bir kez izleme bir oturum için etkinleştirilir, yapılandırma değiştirilemez. `auto` oturum için varsayılan değerlerle bir izleme oluşturur iş akışı adı, grup kimliği ve meta veriler.	Hayı
turn_detection	OpenAI.RealtimeSessionCreateResponseTurnDetection		Hayı
└─ ön_ek_yastıklama_ms	tamsayı		Hayı
└─ sessizlik_süresi_ms	tamsayı		Hayı
└─ eşik	Numara		Hayı
└─ türü	String		Hayı
type	enum	Olası değerler: `realtime`	Evet

OpenAI.RealtimeSessionCreateResponseAudio

İsim	Türü	Description	Gerekli	Varsayılan
girdi	OpenAI.RealtimeSessionCreateResponseAudioInput		Hayı
çıktı	OpenAI.RealtimeSessionCreateResponseAudioOutput		Hayı

OpenAI.RealtimeSessionCreateResponseAudioInput

İsim	Türü	Gerekli
format	OpenAI.RealtimeAudioFormats	Hayı
noise_reduction	OpenAI.RealtimeSessionCreateResponseAudioInputNoiseReduction	Hayı
Transkripsiyon	OpenAI.AudioTranscription	Hayı
turn_detection	OpenAI.RealtimeSessionCreateResponseAudioInputTurnDetection	Hayı

OpenAI.RealtimeSessionCreateResponseAudioInputNoiseReduction

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.NoiseReductionType	Gürültü azaltma türü. `near_field` kulaklık gibi yakın konuşan mikrofonlar için, `far_field` dizüstü bilgisayar veya konferans odası mikrofonları gibi uzak alan mikrofonları içindir.	Hayı

OpenAI.RealtimeSessionCreateResponseAudioInputTurnDetection

İsim	Türü	Gerekli
prefix_padding_ms	tamsayı	Hayı
silence_duration_ms	tamsayı	Hayı
threshold	Numara	Hayı
type	String	Hayı

OpenAI.RealtimeSessionCreateResponseAudioOutput

İsim	Türü	Gerekli
format	OpenAI.RealtimeAudioFormats	Hayı
speed	Numara	Hayı
voice	OpenAI.VoiceIdsShared	Hayı

OpenAI.RealtimeSessionCreateResponseTurnDetection

İsim	Türü	Gerekli
prefix_padding_ms	tamsayı	Hayı
silence_duration_ms	tamsayı	Hayı
threshold	Numara	Hayı
type	String	Hayı

OpenAI.RealtimeSessionCreateResponseUnion

OpenAI.RealtimeSessionCreateResponseUnion 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
`realtime`	OpenAI.RealtimeSessionCreateResponse
`transcription`	OpenAI.RealtimeTranscriptionSessionCreateResponse

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.RealtimeSessionCreateResponseUnionType		Evet

OpenAI.RealtimeSessionCreateResponseUnionType

Mülkiyet	Değer
Türü	String
Değerler	`realtime` `transcription`

OpenAI.RealtimeTranscriptionSessionCreateRequest

Gerçek zamanlı transkripsiyon oturumu nesne yapılandırması.

İsim	Türü	Description	Gerekli
include	dize dizisi	Transkripsiyona eklenecek öğe kümesi. Geçerli kullanılabilir öğeler şunlardır: `item.input_audio_transcription.logprobs`	Hayı
input_audio_format	enum	Giriş sesinin biçimi. Seçenekler , `pcm16`veya `g711_ulaw`şeklindedir`g711_alaw`. için `pcm16`, giriş sesi 24 kHz örnek hızında 16 bit PCM olmalıdır, tek kanallı (mono) ve küçük endian bayt sırası. Olası değerler: `pcm16`, `g711_ulaw`, `g711_alaw`	Hayı
input_audio_noise_reduction	OpenAI.RealtimeTranscriptionSessionCreateRequestInputAudioNoiseReduction		Hayı
└─ türü	OpenAI.NoiseReductionType	Gürültü azaltma türü. `near_field` kulaklık gibi yakın konuşan mikrofonlar için, `far_field` dizüstü bilgisayar veya konferans odası mikrofonları gibi uzak alan mikrofonları içindir.	Hayı
input_audio_transcription	OpenAI.AudioTranscription		Hayı
└─ dili	String	Giriş sesinin dili. giriş dilini sağlama ISO-639-1 (ör. `en`) biçimi doğruluğu ve gecikme süresini artırır.	Hayı
└─ modeli	String	Transkripsiyon için kullanılacak model. Geçerli seçenekler : `whisper-1`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`ve `gpt-4o-transcribe-diarize`. Konuşmacı etiketleriyle diarizasyona ihtiyacınız olduğunda kullanın `gpt-4o-transcribe-diarize` .	Hayı
└─ istemi	String	Modelin stiline kılavuzluk etmek veya önceki bir sese devam etmek için isteğe bağlı bir metin Segment. için`whisper-1`, istem anahtar sözcüklerin listesidir. Modeller için `gpt-4o-transcribe` (hariç `gpt-4o-transcribe-diarize`), istem boş bir metin dizesidir, örneğin "teknolojiyle ilgili sözcükleri bekleme".	Hayı
turn_detection	OpenAI.RealtimeTranscriptionSessionCreateRequestTurnDetection		Hayı
└─ ön_ek_yastıklama_ms	tamsayı		Hayı
└─ sessizlik_süresi_ms	tamsayı		Hayı
└─ eşik	Numara		Hayı
└─ türü	enum	Olası değerler: `server_vad`	Hayı
type	enum	Olası değerler: `transcription`	Evet

OpenAI.RealtimeTranscriptionSessionCreateRequestInputAudioNoiseReduction

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.NoiseReductionType	Gürültü azaltma türü. `near_field` kulaklık gibi yakın konuşan mikrofonlar için, `far_field` dizüstü bilgisayar veya konferans odası mikrofonları gibi uzak alan mikrofonları içindir.	Hayı

OpenAI.RealtimeTranscriptionSessionCreateRequestTurnDetection

İsim	Türü	Description	Gerekli
prefix_padding_ms	tamsayı		Hayı
silence_duration_ms	tamsayı		Hayı
threshold	Numara		Hayı
type	enum	Olası değerler: `server_vad`	Hayı

OpenAI.RealtimeTranscriptionSessionCreateResponse

Yeni bir Gerçek zamanlı transkripsiyon oturumu yapılandırması. SUNUCUDA REST API aracılığıyla bir oturum oluşturulduğunda, oturum nesnesi kısa ömürlü bir anahtar da içerir. Anahtarlar için varsayılan TTL 10 dakikadır. WebSocket API'sini kullanarak bir oturum güncelleştirildiğinde bu özellik mevcut değildir.

İsim	Türü	Description	Gerekli
client_secret	OpenAI.RealtimeTranscriptionSessionCreateResponseClientSecret		Evet
└─ sona_erme_tarihi	tamsayı		Evet
└─ değer	String		Evet
input_audio_format	String	Giriş sesinin biçimi. Seçenekler , `pcm16`veya `g711_ulaw`şeklindedir`g711_alaw`.	Hayı
input_audio_transcription	OpenAI.AudioTranscription		Hayı
└─ dili	String	Giriş sesinin dili. giriş dilini sağlama ISO-639-1 (ör. `en`) biçimi doğruluğu ve gecikme süresini artırır.	Hayı
└─ modeli	String	Transkripsiyon için kullanılacak model. Geçerli seçenekler : `whisper-1`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`ve `gpt-4o-transcribe-diarize`. Konuşmacı etiketleriyle diarizasyona ihtiyacınız olduğunda kullanın `gpt-4o-transcribe-diarize` .	Hayı
└─ istemi	String	Modelin stiline kılavuzluk etmek veya önceki bir sese devam etmek için isteğe bağlı bir metin Segment. için`whisper-1`, istem anahtar sözcüklerin listesidir. Modeller için `gpt-4o-transcribe` (hariç `gpt-4o-transcribe-diarize`), istem boş bir metin dizesidir, örneğin "teknolojiyle ilgili sözcükleri bekleme".	Hayı
yöntemler	dize dizisi	Modelin yanıt verebileceği modalite kümesi. Sesi devre dışı bırakmak için bunu ["text"] olarak ayarlayın.	Hayı
turn_detection	OpenAI.RealtimeTranscriptionSessionCreateResponseTurnDetection		Hayı
└─ ön_ek_yastıklama_ms	tamsayı		Hayı
└─ sessizlik_süresi_ms	tamsayı		Hayı
└─ eşik	Numara		Hayı
└─ türü	String		Hayı
type	enum	Olası değerler: `transcription`	Evet

OpenAI.RealtimeTranscriptionSessionCreateResponseClientSecret

İsim	Türü	Description	Gerekli	Varsayılan
sona_erdigi_tarih	tamsayı		Evet
değer	String		Evet

OpenAI.RealtimeTranscriptionSessionCreateResponseTurnDetection

İsim	Türü	Gerekli
prefix_padding_ms	tamsayı	Hayı
silence_duration_ms	tamsayı	Hayı
threshold	Numara	Hayı
type	String	Hayı

OpenAI.RealtimeTruncation

Konuşmadaki belirteç sayısı modelin giriş belirteci sınırını aştığında konuşma kesilir, yani iletiler (en eskisinden başlayarak) modelin bağlamında yer almayacaktır. En fazla 4.096 çıkış belirtecini içeren 32k bağlam modeli, kesme gerçekleşmeden önce bağlama yalnızca 28.224 belirteç içerebilir. İstemciler, belirteç kullanımını ve maliyetini denetlemenin etkili bir yolu olan daha düşük bir maksimum belirteç sınırıyla kesilme davranışını yapılandırabilir. İletiler bağlamın başından bırakıldığından, kesme işlemi bir sonraki dönüşte önbelleğe alınmış belirteç sayısını azaltır (önbelleği daraltma). Bununla birlikte, istemciler iletileri en büyük bağlam boyutunun bir bölümüne kadar saklayacak şekilde kesmeyi de yapılandırabilir; bu da gelecekteki kesmelere olan ihtiyacı azaltır ve böylece önbellek hızını artırır. Kesme tamamen devre dışı bırakılabilir, yani sunucu hiçbir zaman kesilmez, ancak konuşma modelin giriş belirteci sınırını aşarsa hata döndürür.

Mülkiyet	Değer
Türü	String
Değerler	`auto` `disabled`

OpenAI.RealtimeTurnDetection

OpenAI.RealtimeTurnDetection 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	OpenAI.RealtimeTurnDetectionType		Evet

OpenAI.RealtimeTurnDetectionType

Tür: dize

OpenAI.Reasoning

Sadece GPT-5 ve O-serisi modelleri Akıl yürütme modelleri için yapılandırma seçenekleri.

İsim	Türü	Description	Gerekli
effort	OpenAI.ReasoningEffort	Akıl yürütmeye yönelik çabayı kısıtlar mantık modelleri. Şu anda desteklenen değerler `none`, `minimal`, `low`, `medium`, `high`, ve `xhigh`'dir. Azaltma muhakeme çabası daha hızlı yanıtlara ve daha az belirteç kullanılmasına neden olabilir bir yanıtta mantık yürütme. - `gpt-5.1` varsayılan olarak `none`öğesini kullanır ve mantık yürütmez. Desteklenen gerekçe değerleri `gpt-5.1none`, `low`, `medium`, ve `high`'dir. Araç çağrıları gpt-5.1'deki tüm akıl yürütme değerleri için desteklenir. - Tüm modeller varsayılan olarak akıl yürütme eforu olmadan `gpt-5.1` önce `medium` ve desteklemez`none`. - Model `gpt-5-pro` varsayılan olarak akıl yürütme eforunu kullanır (ve yalnızca destekler `high` ). - `xhigh` , sonrasındaki `gpt-5.1-codex-max`tüm modeller için desteklenir.	Hayı
generate_summary	dize veya null		Hayı
summary	dize veya null		Hayı

OpenAI.ReasoningEffort

Mantıp modelleri için mantık yürütme çabasını kısıtlar. Şu anda desteklenen değerler none, minimal, low, medium, high, ve xhigh'dir. Muhakeme çabasının azaltılması, yanıtta daha hızlı yanıtlar ve daha az belirteç kullanılmasına neden olabilir.

gpt-5.1 varsayılan olarak none, bu da akıl yürütme yapmaz. Desteklenen gerekçe değerleri gpt-5.1none, low, medium, ve high'dir. Araç çağrıları gpt-5.1'deki tüm akıl yürütme değerleri için desteklenir.
Önceki gpt-5.1 tüm modeller varsayılan olarak medium akıl yürütme çabasına geçer ve nonedesteklemez.
Model gpt-5-pro varsayılan olarak (ve sadece destekliyor) high akıl yürütme çabasını kullanır.
xhigh sonrası tüm modeller gpt-5.1-codex-maxiçin desteklenir.

Mülkiyet	Değer
Türü	String
Değerler	`none` `minimal` `low` `medium` `high` `xhigh`

OpenAI.ReasoningTextContent

Modelden mantık metni.

İsim	Türü	Description	Gerekli	Varsayılan
text	String	Modelden gelen mantık metni.	Evet
type	enum	Akıl yürütme metninin türü. Her zaman `reasoning_text`. Olası değerler: `reasoning_text`	Evet

OpenAI.RefusalContent

Model tarafından reddedilme.

İsim	Türü	Description	Gerekli	Varsayılan
Ret	String	Modelin sunduğu reddetme gerekçesi.	Evet
type	enum	Reddetmenin türü. Her zaman `refusal`. Olası değerler: `refusal`	Evet

OpenAI.Response

İsim	Türü	Description	Gerekli	Varsayılan
arka plan	boole veya null		Hayı
tamamlanma_tarihi	dize veya null		Hayı
content_filters	AzureContentFilterForResponsesAPI dizisi	RAI'den gelen içerik filtresi sonuçları.	Evet
konuşma	OpenAI.ConversationReference veya null		Hayı
oluşturulma_tarihi	tamsayı	Bu Yanıtın oluşturulduğu unix zaman damgası (saniye).	Evet
hata	OpenAI.ResponseError veya null		Evet
kimlik	String	Bu Yanıt için benzersiz tanımlayıcı.	Evet
incomplete_details	OpenAI.ResponseIncompleteDetails veya null		Evet
instructions	OpenAI.InputItem veya null dizesi veya dizisi		Evet
max_output_tokens	tamsayı veya null		Hayı
max_tool_calls	tamsayı veya null		Hayı
metadata	OpenAI.Metadata veya null		Hayı
model	String	veya `gpt-4o`gibi `o3` yanıtı oluşturmak için kullanılan model kimliği. OpenAI farklı özelliklere, performansa sahip çok çeşitli modeller sunar özellikleri ve fiyat noktaları. Model kılavuzuna bakın seçeneğine gidin ve kullanılabilir modelleri karşılaştırın.	Hayı
nesne	enum	Bu kaynağın nesne türü - her zaman `response` olarak ayarlanır. Olası değerler: `response`	Evet
çıktı	OpenAI.OutputItem dizisi	Model tarafından oluşturulan içerik öğeleri dizisi. - Dizideki `output` öğelerin uzunluğu ve sırası bağlıdır modelin yanıtı üzerinde. - Dizideki `output` ilk öğeye erişmek yerine ve tarafından oluşturulan içeriğe sahip bir `assistant` ileti olduğunu varsayarsak modeli dikkate alarak `output_text` özelliğini kullanmayı düşünebilirsiniz. SDK'larda desteklenir.	Evet
output_text	dize veya null		Hayı
paralel araç çağrıları	Boolean	Modelin araç çağrılarını paralel olarak çalıştırmasına izin verilip verilmeyeceği.	Evet	Doğru
previous_response_id	dize veya null		Hayı
prompt	OpenAI.Prompt	bir istem şablonuna ve değişkenlerine başvuru. Daha fazla bilgi edinin.	Hayı
prompt_cache_key	String	OpenAI tarafından önbellek isabet hızlarınızı iyileştirmek amacıyla benzer isteklere yönelik yanıtları önbelleğe almak için kullanılır. `user` alanını değiştirir. Daha fazla bilgi edinin.	Hayı
prompt_cache_retention	dize veya null		Hayı
reasoning	OpenAI.Reasoning veya null		Hayı
safety_identifier	String	OpenAI'nin kullanım ilkelerini ihlal eden uygulamanızın kullanıcılarını algılamaya yardımcı olmak için kullanılan kararlı tanımlayıcı. Kimlikler, her kullanıcıyı benzersiz olarak tanımlayan bir dize olmalıdır. Bize herhangi bir tanımlayıcı bilgi göndermemek için kullanıcı adını veya e-posta adresini karma olarak kullanmanızı öneririz. Daha fazla bilgi edinin.	Hayı
durum	enum	Yanıt oluşturma durumu. , , `completed`' lerden `failed`biri `in_progress`, `cancelled`, `queued` veya `incomplete`. Olası değerler: `completed`, `failed`, `in_progress`, `cancelled`, , `queued`, `incomplete`	Hayı
sıcaklık	sayı veya null		Hayı
text	OpenAI.ResponseTextParam	Modelden metin yanıtı için yapılandırma seçenekleri. Düz olabilir metin veya yapılandırılmış JSON verileri. Daha fazla bilgi edinin: - Metin girişleri ve çıktıları - Yapılandırılmış Çıktılar	Hayı
tool_choice	OpenAI.ToolChoiceParam	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	OpenAI.ToolsArray	Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Siz parametresini ayarlayarak `tool_choice` hangi aracın kullanılacağını belirtebilir. Aşağıdaki araç kategorilerini destekliyoruz: - Yerleşik araçlar: OpenAI tarafından sağlanan ve işlevselliği genişleten araçlar modelin yetenekleri, örneğin web arama veya file search. Hakkında daha fazla bilgi edinin yerleşik araçlar. - MCP Araçları: Özel MCP sunucuları aracılığıyla üçüncü taraf sistemlerle tümleştirmeler veya Google Drive ve SharePoint gibi önceden tanımlanmış bağlayıcılar. Hakkında daha fazla bilgi edinin MCP Araçları. - İşlev çağrıları (özel araçlar): Sizin tanımladığınız işlevler, modelin kesin olarak yazılan bağımsız değişkenlerle kendi kodunuzu çağırmasını sağlama ve çıkışlarını seçin. Hakkında daha fazla bilgi edinin fonksiyon çağrısı. Ayrıca şunları da kullanabilirsiniz: kendi kodunuzu çağırmak için özel araçlar.	Hayı
top_logprobs	tamsayı veya null		Hayı
top_p	sayı veya null		Hayı
truncation	dize veya null		Hayı
usage	OpenAI.ResponseUsage	Giriş belirteçleri, çıkış belirteçleri dahil olmak üzere belirteç kullanım ayrıntılarını temsil eder. çıkış belirteçlerinin ve kullanılan toplam belirteçlerin dökümü.	Hayı
user	dize (kullanım dışı)	Bu alan ve `safety_identifier`ile `prompt_cache_key` değiştiriliyor. Bunun yerine önbelleğe alma iyileştirmelerini korumak için kullanın `prompt_cache_key` . Son kullanıcılarınız için kararlı bir tanımlayıcı. Benzer istekleri daha iyi demetleyerek önbellek isabet oranlarını artırmak ve OpenAI'nin kötüye kullanımı algılayıp önlemesine yardımcı olmak için kullanılır. Daha fazla bilgi edinin.	Hayı

OpenAI.ResponseAudioDeltaEvent

Kısmi bir ses yanıtı olduğunda yayılır.

İsim	Türü	Description	Gerekli
delta	String	Base64 kodlanmış yanıt ses baytlarının bir öbeği.	Evet
sequence_number	tamsayı	Akış yanıtının bu öbek için bir sıra numarası.	Evet
type	enum	Olayın türü. Her zaman `response.audio.delta`. Olası değerler: `response.audio.delta`	Evet

OpenAI.ResponseAudioTranscriptDeltaEvent

Sesin kısmi bir transkripti olduğunda yayılır.

İsim	Türü	Description	Gerekli
delta	String	Ses yanıtının kısmi transkripti.	Evet
sequence_number	tamsayı	Bu olayın sıra numarası.	Evet
type	enum	Olayın türü. Her zaman `response.audio.transcript.delta`. Olası değerler: `response.audio.transcript.delta`	Evet

OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent

Kısmi kod parçacığı, kod yorumlayıcı tarafından stream edildiğinde tetiklenir.

İsim	Türü	Description	Gerekli
delta	String	Kısmi kod parçacığı, kod yorumlayıcı tarafından aktarılmakta.	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
sequence_number	tamsayı	Akış olaylarını sıralamak için kullanılan bu olayın sıra numarası.	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.ResponseCodeInterpreterCallInProgressEvent

Bir kod yorumlayıcı çağrısı sırasında tetiklenir.

İsim	Türü	Description	Gerekli
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
sequence_number	tamsayı	Akış olaylarını sıralamak için kullanılan bu olayın sıra numarası.	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
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
sequence_number	tamsayı	Akış olaylarını sıralamak için kullanılan bu olayın sıra numarası.	Evet
type	enum	Olayın türü. Her zaman `response.code_interpreter_call.interpreting`. Olası değerler: `response.code_interpreter_call.interpreting`	Evet

OpenAI.ResponseContentPartAddedEvent

Yeni bir içerik bölümü eklendiğinde gönderilir.

İsim	Türü	Description	Gerekli
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	OpenAI.OutputContent		Evet
└─ türü	OpenAI.OutputContentType		Evet
sequence_number	tamsayı	Bu olayın sıra numarası.	Evet
type	enum	Olayın türü. Her zaman `response.content_part.added`. Olası değerler: `response.content_part.added`	Evet

OpenAI.ResponseCreatedEvent

Bir yanıt oluşturulduğunda yayılan bir olay.

İsim	Türü	Description	Gerekli	Varsayılan
yanıt	OpenAI.Response		Evet
└─ arka plan	boole veya null		Hayı
└─ completed_at	dize veya null		Hayı
└─ content_filters	AzureContentFilterForResponsesAPI dizisi	RAI'den gelen içerik filtresi sonuçları.	Evet
└─ konuşma	OpenAI.ConversationReference veya null		Hayı
└─ oluşturulma_tarihi	tamsayı	Bu Yanıtın oluşturulduğu unix zaman damgası (saniye).	Evet
└─ hata	OpenAI.ResponseError veya null		Evet
└─ kimlik	String	Bu Yanıt için benzersiz tanımlayıcı.	Evet
└─ eksik_bilgiler	OpenAI.ResponseIncompleteDetails veya null		Evet
└─ yönerge	OpenAI.InputItem veya null dizesi veya dizisi		Evet
└─ maksimum_çıkış_jetonları	tamsayı veya null		Hayı
└─ maksimum araç çağrıları	tamsayı veya null		Hayı
└─ meta veriler	OpenAI.Metadata veya null		Hayı
└─ modeli	String	veya `gpt-4o`gibi `o3` yanıtı oluşturmak için kullanılan model kimliği. OpenAI farklı özelliklere, performansa sahip çok çeşitli modeller sunar özellikleri ve fiyat noktaları. Model kılavuzuna bakın seçeneğine gidin ve kullanılabilir modelleri karşılaştırın.	Hayı
└─ nesne	enum	Bu kaynağın nesne türü - her zaman `response` olarak ayarlanır. Olası değerler: `response`	Evet
└─ çıkış	OpenAI.OutputItem dizisi	Model tarafından oluşturulan içerik öğeleri dizisi. - Dizideki `output` öğelerin uzunluğu ve sırası bağlıdır modelin yanıtı üzerinde. - Dizideki `output` ilk öğeye erişmek yerine ve tarafından oluşturulan içeriğe sahip bir `assistant` ileti olduğunu varsayarsak modeli dikkate alarak `output_text` özelliğini kullanmayı düşünebilirsiniz. SDK'larda desteklenir.	Evet
└─ çıktı_metin	dize veya null		Hayı
└─ paralel_arac_cagrilari	Boolean	Modelin araç çağrılarını paralel olarak çalıştırmasına izin verilip verilmeyeceği.	Evet	Doğru
└─ önceki_cevap_id	dize veya null		Hayı
└─ istemi	OpenAI.Prompt	bir istem şablonuna ve değişkenlerine başvuru. Daha fazla bilgi edinin.	Hayı
└─ prompt_cache_key	String	OpenAI tarafından önbellek isabet hızlarınızı iyileştirmek amacıyla benzer isteklere yönelik yanıtları önbelleğe almak için kullanılır. `user` alanını değiştirir. Daha fazla bilgi edinin.	Hayı
└─ prompt_cache_retention	dize veya null		Hayı
└─ akıl yürütme	OpenAI.Reasoning veya null		Hayı
└─ safety_identifier	String	OpenAI'nin kullanım ilkelerini ihlal eden uygulamanızın kullanıcılarını algılamaya yardımcı olmak için kullanılan kararlı tanımlayıcı. Kimlikler, her kullanıcıyı benzersiz olarak tanımlayan bir dize olmalıdır. Bize herhangi bir tanımlayıcı bilgi göndermemek için kullanıcı adını veya e-posta adresini karma olarak kullanmanızı öneririz. Daha fazla bilgi edinin.	Hayı
└─ durumu	enum	Yanıt oluşturma durumu. , , `completed`' lerden `failed`biri `in_progress`, `cancelled`, `queued` veya `incomplete`. Olası değerler: `completed`, `failed`, `in_progress`, `cancelled`, , `queued`, `incomplete`	Hayı
└─ sıcaklık	sayı veya null		Hayı	1
└─ metin	OpenAI.ResponseTextParam	Modelden metin yanıtı için yapılandırma seçenekleri. Düz olabilir metin veya yapılandırılmış JSON verileri. Daha fazla bilgi edinin: - Metin girişleri ve çıktıları - Yapılandırılmış Çıktılar	Hayı
└─ araç seçimi	OpenAI.ToolChoiceParam	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ı	OpenAI.ToolsArray	Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Siz parametresini ayarlayarak `tool_choice` hangi aracın kullanılacağını belirtebilir. Aşağıdaki araç kategorilerini destekliyoruz: - Yerleşik araçlar: OpenAI tarafından sağlanan ve işlevselliği genişleten araçlar modelin yetenekleri, örneğin web arama veya file search. Hakkında daha fazla bilgi edinin yerleşik araçlar. - MCP Araçları: Özel MCP sunucuları aracılığıyla üçüncü taraf sistemlerle tümleştirmeler veya Google Drive ve SharePoint gibi önceden tanımlanmış bağlayıcılar. Hakkında daha fazla bilgi edinin MCP Araçları. - İşlev çağrıları (özel araçlar): Sizin tanımladığınız işlevler, modelin kesin olarak yazılan bağımsız değişkenlerle kendi kodunuzu çağırmasını sağlama ve çıkışlarını seçin. Hakkında daha fazla bilgi edinin fonksiyon çağrısı. Ayrıca şunları da kullanabilirsiniz: kendi kodunuzu çağırmak için özel araçlar.	Hayı
└─ top_logprobs	tamsayı veya null		Hayı
└─ top_p	sayı veya null		Hayı	1
└─ kısaltma	dize veya null		Hayı	engelli
└─ kullanımı	OpenAI.ResponseUsage	Giriş belirteçleri, çıkış belirteçleri dahil olmak üzere belirteç kullanım ayrıntılarını temsil eder. çıkış belirteçlerinin ve kullanılan toplam belirteçlerin dökümü.	Hayı
└─ kullanıcı	dize (kullanım dışı)	Bu alan ve `safety_identifier`ile `prompt_cache_key` değiştiriliyor. Bunun yerine önbelleğe alma iyileştirmelerini korumak için kullanın `prompt_cache_key` . Son kullanıcılarınız için kararlı bir tanımlayıcı. Benzer istekleri daha iyi demetleyerek önbellek isabet oranlarını artırmak ve OpenAI'nin kötüye kullanımı algılayıp önlemesine yardımcı olmak için kullanılır. Daha fazla bilgi edinin.	Hayı
sequence_number	tamsayı	Bu olayın sıra numarası.	Evet
type	enum	Olayın türü. Her zaman `response.created`. Olası değerler: `response.created`	Evet

OpenAI.ResponseCustomToolCallInputDeltaEvent

Özel bir araç çağrısının girişine delta (kısmi güncelleştirme) temsil eden olay.

İsim	Türü	Description	Gerekli
delta	String	Özel araç çağrısı için artımlı giriş verileri (delta).	Evet
item_id	String	Bu olayla ilişkili API öğesinin benzersiz tanımlayıcısı.	Evet
output_index	tamsayı	Bu deltanın uygulandığı çıkışın dizini.	Evet
sequence_number	tamsayı	Bu olayın sıra numarası.	Evet
type	enum	Olay türü tanımlayıcısı. Olası değerler: `response.custom_tool_call_input.delta`	Evet

OpenAI.ResponseError

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

İsim	Türü	Description	Gerekli	Varsayılan
kod	OpenAI.ResponseErrorCode	Yanıtın hata kodu.	Evet
mesaj	String	Hatanın insan tarafından okunabilen açıklaması.	Evet

OpenAI.ResponseErrorCode

Yanıtın hata kodu.

Mülkiyet	Değer
Türü	String
Değerler	`server_error` `rate_limit_exceeded` `invalid_prompt` `vector_store_timeout` `invalid_image` `invalid_image_format` `invalid_base64_image` `invalid_image_url` `image_too_large` `image_too_small` `image_parse_error` `image_content_policy_violation` `invalid_image_mode` `image_file_too_large` `unsupported_image_media_type` `empty_image_file` `failed_to_download_image` `image_file_not_found`

OpenAI.ResponseErrorEvent

Bir hata oluştuğunda yayılır.

İsim	Türü	Description	Gerekli
kod	dize veya null		Evet
mesaj	String	Hata iletisi.	Evet
param	dize veya null		Evet
sequence_number	tamsayı	Bu olayın sıra numarası.	Evet
type	enum	Olayın türü. Her zaman `error`. Olası değerler: `error`	Evet

OpenAI.ResponseFailedEvent

Yanıt başarısız olduğunda yayılan bir olay.

İsim	Türü	Description	Gerekli	Varsayılan
yanıt	OpenAI.Response		Evet
└─ arka plan	boole veya null		Hayı
└─ completed_at	dize veya null		Hayı
└─ content_filters	AzureContentFilterForResponsesAPI dizisi	RAI'den gelen içerik filtresi sonuçları.	Evet
└─ konuşma	OpenAI.ConversationReference veya null		Hayı
└─ oluşturulma_tarihi	tamsayı	Bu Yanıtın oluşturulduğu unix zaman damgası (saniye).	Evet
└─ hata	OpenAI.ResponseError veya null		Evet
└─ kimlik	String	Bu Yanıt için benzersiz tanımlayıcı.	Evet
└─ eksik_bilgiler	OpenAI.ResponseIncompleteDetails veya null		Evet
└─ yönerge	OpenAI.InputItem veya null dizesi veya dizisi		Evet
└─ maksimum_çıkış_jetonları	tamsayı veya null		Hayı
└─ maksimum araç çağrıları	tamsayı veya null		Hayı
└─ meta veriler	OpenAI.Metadata veya null		Hayı
└─ modeli	String	veya `gpt-4o`gibi `o3` yanıtı oluşturmak için kullanılan model kimliği. OpenAI farklı özelliklere, performansa sahip çok çeşitli modeller sunar özellikleri ve fiyat noktaları. Model kılavuzuna bakın seçeneğine gidin ve kullanılabilir modelleri karşılaştırın.	Hayı
└─ nesne	enum	Bu kaynağın nesne türü - her zaman `response` olarak ayarlanır. Olası değerler: `response`	Evet
└─ çıkış	OpenAI.OutputItem dizisi	Model tarafından oluşturulan içerik öğeleri dizisi. - Dizideki `output` öğelerin uzunluğu ve sırası bağlıdır modelin yanıtı üzerinde. - Dizideki `output` ilk öğeye erişmek yerine ve tarafından oluşturulan içeriğe sahip bir `assistant` ileti olduğunu varsayarsak modeli dikkate alarak `output_text` özelliğini kullanmayı düşünebilirsiniz. SDK'larda desteklenir.	Evet
└─ çıktı_metin	dize veya null		Hayı
└─ paralel_arac_cagrilari	Boolean	Modelin araç çağrılarını paralel olarak çalıştırmasına izin verilip verilmeyeceği.	Evet	Doğru
└─ önceki_cevap_id	dize veya null		Hayı
└─ istemi	OpenAI.Prompt	bir istem şablonuna ve değişkenlerine başvuru. Daha fazla bilgi edinin.	Hayı
└─ prompt_cache_key	String	OpenAI tarafından önbellek isabet hızlarınızı iyileştirmek amacıyla benzer isteklere yönelik yanıtları önbelleğe almak için kullanılır. `user` alanını değiştirir. Daha fazla bilgi edinin.	Hayı
└─ prompt_cache_retention	dize veya null		Hayı
└─ akıl yürütme	OpenAI.Reasoning veya null		Hayı
└─ safety_identifier	String	OpenAI'nin kullanım ilkelerini ihlal eden uygulamanızın kullanıcılarını algılamaya yardımcı olmak için kullanılan kararlı tanımlayıcı. Kimlikler, her kullanıcıyı benzersiz olarak tanımlayan bir dize olmalıdır. Bize herhangi bir tanımlayıcı bilgi göndermemek için kullanıcı adını veya e-posta adresini karma olarak kullanmanızı öneririz. Daha fazla bilgi edinin.	Hayı
└─ durumu	enum	Yanıt oluşturma durumu. , , `completed`' lerden `failed`biri `in_progress`, `cancelled`, `queued` veya `incomplete`. Olası değerler: `completed`, `failed`, `in_progress`, `cancelled`, , `queued`, `incomplete`	Hayı
└─ sıcaklık	sayı veya null		Hayı	1
└─ metin	OpenAI.ResponseTextParam	Modelden metin yanıtı için yapılandırma seçenekleri. Düz olabilir metin veya yapılandırılmış JSON verileri. Daha fazla bilgi edinin: - Metin girişleri ve çıktıları - Yapılandırılmış Çıktılar	Hayı
└─ araç seçimi	OpenAI.ToolChoiceParam	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ı	OpenAI.ToolsArray	Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Siz parametresini ayarlayarak `tool_choice` hangi aracın kullanılacağını belirtebilir. Aşağıdaki araç kategorilerini destekliyoruz: - Yerleşik araçlar: OpenAI tarafından sağlanan ve işlevselliği genişleten araçlar modelin yetenekleri, örneğin web arama veya file search. Hakkında daha fazla bilgi edinin yerleşik araçlar. - MCP Araçları: Özel MCP sunucuları aracılığıyla üçüncü taraf sistemlerle tümleştirmeler veya Google Drive ve SharePoint gibi önceden tanımlanmış bağlayıcılar. Hakkında daha fazla bilgi edinin MCP Araçları. - İşlev çağrıları (özel araçlar): Sizin tanımladığınız işlevler, modelin kesin olarak yazılan bağımsız değişkenlerle kendi kodunuzu çağırmasını sağlama ve çıkışlarını seçin. Hakkında daha fazla bilgi edinin fonksiyon çağrısı. Ayrıca şunları da kullanabilirsiniz: kendi kodunuzu çağırmak için özel araçlar.	Hayı
└─ top_logprobs	tamsayı veya null		Hayı
└─ top_p	sayı veya null		Hayı	1
└─ kısaltma	dize veya null		Hayı	engelli
└─ kullanımı	OpenAI.ResponseUsage	Giriş belirteçleri, çıkış belirteçleri dahil olmak üzere belirteç kullanım ayrıntılarını temsil eder. çıkış belirteçlerinin ve kullanılan toplam belirteçlerin dökümü.	Hayı
└─ kullanıcı	dize (kullanım dışı)	Bu alan ve `safety_identifier`ile `prompt_cache_key` değiştiriliyor. Bunun yerine önbelleğe alma iyileştirmelerini korumak için kullanın `prompt_cache_key` . Son kullanıcılarınız için kararlı bir tanımlayıcı. Benzer istekleri daha iyi demetleyerek önbellek isabet oranlarını artırmak ve OpenAI'nin kötüye kullanımı algılayıp önlemesine yardımcı olmak için kullanılır. Daha fazla bilgi edinin.	Hayı
sequence_number	tamsayı	Bu olayın sıra numarası.	Evet
type	enum	Olayın türü. Her zaman `response.failed`. Olası değerler: `response.failed`	Evet

OpenAI.ResponseFileSearchCallInProgressEvent

Bir dosya arama çağrısı başlatıldığında gönderilir.

İsim	Türü	Description	Gerekli
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
sequence_number	tamsayı	Bu olayın sıra numarası.	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
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
sequence_number	tamsayı	Bu olayın sıra numarası.	Evet
type	enum	Olayın türü. Her zaman `response.file_search_call.searching`. Olası değerler: `response.file_search_call.searching`	Evet

OpenAI.ResponseFormatJsonObject

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Tanımlanan yanıt biçiminin türü. Her zaman `json_object`. Olası değerler: `json_object`	Evet

OpenAI.ResponseFormatJsonSchema

JSON Şeması yanıt biçimi. Yapılandırılmış JSON yanıtları oluşturmak için kullanılır. Yapılandırılmış Çıktılar hakkında daha fazla bilgi edinin.

İsim	Türü	Description	Gerekli
json şeması	OpenAI.ResponseFormatJsonSchemaJsonSchema		Evet
└─ açıklama	String		Hayı
└─ ad	String		Evet
└─ şeması	OpenAI.YanıtFormatıJsonŞemaŞeması	JSON Şeması nesnesi olarak tanımlanan yanıt biçimi şeması. JSON şemaları oluşturmayı buradan öğrenin.	Hayı
└─ katı	boole veya null		Hayı
type	enum	Tanımlanan yanıt biçiminin türü. Her zaman `json_schema`. Olası değerler: `json_schema`	Evet

OpenAI.ResponseFormatJsonSchemaJsonSchema

İsim	Türü	Description	Gerekli
açıklama	String		Hayı
name	String		Evet
şema	OpenAI.YanıtFormatıJsonŞemaŞeması	JSON Şeması nesnesi olarak tanımlanan yanıt biçimi şeması. JSON şemaları oluşturmayı buradan öğrenin.	Hayı
Kesin	boole veya null		Hayı

OpenAI.YanıtFormatıJsonŞemaŞeması

JSON Şeması nesnesi olarak tanımlanan yanıt biçimi şeması. JSON şemaları oluşturmayı buradan öğrenin.

Tür: nesne

OpenAI.ResponseFormatText

Varsayılan yanıt biçimi. Metin yanıtları oluşturmak için kullanılır.

İ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
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
sequence_number	tamsayı	Bu olayın sıra numarası.	Evet
type	enum	Olayın türü. Her zaman `response.function_call_arguments.delta`. Olası değerler: `response.function_call_arguments.delta`	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
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
sequence_number	tamsayı	İşlenmekte olan görüntü oluşturma öğesinin sıra numarası.	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
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
sequence_number	tamsayı	İşlenmekte olan görüntü oluşturma öğesinin sıra numarası.	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
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
sequence_number	tamsayı	İşlenmekte olan görüntü oluşturma öğesinin sıra numarası.	Evet
type	enum	Olayın türü. Her zaman 'response.image_generation_call.partial_image'. Olası değerler: `response.image_generation_call.partial_image`	Evet

OpenAI.ResponseInProgressEvent

Yanıt devam ederken gönderilir.

İsim	Türü	Description	Gerekli	Varsayılan
yanıt	OpenAI.Response		Evet
└─ arka plan	boole veya null		Hayı
└─ completed_at	dize veya null		Hayı
└─ content_filters	AzureContentFilterForResponsesAPI dizisi	RAI'den gelen içerik filtresi sonuçları.	Evet
└─ konuşma	OpenAI.ConversationReference veya null		Hayı
└─ oluşturulma_tarihi	tamsayı	Bu Yanıtın oluşturulduğu unix zaman damgası (saniye).	Evet
└─ hata	OpenAI.ResponseError veya null		Evet
└─ kimlik	String	Bu Yanıt için benzersiz tanımlayıcı.	Evet
└─ eksik_bilgiler	OpenAI.ResponseIncompleteDetails veya null		Evet
└─ yönerge	OpenAI.InputItem veya null dizesi veya dizisi		Evet
└─ maksimum_çıkış_jetonları	tamsayı veya null		Hayı
└─ maksimum araç çağrıları	tamsayı veya null		Hayı
└─ meta veriler	OpenAI.Metadata veya null		Hayı
└─ modeli	String	veya `gpt-4o`gibi `o3` yanıtı oluşturmak için kullanılan model kimliği. OpenAI farklı özelliklere, performansa sahip çok çeşitli modeller sunar özellikleri ve fiyat noktaları. Model kılavuzuna bakın seçeneğine gidin ve kullanılabilir modelleri karşılaştırın.	Hayı
└─ nesne	enum	Bu kaynağın nesne türü - her zaman `response` olarak ayarlanır. Olası değerler: `response`	Evet
└─ çıkış	OpenAI.OutputItem dizisi	Model tarafından oluşturulan içerik öğeleri dizisi. - Dizideki `output` öğelerin uzunluğu ve sırası bağlıdır modelin yanıtı üzerinde. - Dizideki `output` ilk öğeye erişmek yerine ve tarafından oluşturulan içeriğe sahip bir `assistant` ileti olduğunu varsayarsak modeli dikkate alarak `output_text` özelliğini kullanmayı düşünebilirsiniz. SDK'larda desteklenir.	Evet
└─ çıktı_metin	dize veya null		Hayı
└─ paralel_arac_cagrilari	Boolean	Modelin araç çağrılarını paralel olarak çalıştırmasına izin verilip verilmeyeceği.	Evet	Doğru
└─ önceki_cevap_id	dize veya null		Hayı
└─ istemi	OpenAI.Prompt	bir istem şablonuna ve değişkenlerine başvuru. Daha fazla bilgi edinin.	Hayı
└─ prompt_cache_key	String	OpenAI tarafından önbellek isabet hızlarınızı iyileştirmek amacıyla benzer isteklere yönelik yanıtları önbelleğe almak için kullanılır. `user` alanını değiştirir. Daha fazla bilgi edinin.	Hayı
└─ prompt_cache_retention	dize veya null		Hayı
└─ akıl yürütme	OpenAI.Reasoning veya null		Hayı
└─ safety_identifier	String	OpenAI'nin kullanım ilkelerini ihlal eden uygulamanızın kullanıcılarını algılamaya yardımcı olmak için kullanılan kararlı tanımlayıcı. Kimlikler, her kullanıcıyı benzersiz olarak tanımlayan bir dize olmalıdır. Bize herhangi bir tanımlayıcı bilgi göndermemek için kullanıcı adını veya e-posta adresini karma olarak kullanmanızı öneririz. Daha fazla bilgi edinin.	Hayı
└─ durumu	enum	Yanıt oluşturma durumu. , , `completed`' lerden `failed`biri `in_progress`, `cancelled`, `queued` veya `incomplete`. Olası değerler: `completed`, `failed`, `in_progress`, `cancelled`, , `queued`, `incomplete`	Hayı
└─ sıcaklık	sayı veya null		Hayı	1
└─ metin	OpenAI.ResponseTextParam	Modelden metin yanıtı için yapılandırma seçenekleri. Düz olabilir metin veya yapılandırılmış JSON verileri. Daha fazla bilgi edinin: - Metin girişleri ve çıktıları - Yapılandırılmış Çıktılar	Hayı
└─ araç seçimi	OpenAI.ToolChoiceParam	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ı	OpenAI.ToolsArray	Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Siz parametresini ayarlayarak `tool_choice` hangi aracın kullanılacağını belirtebilir. Aşağıdaki araç kategorilerini destekliyoruz: - Yerleşik araçlar: OpenAI tarafından sağlanan ve işlevselliği genişleten araçlar modelin yetenekleri, örneğin web arama veya file search. Hakkında daha fazla bilgi edinin yerleşik araçlar. - MCP Araçları: Özel MCP sunucuları aracılığıyla üçüncü taraf sistemlerle tümleştirmeler veya Google Drive ve SharePoint gibi önceden tanımlanmış bağlayıcılar. Hakkında daha fazla bilgi edinin MCP Araçları. - İşlev çağrıları (özel araçlar): Sizin tanımladığınız işlevler, modelin kesin olarak yazılan bağımsız değişkenlerle kendi kodunuzu çağırmasını sağlama ve çıkışlarını seçin. Hakkında daha fazla bilgi edinin fonksiyon çağrısı. Ayrıca şunları da kullanabilirsiniz: kendi kodunuzu çağırmak için özel araçlar.	Hayı
└─ top_logprobs	tamsayı veya null		Hayı
└─ top_p	sayı veya null		Hayı	1
└─ kısaltma	dize veya null		Hayı	engelli
└─ kullanımı	OpenAI.ResponseUsage	Giriş belirteçleri, çıkış belirteçleri dahil olmak üzere belirteç kullanım ayrıntılarını temsil eder. çıkış belirteçlerinin ve kullanılan toplam belirteçlerin dökümü.	Hayı
└─ kullanıcı	dize (kullanım dışı)	Bu alan ve `safety_identifier`ile `prompt_cache_key` değiştiriliyor. Bunun yerine önbelleğe alma iyileştirmelerini korumak için kullanın `prompt_cache_key` . Son kullanıcılarınız için kararlı bir tanımlayıcı. Benzer istekleri daha iyi demetleyerek önbellek isabet oranlarını artırmak ve OpenAI'nin kötüye kullanımı algılayıp önlemesine yardımcı olmak için kullanılır. Daha fazla bilgi edinin.	Hayı
sequence_number	tamsayı	Bu olayın sıra numarası.	Evet
type	enum	Olayın türü. Her zaman `response.in_progress`. Olası değerler: `response.in_progress`	Evet

OpenAI.ResponseIncompleteDetails

İsim	Türü	Description	Gerekli	Varsayılan
sebep	enum	Olası değerler: `max_output_tokens`, `content_filter`	Hayı

OpenAI.ResponseIncompleteEvent

Yanıt eksik olduğunda yayılan bir olay.

İsim	Türü	Description	Gerekli	Varsayılan
yanıt	OpenAI.Response		Evet
└─ arka plan	boole veya null		Hayı
└─ completed_at	dize veya null		Hayı
└─ content_filters	AzureContentFilterForResponsesAPI dizisi	RAI'den gelen içerik filtresi sonuçları.	Evet
└─ konuşma	OpenAI.ConversationReference veya null		Hayı
└─ oluşturulma_tarihi	tamsayı	Bu Yanıtın oluşturulduğu unix zaman damgası (saniye).	Evet
└─ hata	OpenAI.ResponseError veya null		Evet
└─ kimlik	String	Bu Yanıt için benzersiz tanımlayıcı.	Evet
└─ eksik_bilgiler	OpenAI.ResponseIncompleteDetails veya null		Evet
└─ yönerge	OpenAI.InputItem veya null dizesi veya dizisi		Evet
└─ maksimum_çıkış_jetonları	tamsayı veya null		Hayı
└─ maksimum araç çağrıları	tamsayı veya null		Hayı
└─ meta veriler	OpenAI.Metadata veya null		Hayı
└─ modeli	String	veya `gpt-4o`gibi `o3` yanıtı oluşturmak için kullanılan model kimliği. OpenAI farklı özelliklere, performansa sahip çok çeşitli modeller sunar özellikleri ve fiyat noktaları. Model kılavuzuna bakın seçeneğine gidin ve kullanılabilir modelleri karşılaştırın.	Hayı
└─ nesne	enum	Bu kaynağın nesne türü - her zaman `response` olarak ayarlanır. Olası değerler: `response`	Evet
└─ çıkış	OpenAI.OutputItem dizisi	Model tarafından oluşturulan içerik öğeleri dizisi. - Dizideki `output` öğelerin uzunluğu ve sırası bağlıdır modelin yanıtı üzerinde. - Dizideki `output` ilk öğeye erişmek yerine ve tarafından oluşturulan içeriğe sahip bir `assistant` ileti olduğunu varsayarsak modeli dikkate alarak `output_text` özelliğini kullanmayı düşünebilirsiniz. SDK'larda desteklenir.	Evet
└─ çıktı_metin	dize veya null		Hayı
└─ paralel_arac_cagrilari	Boolean	Modelin araç çağrılarını paralel olarak çalıştırmasına izin verilip verilmeyeceği.	Evet	Doğru
└─ önceki_cevap_id	dize veya null		Hayı
└─ istemi	OpenAI.Prompt	bir istem şablonuna ve değişkenlerine başvuru. Daha fazla bilgi edinin.	Hayı
└─ prompt_cache_key	String	OpenAI tarafından önbellek isabet hızlarınızı iyileştirmek amacıyla benzer isteklere yönelik yanıtları önbelleğe almak için kullanılır. `user` alanını değiştirir. Daha fazla bilgi edinin.	Hayı
└─ prompt_cache_retention	dize veya null		Hayı
└─ akıl yürütme	OpenAI.Reasoning veya null		Hayı
└─ safety_identifier	String	OpenAI'nin kullanım ilkelerini ihlal eden uygulamanızın kullanıcılarını algılamaya yardımcı olmak için kullanılan kararlı tanımlayıcı. Kimlikler, her kullanıcıyı benzersiz olarak tanımlayan bir dize olmalıdır. Bize herhangi bir tanımlayıcı bilgi göndermemek için kullanıcı adını veya e-posta adresini karma olarak kullanmanızı öneririz. Daha fazla bilgi edinin.	Hayı
└─ durumu	enum	Yanıt oluşturma durumu. , , `completed`' lerden `failed`biri `in_progress`, `cancelled`, `queued` veya `incomplete`. Olası değerler: `completed`, `failed`, `in_progress`, `cancelled`, , `queued`, `incomplete`	Hayı
└─ sıcaklık	sayı veya null		Hayı	1
└─ metin	OpenAI.ResponseTextParam	Modelden metin yanıtı için yapılandırma seçenekleri. Düz olabilir metin veya yapılandırılmış JSON verileri. Daha fazla bilgi edinin: - Metin girişleri ve çıktıları - Yapılandırılmış Çıktılar	Hayı
└─ araç seçimi	OpenAI.ToolChoiceParam	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ı	OpenAI.ToolsArray	Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Siz parametresini ayarlayarak `tool_choice` hangi aracın kullanılacağını belirtebilir. Aşağıdaki araç kategorilerini destekliyoruz: - Yerleşik araçlar: OpenAI tarafından sağlanan ve işlevselliği genişleten araçlar modelin yetenekleri, örneğin web arama veya file search. Hakkında daha fazla bilgi edinin yerleşik araçlar. - MCP Araçları: Özel MCP sunucuları aracılığıyla üçüncü taraf sistemlerle tümleştirmeler veya Google Drive ve SharePoint gibi önceden tanımlanmış bağlayıcılar. Hakkında daha fazla bilgi edinin MCP Araçları. - İşlev çağrıları (özel araçlar): Sizin tanımladığınız işlevler, modelin kesin olarak yazılan bağımsız değişkenlerle kendi kodunuzu çağırmasını sağlama ve çıkışlarını seçin. Hakkında daha fazla bilgi edinin fonksiyon çağrısı. Ayrıca şunları da kullanabilirsiniz: kendi kodunuzu çağırmak için özel araçlar.	Hayı
└─ top_logprobs	tamsayı veya null		Hayı
└─ top_p	sayı veya null		Hayı	1
└─ kısaltma	dize veya null		Hayı	engelli
└─ kullanımı	OpenAI.ResponseUsage	Giriş belirteçleri, çıkış belirteçleri dahil olmak üzere belirteç kullanım ayrıntılarını temsil eder. çıkış belirteçlerinin ve kullanılan toplam belirteçlerin dökümü.	Hayı
└─ kullanıcı	dize (kullanım dışı)	Bu alan ve `safety_identifier`ile `prompt_cache_key` değiştiriliyor. Bunun yerine önbelleğe alma iyileştirmelerini korumak için kullanın `prompt_cache_key` . Son kullanıcılarınız için kararlı bir tanımlayıcı. Benzer istekleri daha iyi demetleyerek önbellek isabet oranlarını artırmak ve OpenAI'nin kötüye kullanımı algılayıp önlemesine yardımcı olmak için kullanılır. Daha fazla bilgi edinin.	Hayı
sequence_number	tamsayı	Bu olayın sıra numarası.	Evet
type	enum	Olayın türü. Her zaman `response.incomplete`. Olası değerler: `response.incomplete`	Evet

OpenAI.ResponseItemList

Yanıt öğelerinin listesi.

İsim	Türü	Description	Gerekli
veriler	OpenAI.ItemResource dizisi	Bu yanıtı oluşturmak için kullanılan öğelerin listesi.	Evet
ilk_kimlik	String	Listedeki ilk öğenin kimliği.	Evet
daha_fazla	Boolean	Kullanılabilir daha fazla öğe olup olmadığı.	Evet
son_kimlik	String	Listedeki son öğenin kimliği.	Evet
nesne	enum	Döndürülen nesnenin türü olmalıdır `list`. Olası değerler: `list`	Evet

OpenAI.ResponseLogProb

Logprob, modelin dizideki belirli bir konumda belirli bir belirteci üretmeye atayan logaritmik olasılıktır. Daha az negatif (daha yüksek) logprob değerleri, bu belirteç seçiminde model güvenilirliğinin daha yüksek olduğunu gösterir.

İsim	Türü	Description	Gerekli
logprob	Numara	Bu belirtecin günlük olasılığı.	Evet
token	String	Olası bir metin belirteci.	Evet
top_logprobs	OpenAI.ResponseLogProbTopLogprobs dizisi	En olası 20 belirtecin günlük olasılığı.	Hayı

OpenAI.ResponseLogProbTopLogprobs

İsim	Türü	Description	Gerekli	Varsayılan
logprob	Numara		Hayı
token	String		Hayı

OpenAI.ResponseMCPCallArgumentsDeltaEvent

MCP araç çağrısının bağımsız değişkenlerinde delta (kısmi güncelleştirme) olduğunda gerçekleşir.

İsim	Türü	Description	Gerekli
delta	String	MCP araç çağrısı için bağımsız değişkenlere yönelik kısmi güncelleştirmeyi içeren bir JSON dizesi.	Evet
item_id	String	İşlenen MCP aracı çağrı öğesinin benzersiz tanımlayıcısı.	Evet
output_index	tamsayı	Yanıtın çıkış dizisindeki çıkış öğesinin dizini.	Evet
sequence_number	tamsayı	Bu olayın sıra numarası.	Evet
type	enum	Olayın türü. Her zaman 'response.mcp_call_arguments.delta'. Olası değerler: `response.mcp_call_arguments.delta`	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
item_id	String	Başarısız olan MCP aracı çağrı öğesinin kimliği.	Evet
output_index	tamsayı	Başarısız olan çıkış öğesinin dizini.	Evet
sequence_number	tamsayı	Bu olayın sıra numarası.	Evet
type	enum	Olayın türü. 'sonuç her zaman 'response.mcp_call.failed' olur. Olası değerler: `response.mcp_call.failed`	Evet

OpenAI.ResponseMCPCallInProgressEvent

Bir MCP araç çağrısı devam ederken tetiklenir.

İsim	Türü	Description	Gerekli
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
sequence_number	tamsayı	Bu olayın sıra numarası.	Evet
type	enum	Olayın türü. Her zaman 'response.mcp_call.in_progress'. Olası değerler: `response.mcp_call.in_progress`	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
item_id	String	Başarısız olan MCP aracı çağrı öğesinin kimliği.	Evet
output_index	tamsayı	Başarısız olan çıkış öğesinin dizini.	Evet
sequence_number	tamsayı	Bu olayın sıra numarası.	Evet
type	enum	Olayın türü. Her zaman 'response.mcp_list_tools.başarısız'. Olası değerler: `response.mcp_list_tools.failed`	Evet

OpenAI.ResponseMCPListToolsInProgressEvent

Sistem, kullanılabilir MCP araçlarının listesini alırken tetiklenir.

İsim	Türü	Description	Gerekli
item_id	String	İşlenmekte olan MCP aracı çağrı öğesinin kimliği.	Evet
output_index	tamsayı	İşlenmekte olan çıkış öğesinin dizini.	Evet
sequence_number	tamsayı	Bu olayın sıra numarası.	Evet
type	enum	Olayın türü. Her zaman 'response.mcp_list_tools.in_progress'. Olası değerler: `response.mcp_list_tools.in_progress`	Evet

OpenAI.ResponseModalities

Modelin oluşturmasını istediğiniz çıkış türleri. Çoğu model, varsayılan olan metin oluşturabilir: ["text"] Model gpt-4o-audio-previewses oluşturmak için de kullanılabilir. Bu modelin hem metin hem de ses yanıtları oluşturmasını istemek için şunları kullanabilirsiniz: ["text", "audio"]

Bu şema aşağıdaki türlerden birini kabul eder:

array
sıfır

OpenAI.ResponseOutputItemAddedEvent

Yeni bir çıkış öğesi eklendiğinde gönderilir.

İsim	Türü	Description	Gerekli
öğe	OpenAI.OutputItem		Evet
└─ türü	OpenAI.OutputItemType		Evet
output_index	tamsayı	Eklenen çıkış öğesinin dizini.	Evet
sequence_number	tamsayı	Bu olayın sıra numarası.	Evet
type	enum	Olayın türü. Her zaman `response.output_item.added`. Olası değerler: `response.output_item.added`	Evet

OpenAI.ResponseOutputTextAnnotationAddedEvent

Çıkış metni içeriğine ek açıklama eklendiğinde yayılır.

İsim	Türü	Description	Gerekli
annotation	OpenAI.Annotation	Çıkış metninin yayılma alanına uygulanan bir ek açıklama.	Evet
└─ türü	OpenAI.AnnotationType		Evet
annotation_index	tamsayı	İçerik bölümündeki ek açıklamanın dizini.	Evet
content_index	tamsayı	Çıkış öğesi içindeki içerik bölümünün dizini.	Evet
item_id	String	Ek açıklamanın eklendiği öğenin benzersiz tanımlayıcısı.	Evet
output_index	tamsayı	Yanıtın çıkış dizisindeki çıkış öğesinin dizini.	Evet
sequence_number	tamsayı	Bu olayın sıra numarası.	Evet
type	enum	Olayın türü. Her zaman 'response.output_text.annotation.added'. Olası değerler: `response.output_text.annotation.added`	Evet

OpenAI.ResponsePromptVariables

İsteminizde değişkenlerin yerine kullanılacak isteğe bağlı değerler haritası. Değiştirme değerleri dizeler veya görüntüler veya dosyalar gibi diğer Yanıt giriş türleri olabilir.

Tür: nesne

OpenAI.ResponseQueuedEvent

Bir yanıt kuyruğa alınıp işlenmeyi beklediğinde gönderilir.

İsim	Türü	Description	Gerekli	Varsayılan
yanıt	OpenAI.Response		Evet
└─ arka plan	boole veya null		Hayı
└─ completed_at	dize veya null		Hayı
└─ content_filters	AzureContentFilterForResponsesAPI dizisi	RAI'den gelen içerik filtresi sonuçları.	Evet
└─ konuşma	OpenAI.ConversationReference veya null		Hayı
└─ oluşturulma_tarihi	tamsayı	Bu Yanıtın oluşturulduğu unix zaman damgası (saniye).	Evet
└─ hata	OpenAI.ResponseError veya null		Evet
└─ kimlik	String	Bu Yanıt için benzersiz tanımlayıcı.	Evet
└─ eksik_bilgiler	OpenAI.ResponseIncompleteDetails veya null		Evet
└─ yönerge	OpenAI.InputItem veya null dizesi veya dizisi		Evet
└─ maksimum_çıkış_jetonları	tamsayı veya null		Hayı
└─ maksimum araç çağrıları	tamsayı veya null		Hayı
└─ meta veriler	OpenAI.Metadata veya null		Hayı
└─ modeli	String	veya `gpt-4o`gibi `o3` yanıtı oluşturmak için kullanılan model kimliği. OpenAI farklı özelliklere, performansa sahip çok çeşitli modeller sunar özellikleri ve fiyat noktaları. Model kılavuzuna bakın seçeneğine gidin ve kullanılabilir modelleri karşılaştırın.	Hayı
└─ nesne	enum	Bu kaynağın nesne türü - her zaman `response` olarak ayarlanır. Olası değerler: `response`	Evet
└─ çıkış	OpenAI.OutputItem dizisi	Model tarafından oluşturulan içerik öğeleri dizisi. - Dizideki `output` öğelerin uzunluğu ve sırası bağlıdır modelin yanıtı üzerinde. - Dizideki `output` ilk öğeye erişmek yerine ve tarafından oluşturulan içeriğe sahip bir `assistant` ileti olduğunu varsayarsak modeli dikkate alarak `output_text` özelliğini kullanmayı düşünebilirsiniz. SDK'larda desteklenir.	Evet
└─ çıktı_metin	dize veya null		Hayı
└─ paralel_arac_cagrilari	Boolean	Modelin araç çağrılarını paralel olarak çalıştırmasına izin verilip verilmeyeceği.	Evet	Doğru
└─ önceki_cevap_id	dize veya null		Hayı
└─ istemi	OpenAI.Prompt	bir istem şablonuna ve değişkenlerine başvuru. Daha fazla bilgi edinin.	Hayı
└─ prompt_cache_key	String	OpenAI tarafından önbellek isabet hızlarınızı iyileştirmek amacıyla benzer isteklere yönelik yanıtları önbelleğe almak için kullanılır. `user` alanını değiştirir. Daha fazla bilgi edinin.	Hayı
└─ prompt_cache_retention	dize veya null		Hayı
└─ akıl yürütme	OpenAI.Reasoning veya null		Hayı
└─ safety_identifier	String	OpenAI'nin kullanım ilkelerini ihlal eden uygulamanızın kullanıcılarını algılamaya yardımcı olmak için kullanılan kararlı tanımlayıcı. Kimlikler, her kullanıcıyı benzersiz olarak tanımlayan bir dize olmalıdır. Bize herhangi bir tanımlayıcı bilgi göndermemek için kullanıcı adını veya e-posta adresini karma olarak kullanmanızı öneririz. Daha fazla bilgi edinin.	Hayı
└─ durumu	enum	Yanıt oluşturma durumu. , , `completed`' lerden `failed`biri `in_progress`, `cancelled`, `queued` veya `incomplete`. Olası değerler: `completed`, `failed`, `in_progress`, `cancelled`, , `queued`, `incomplete`	Hayı
└─ sıcaklık	sayı veya null		Hayı	1
└─ metin	OpenAI.ResponseTextParam	Modelden metin yanıtı için yapılandırma seçenekleri. Düz olabilir metin veya yapılandırılmış JSON verileri. Daha fazla bilgi edinin: - Metin girişleri ve çıktıları - Yapılandırılmış Çıktılar	Hayı
└─ araç seçimi	OpenAI.ToolChoiceParam	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ı	OpenAI.ToolsArray	Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Siz parametresini ayarlayarak `tool_choice` hangi aracın kullanılacağını belirtebilir. Aşağıdaki araç kategorilerini destekliyoruz: - Yerleşik araçlar: OpenAI tarafından sağlanan ve işlevselliği genişleten araçlar modelin yetenekleri, örneğin web arama veya file search. Hakkında daha fazla bilgi edinin yerleşik araçlar. - MCP Araçları: Özel MCP sunucuları aracılığıyla üçüncü taraf sistemlerle tümleştirmeler veya Google Drive ve SharePoint gibi önceden tanımlanmış bağlayıcılar. Hakkında daha fazla bilgi edinin MCP Araçları. - İşlev çağrıları (özel araçlar): Sizin tanımladığınız işlevler, modelin kesin olarak yazılan bağımsız değişkenlerle kendi kodunuzu çağırmasını sağlama ve çıkışlarını seçin. Hakkında daha fazla bilgi edinin fonksiyon çağrısı. Ayrıca şunları da kullanabilirsiniz: kendi kodunuzu çağırmak için özel araçlar.	Hayı
└─ top_logprobs	tamsayı veya null		Hayı
└─ top_p	sayı veya null		Hayı	1
└─ kısaltma	dize veya null		Hayı	engelli
└─ kullanımı	OpenAI.ResponseUsage	Giriş belirteçleri, çıkış belirteçleri dahil olmak üzere belirteç kullanım ayrıntılarını temsil eder. çıkış belirteçlerinin ve kullanılan toplam belirteçlerin dökümü.	Hayı
└─ kullanıcı	dize (kullanım dışı)	Bu alan ve `safety_identifier`ile `prompt_cache_key` değiştiriliyor. Bunun yerine önbelleğe alma iyileştirmelerini korumak için kullanın `prompt_cache_key` . Son kullanıcılarınız için kararlı bir tanımlayıcı. Benzer istekleri daha iyi demetleyerek önbellek isabet oranlarını artırmak ve OpenAI'nin kötüye kullanımı algılayıp önlemesine yardımcı olmak için kullanılır. Daha fazla bilgi edinin.	Hayı
sequence_number	tamsayı	Bu olayın sıra numarası.	Evet
type	enum	Olayın türü. Her zaman 'response.queued'. Olası değerler: `response.queued`	Evet

OpenAI.ResponseReasoningSummaryPartAddedEvent

Yeni bir akıl yürütme özeti bölümü eklendiğinde yayımlanır.

İsim	Türü	Description	Gerekli
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	OpenAI.ResponseReasoningSummaryPartAddedEventPart		Evet
└─ metin	String		Evet
└─ türü	enum	Olası değerler: `summary_text`	Evet
sequence_number	tamsayı	Bu olayın sıra numarası.	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_part.added`. Olası değerler: `response.reasoning_summary_part.added`	Evet

OpenAI.ResponseReasoningSummaryPartAddedEventPart

İsim	Türü	Description	Gerekli	Varsayılan
text	String		Evet
type	enum	Olası değerler: `summary_text`	Evet

OpenAI.ResponseReasoningSummaryTextDeltaEvent

Bir muhakeme özeti metnine delta eklendiğinde oluşur.

İsim	Türü	Description	Gerekli
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
sequence_number	tamsayı	Bu olayın sıra numarası.	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.ResponseReasoningTextDeltaEvent

Bir muhakeme metnine delta eklendiğinde yayılır.

İsim	Türü	Description	Gerekli
content_index	tamsayı	Bu deltanın ilişkili olduğu gerekçe oluşturma içeriğinin dizini.	Evet
delta	String	Muhakeme içeriğine eklenen metin deltası.	Evet
item_id	String	Bu muhakeme metni deltasının ilişkili olduğu öğenin kimliği.	Evet
output_index	tamsayı	Bu metin değişikliğinin ilişkilendirilmesine neden olan çıkış öğesinin dizini.	Evet
sequence_number	tamsayı	Bu olayın sıra numarası.	Evet
type	enum	Olayın türü. Her zaman `response.reasoning_text.delta`. Olası değerler: `response.reasoning_text.delta`	Evet

OpenAI.ResponseRefusalDeltaEvent

Kısmi bir reddetme metni olduğunda yayılır.

İsim	Türü	Description	Gerekli
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
sequence_number	tamsayı	Bu olayın sıra numarası.	Evet
type	enum	Olayın türü. Her zaman `response.refusal.delta`. Olası değerler: `response.refusal.delta`	Evet

OpenAI.ResponseStreamOptions

Akış yanıtları için seçenekler. Bunu yalnızca ayarladığınızda ayarlayın stream: true.

İsim	Türü	Description	Gerekli	Varsayılan
include_obfuscation	Boolean	True olduğunda, akış gizleme etkinleştirilir. Akış gizleme eklemeleri değişiklik olaylarının akışındaki bir `obfuscation` alana rastgele karakterler yük boyutlarını belirli yan kanal saldırılarına karşı bir azaltma olarak normalleştirin. Bu gizleme alanları varsayılan olarak eklenir, ancak küçük bir miktar eklenir veri akışı için ek yük. Şunu ayarlayabilirsiniz:`include_obfuscation` arasında ağ bağlantılarına güveniyorsanız bant genişliğini iyileştirmek için false uygulamanızı ve OpenAI API'sini seçin.	Hayı

OpenAI.ResponseTextDeltaEvent

İlave bir metin deltası olduğunda oluşur.

İsim	Türü	Description	Gerekli
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
logprobs	OpenAI.ResponseLogProb dizisi	Deltadaki belirteçlerin günlük olasılıkları.	Evet
output_index	tamsayı	Metin deltasının eklendiği çıkış öğesinin dizini.	Evet
sequence_number	tamsayı	Bu olayın sıra numarası.	Evet
type	enum	Olayın türü. Her zaman `response.output_text.delta`. Olası değerler: `response.output_text.delta`	Evet

OpenAI.ResponseTextParam

Modelden metin yanıtı için yapılandırma seçenekleri. Düz metin veya yapılandırılmış JSON verileri olabilir. Daha fazla bilgi edinin:

İsim	Türü	Description	Gerekli	Varsayılan
format	OpenAI.TextResponseFormatConfiguration	Modelin çıkış yapması gereken biçimi belirten bir nesne. Yapılandırma `{ "type": "json_schema" }` , Yapılandırılmış Çıkışları etkinleştirir, modelin sağlanan JSON şemanızla eşleşmesini sağlar. Daha fazla bilgi için Varsayılan biçim `{ "type": "text" }` ek seçenek yoktur. *gpt-4o ve daha yeni modeller için önerilmez: `{ "type": "json_object" }` ayarı, eski JSON modunu etkinleştirir. modelin oluşturduğu iletinin geçerli JSON olduğundan emin olur. `json_schema`’ı kullanma Bu özelliği destekleyen modeller için tercih edilir.	Hayı
Ayrıntı	OpenAI.Verbosity	Modelin yanıtının çok fazla olduğunu sınırlar. Daha düşük değerler, daha kısa yanıtlar elde ederken, daha yüksek değerler daha ayrıntılı yanıtlara neden olur. Şu anda desteklenen değerler , `low`ve `medium`'tir`high`.	Hayı

OpenAI.ResponseUsage

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

İsim	Türü	Description	Gerekli
input_tokens	tamsayı	Giriş belirteçlerinin sayısı.	Evet
input_tokens_details	OpenAI.ResponseUsageInputTokensDetails		Evet
└─ önbelleğe alınmış jetonlar	tamsayı		Evet
output_tokens	tamsayı	Çıkış belirteçlerinin sayısı.	Evet
output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails		Evet
└─ akıl yürütme_tokenlar	tamsayı		Evet
total_tokens	tamsayı	Kullanılan toplam belirteç sayısı.	Evet

OpenAI.ResponseUsageInputTokensDetails

İsim	Türü	Description	Gerekli	Varsayılan
cached_tokens	tamsayı		Evet

OpenAI.ResponseUsageOutputTokensDetails

İsim	Türü	Description	Gerekli	Varsayılan
akıl yürütme birimleri	tamsayı		Evet

OpenAI.ResponseWebSearchCallInProgressEvent

Not: web_search henüz Azure OpenAI aracılığıyla sağlanmaz.

İsim	Türü	Description	Gerekli
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
sequence_number	tamsayı	İşlenmekte olan web arama çağrısının sıra numarası.	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
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
sequence_number	tamsayı	İşlenmekte olan web arama çağrısının sıra numarası.	Evet
type	enum	Olayın türü. Her zaman `response.web_search_call.searching`. Olası değerler: `response.web_search_call.searching`	Evet

OpenAI.RunCompletionUsage

Çalıştırmayla ilgili kullanım istatistikleri. Çalıştırma terminal durumunda değilse (örneğin, null, in_progressvb.) bu değer queued.

İsim	Türü	Description	Gerekli
completion_tokens	tamsayı	Çalıştırma boyunca kullanılan tamamlanma belirteçlerinin sayısı.	Evet
prompt_tokens	tamsayı	Çalıştırma boyunca kullanılan istem belirteçlerinin sayısı.	Evet
total_tokens	tamsayı	Kullanılan toplam belirteç sayısı (istem + tamamlama).	Evet

OpenAI.RunGraderRequest

İsim	Türü	Description	Gerekli
Yol tesviye makinesi	OpenAI.GraderStringCheck veya OpenAI.GraderTextSimilarity veya OpenAI.GraderPython veya OpenAI.GraderScoreModel ya da OpenAI.GraderMulti veya GraderEndpoint	İnce ayar işi için kullanılan not veren.	Evet
öğe	OpenAI.RunGraderRequestItem		Hayı
model_sample	String	Değerlendirilecek model örneği. Bu değer bir alanı doldurmak için kullanılacak. ad alanı `sample` . Daha fazla ayrıntı için kılavuza bakın. `output_json` Model örneği bir geçerli JSON dizesi.	Evet

OpenAI.RunGraderRequestItem

Tür: nesne

OpenAI.RunGraderResponse

İsim	Türü	Gerekli
metadata	OpenAI.RunGraderResponseMetadata	Evet
model değerlendirici model başına token kullanımı	nesne	Evet
ödül	Numara	Evet
alt ödüller	nesne	Evet

OpenAI.RunGraderResponseMetadata

İsim	Türü	Gerekli
Hata	OpenAI.RunGraderResponseMetadataErrors	Evet
execution_time	Numara	Evet
name	String	Evet
sampled_model_name	dize veya null	Evet
Puanlar	nesne	Evet
token_usage	tamsayı veya null	Evet
type	String	Evet

OpenAI.RunGraderResponseMetadataErrors

İsim	Türü	Gerekli
formula_parse_error	Boolean	Evet
invalid_variable_error	Boolean	Evet
model_grader_parse_error	Boolean	Evet
model_grader_refusal_error	Boolean	Evet
model_grader_server_error	Boolean	Evet
model_grader_server_error_details	dize veya null	Evet
other_error	Boolean	Evet
python_grader_runtime_error	Boolean	Evet
python_grader_runtime_error_details	dize veya null	Evet
python_grader_server_error	Boolean	Evet
python_grader_server_error_type	dize veya null	Evet
sample_parse_error	Boolean	Evet
truncated_observation_error	Boolean	Evet
unresponsive_reward_error	Boolean	Evet

OpenAI.RunObject

bir iş parçacığındaki yürütme çalıştırmalarını temsil eder.

İsim	Türü	Description	Gerekli	Varsayılan
assistant_id	String	Bu çalıştırmanın yürütülmesi için kullanılan yardımcının kimliği.	Evet
iptal edildiğinde	dize veya null	Çalıştırmanın iptal edildiği zaman için Unix zaman damgası (saniye olarak).	Evet
tamamlanma_tarihi	dize veya null	Çalıştırmanın ne zaman tamamlandığına ilişkin Unix zaman damgası (saniye olarak).	Evet
oluşturulma_tarihi	tamsayı	Çalıştırmanın oluşturulduğu zaman için Unix zaman damgası (saniye olarak).	Evet
sona_erdigi_tarih	dize veya null	Çalıştırmanın süresinin dolacağı zaman için Unix zaman damgası (saniye olarak).	Evet
başarısız_olduğunda	dize veya null	Çalıştırmanın başarısız olduğu zaman için Unix zaman damgası (saniye olarak).	Evet
kimlik	String	API uç noktalarında başvurulabilen tanımlayıcı.	Evet
incomplete_details	OpenAI.RunObjectIncompleteDetails veya null	Çalıştırmanın neden tamamlanmamış olduğuna ilişkin ayrıntılar. Çalıştırma tamamlanmamışsa `null`.	Evet
instructions	String	Yardımcının bu çalıştırma için kullandığı yönergeler.	Evet
Son_hata	OpenAI.RunObjectLastError veya null	Bu çalıştırmayla ilişkili son hata. Hata yoksa olacaktır `null` .	Evet
max_completion_tokens	tamsayı veya null	Çalıştırma boyunca kullanılmak üzere belirtilen en fazla tamamlanma belirteci sayısı.	Evet
max_prompt_tokens	tamsayı veya null	Çalıştırma boyunca kullanılmak üzere belirtilen en fazla istem belirteci sayısı.	Evet
metadata	OpenAI.Metadata veya null		Evet
model	String	Yardımcının bu çalıştırma için kullandığı model.	Evet
nesne	enum	Her zaman `thread.run`olan nesne türü. Olası değerler: `thread.run`	Evet
paralel araç çağrıları	OpenAI.ParallelToolCalls	Araç kullanımı sırasında paralel işlev çağrısının etkinleştirilip etkinleştirilmeyileceği.	Evet
required_action	OpenAI.RunObjectRequiredAction veya null	Çalıştırmaya devam etmek için gereken eylemle ilgili ayrıntılar. Herhangi bir eylem gerekli değilse olacaktır `null` .	Evet
yanıt formatı	OpenAI.AssistantsApiResponseFormatOption	Modelin çıkış yapması gereken biçimi belirtir. GPT-4o, GPT-4 Turbo ve tüm `gpt-3.5-turbo-1106`GPT-3.5 Turbo modelleri ile uyumludur. ayarı, `{ "type": "json_schema", "json_schema": {...} }` modelin sağlanan JSON şemanızla eşleşmesini sağlayan Yapılandırılmış Çıkışlar'ı etkinleştirir. Daha fazla bilgi için ayarı `{ "type": "json_object" }` , modelin oluşturduğu iletinin geçerli bir JSON olduğundan emin olan JSON modunu etkinleştirir. Önemli:* JSON modunu kullanırken, modele bir sistem veya kullanıcı iletisi aracılığıyla kendiniz JSON üretmesini de belirtmeniz gerekir . Bu olmadan model, nesil belirteç sınırına ulaşana kadar bitmeyen bir boşluk akışı oluşturabilir ve bu da uzun süre çalışan ve görünüşe göre "takılmış" bir istekle sonuçlanır. Ayrıca, neslin aşıldığını veya konuşmanın maksimum bağlam uzunluğunu aştığını `finish_reason="length"` gösteren ileti `max_tokens`içeriğinin kısmen kesilebileceğini unutmayın.	Evet
started_at	dize veya null	Çalıştırmanın başlatıldığı zaman için Unix zaman damgası (saniye olarak).	Evet
durum	OpenAI.RunStatus	Çalıştırmanın durumu ; , `in_progress`, , `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`veya `expired`olabilir`queued`.	Evet
sıcaklık	sayı veya null	Bu çalıştırma için kullanılan örnekleme sıcaklığı. Ayarlanmadıysa, varsayılan olarak 1 olur.	Hayı
thread_id	String	Bu çalıştırmanın bir parçası olarak üzerinde yürütülen iş parçacığının kimliği.	Evet
tool_choice	OpenAI.AssistantsApiToolChoiceOption	Model tarafından çağrılan aracı (varsa) denetler. `none` modelin herhangi bir araç çağırmayacağı ve bunun yerine bir ileti oluşturduğu anlamına gelir. `auto` varsayılan değerdir ve modelin ileti oluşturma veya bir veya daha fazla araç çağırma arasında seçim yapabileceğiniz anlamına gelir. `required` , modelin kullanıcıya yanıt vermeden önce bir veya daha fazla araç çağırması gerektiği anlamına gelir. veya gibi `{"type": "file_search"}{"type": "function", "function": {"name": "my_function"}}` belirli bir aracı belirtmek, modeli söz konusu aracı çağırmaya zorlar.	Evet
araçlar	OpenAI.AssistantTool dizisi	Yardımcının bu çalıştırma için kullandığı araçların listesi.	Evet	[]
top_p	sayı veya null	Bu çalıştırma için kullanılan çekirdek örnekleme değeri. Ayarlanmadıysa, varsayılan olarak 1 olur.	Hayı
truncation_strategy	OpenAI.TruncationObject	Bir iş parçacığının çalıştırmadan önce nasıl kesileceğini denetler. Çalıştırmanın ilk bağlam penceresini denetlemek için bunu kullanın.	Evet
usage	OpenAI.RunCompletionUsage veya null		Evet

OpenAI.RunObjectIncompleteDetails

İsim	Türü	Description	Gerekli	Varsayılan
sebep	enum	Olası değerler: `max_completion_tokens`, `max_prompt_tokens`	Hayı

OpenAI.RunObjectLastError

İsim	Türü	Description	Gerekli	Varsayılan
kod	enum	Olası değerler: `server_error`, `rate_limit_exceeded`, `invalid_prompt`	Evet
mesaj	String		Evet

OpenAI.RunObjectRequiredAction

İsim	Türü	Description	Gerekli	Varsayılan
submit_tool_outputs	OpenAI.RunObjectRequiredActionSubmitToolOutputs		Evet
type	enum	Olası değerler: `submit_tool_outputs`	Evet

OpenAI.RunObjectRequiredActionSubmitToolOutputs

İsim	Türü	Description	Gerekli	Varsayılan
tool_calls	OpenAI.RunToolCallObject dizisi		Evet

OpenAI.RunStatus

Çalıştırmanın durumu ; , in_progress, , requires_action, cancelling, cancelled, failed, completed, incompleteveya expiredolabilirqueued.

Mülkiyet	Değer
Türü	String
Değerler	`queued` `in_progress` `requires_action` `cancelling` `cancelled` `failed` `completed` `incomplete` `expired`

OpenAI.RunStepCompletionUsage

Çalıştırma adımıyla ilgili kullanım istatistikleri. Bu değer, çalıştırma adımının durumu olduğunda nullolurin_progress.

İsim	Türü	Description	Gerekli
completion_tokens	tamsayı	Çalıştırma adımı boyunca kullanılan tamamlama belirteçlerinin sayısı.	Evet
prompt_tokens	tamsayı	Çalıştırma adımı boyunca kullanılan istem belirteçlerinin sayısı.	Evet
total_tokens	tamsayı	Kullanılan toplam belirteç sayısı (istem + tamamlama).	Evet

OpenAI.RunStepDetailsMessageCreationObject

Çalıştırma adımına göre ileti oluşturma işleminin ayrıntıları.

İsim	Türü	Description	Gerekli	Varsayılan
message_creation	OpenAI.RunStepDetailsMessageCreationObjectMessageCreation		Evet
type	enum	Her zaman `message_creation`. Olası değerler: `message_creation`	Evet

OpenAI.RunStepDetailsMessageCreationObjectMessageCreation

İsim	Türü	Description	Gerekli	Varsayılan
message_id	String		Evet

OpenAI.RunStepDetailsToolCall

OpenAI.RunStepDetailsToolCall 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_interpreter`	OpenAI.RunStepDetailsToolCallsCodeObject
`file_search`	OpenAI.RunStepDetailsToolCallsFileSearchObject
`function`	OpenAI.RunStepDetailsToolCallsFunctionObject

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.RunStepDetailsToolCallType		Evet

OpenAI.RunStepDetailsToolCallType

Mülkiyet	Değer
Türü	String
Değerler	`code_interpreter` `file_search` `function`

OpenAI.RunStepDetailsToolCallsCodeObject

Çalıştırma adımının dahil olduğu Kod Yorumlayıcı aracı çağrısının ayrıntıları.

İsim	Türü	Description	Gerekli
code_interpreter	OpenAI.RunStepDetailsToolCallsCodeObjectCodeInterpreter		Evet
└─ giriş	String		Evet
└─ çıkışlar	OpenAI.RunStepDetailsToolCallsCodeOutputLogsObject veya OpenAI.RunStepDetailsToolCallsCodeOutputImageObject dizisi		Evet
kimlik	String	Araç çağrısının kimliği.	Evet
type	enum	Araç çağrısının türü. Bu her zaman bu tür bir araç çağrısı için olacaktır `code_interpreter` . Olası değerler: `code_interpreter`	Evet

OpenAI.RunStepDetailsToolCallsCodeObjectCodeInterpreter

İsim	Türü	Description	Gerekli	Varsayılan
girdi	String		Evet
Çıktılar	OpenAI.RunStepDetailsToolCallsCodeOutputLogsObject veya OpenAI.RunStepDetailsToolCallsCodeOutputImageObject dizisi		Evet

OpenAI.RunStepDetailsToolCallsCodeOutputImageObject

İsim	Türü	Description	Gerekli	Varsayılan
image	OpenAI.RunStepDetailsToolCallsCodeOutputImageObjectImage		Evet
type	enum	Her zaman `image`. Olası değerler: `image`	Evet

OpenAI.RunStepDetailsToolCallsCodeOutputImageObjectImage

İsim	Türü	Description	Gerekli	Varsayılan
dosya_kimlik	String		Evet

OpenAI.RunStepDetailsToolCallsCodeOutputLogsObject

Çalıştırma adımının bir parçası olarak Kod Yorumlayıcı aracı çağrısından metin çıktısı.

İsim	Türü	Description	Gerekli	Varsayılan
logs	String	Kod Yorumlayıcı araç çağrısından metin çıkışı.	Evet
type	enum	Her zaman `logs`. Olası değerler: `logs`	Evet

OpenAI.RunStepDetailsToolCallsFileSearchObject

İsim	Türü	Description	Gerekli
file_search	OpenAI.RunStepDetailsToolCallsFileSearchObjectFileSearch		Evet
└─ ranking_options	OpenAI.RunStepDetailsToolCallsFileSearchRankingOptionsObject	Dosya araması için derecelendirme seçenekleri.	Hayı
└─ sonuçlar	OpenAI.RunStepDetailsToolCallsFileSearchResultObject dizisi		Hayı
kimlik	String	Araç çağrısı nesnesinin kimliği.	Evet
type	enum	Araç çağrısının türü. Bu her zaman bu tür bir araç çağrısı için olacaktır `file_search` . Olası değerler: `file_search`	Evet

OpenAI.RunStepDetailsToolCallsFileSearchObjectFileSearch

İsim	Türü	Description	Gerekli	Varsayılan
Sıralama_seçenekleri	OpenAI.RunStepDetailsToolCallsFileSearchRankingOptionsObject	Dosya araması için derecelendirme seçenekleri.	Hayı
results	OpenAI.RunStepDetailsToolCallsFileSearchResultObject dizisi		Hayı

OpenAI.RunStepDetailsToolCallsFileSearchRankingOptionsObject

Dosya araması için derecelendirme seçenekleri.

İsim	Türü	Description	Gerekli	Varsayılan
sıralayıcı	OpenAI.FileSearchRanker	Dosya araması için kullanılacak dereceleyici. Belirtilmezse `auto` ranker kullanılır.	Evet
puan_eşik_değeri	Numara	Dosya araması için puan eşiği. Tüm değerler 0 ile 1 arasında kayan noktalı bir sayı olmalıdır. Kısıtlamalar: min: 0, max: 1	Evet

OpenAI.RunStepDetailsToolCallsFileSearchResultObject

Dosya aramasının sonuç örneği.

İsim	Türü	Description	Gerekli
içerik	OpenAI.RunStepDetailsToolCallsFileSearchResultObjectContent dizisi	Bulunan sonucun içeriği. İçerik yalnızca ekleme sorgusu parametresi aracılığıyla istenirse eklenir.	Hayı
dosya_kimlik	String	Sonucun bulunduğu dosyanın kimliği.	Evet
dosya_adı	String	Sonucun bulunduğu dosyanın adı.	Evet
Puan	Numara	Sonucun puanı. Tüm değerler 0 ile 1 arasında kayan noktalı bir sayı olmalıdır. Kısıtlamalar: min: 0, max: 1	Evet

OpenAI.RunStepDetailsToolCallsFileSearchResultObjectContent

İsim	Türü	Description	Gerekli	Varsayılan
text	String		Hayı
type	enum	Olası değerler: `text`	Hayı

OpenAI.RunStepDetailsToolCallsFunctionObject

İsim	Türü	Description	Gerekli
function	OpenAI.RunStepDetailsToolCallsFunctionObjectFunction		Evet
└─ argümanlar	String		Evet
└─ ad	String		Evet
└─ çıkış	dize veya null		Evet
kimlik	String	Araç çağrısı nesnesinin kimliği.	Evet
type	enum	Araç çağrısının türü. Bu her zaman bu tür bir araç çağrısı için olacaktır `function` . Olası değerler: `function`	Evet

OpenAI.RunStepDetailsToolCallsFunctionObjectFunction

İsim	Türü	Gerekli
arguments	String	Evet
name	String	Evet
çıktı	dize veya null	Evet

OpenAI.RunStepDetailsToolCallsObject

Araç çağrısının ayrıntıları.

İsim	Türü	Description	Gerekli	Varsayılan
tool_calls	OpenAI.RunStepDetailsToolCall dizisi	Çalıştırma adımının dahil olduğu bir araç çağrısı dizisi. Bunlar üç araç türünden biriyle ilişkilendirilebilir: `code_interpreter`, `file_search`veya `function`.	Evet
type	enum	Her zaman `tool_calls`. Olası değerler: `tool_calls`	Evet

OpenAI.RunStepObject

Çalıştırmanın yürütülmesindeki bir adımı temsil eder.

İsim	Türü	Description	Gerekli
assistant_id	String	Çalıştırma adımıyla ilişkili yardımcının kimliği.	Evet
iptal edildiğinde	dize veya null		Evet
tamamlanma_tarihi	dize veya null		Evet
oluşturulma_tarihi	tamsayı	Çalıştırma adımının oluşturulduğu zaman için Unix zaman damgası (saniye olarak).	Evet
süresi dolma tarihi	dize veya null		Evet
başarısız_olduğunda	dize veya null		Evet
kimlik	String	API uç noktalarında başvurulabilen çalıştırma adımının tanımlayıcısı.	Evet
Son_hata	OpenAI.RunStepObjectLastError veya null		Evet
metadata	OpenAI.Metadata veya null		Evet
nesne	enum	Her zaman `thread.run.step`olan nesne türü. Olası değerler: `thread.run.step`	Evet
run_id	String	Bu çalıştırma adımının parçası olduğu çalıştırmanın kimliği.	Evet
durum	enum	Çalıştırma adımının durumu ; , `cancelled`, `failed`, `completed`veya `expired`olabilir`in_progress`. Olası değerler: `in_progress`, `cancelled`, `failed`, `completed`, `expired`	Evet
step_details	OpenAI.RunStepDetailsMessageCreationObject veya OpenAI.RunStepDetailsToolCallsObject	Çalıştırma adımının ayrıntıları.	Evet
thread_id	String	Çalıştırılan iş parçacığının kimliği.	Evet
type	enum	veya `message_creation`olabilecek `tool_calls` çalıştırma adımının türü. Olası değerler: `message_creation`, `tool_calls`	Evet
usage	OpenAI.RunStepCompletionUsage	Çalıştırma adımıyla ilgili kullanım istatistikleri. Bu değer, çalıştırma adımının durumu olduğunda `null`olur`in_progress`.	Evet

OpenAI.RunStepObjectLastError

İsim	Türü	Description	Gerekli	Varsayılan
kod	enum	Olası değerler: `server_error`, `rate_limit_exceeded`	Evet
mesaj	String		Evet

OpenAI.RunToolCallObject

Araç çağrısı nesneleri

İsim	Türü	Description	Gerekli
function	OpenAI.RunToolCallObjectFunction		Evet
└─ argümanlar	String		Evet
└─ ad	String		Evet
kimlik	String	Araç çağrısının kimliği. Uç noktayı çalıştırmak için Araç çıkışlarını gönder'i kullanarak içindeki araç çıkışlarını gönderdiğinizde bu kimlik belirtilmelidir .	Evet
type	enum	Çıktının gerekli olduğu araç çağrısı türü. Şimdilik, bu her zaman `function`. Olası değerler: `function`	Evet

OpenAI.RunToolCallObjectFunction

İsim	Türü	Description	Gerekli	Varsayılan
arguments	String		Evet
name	String		Evet

OpenAI.Ekran Görüntüsü

Ekran görüntüsü alma işlemi.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olay türünü belirtir. Ekran görüntüsü eylemi için bu özellik her zaman `screenshot` olarak ayarlanır. Olası değerler: `screenshot`	Evet

OpenAI.Scroll

Kaydırma eylemi.

İsim	Türü	Description	Gerekli
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 belirtilmiştir. 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.SearchContextSize

Mülkiyet	Değer
Türü	String
Değerler	`low` `medium` `high`

OpenAI.SpecificApplyPatchParam

Bir araç çağrısı yürütürken modeli apply_patch aracını çağırmaya zorlar.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Çağrılacak araç. Her zaman `apply_patch`. Olası değerler: `apply_patch`	Evet

OpenAI.SpecificFunctionShellParam

Bir araç çağrısı gerektiğinde modeli kabuk aracını çağırmaya zorlar.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Çağrılacak araç. Her zaman `shell`. Olası değerler: `shell`	Evet

OpenAI.StaticChunkingStrategy

İsim	Türü	Description	Gerekli	Varsayılan
blok_örtüşen_tokenlar	tamsayı	Öbekler arasında çakışan belirteçlerin sayısı. Varsayılan değer `400` değeridir. Çakışmanın yarısını `max_chunk_size_tokens`aşmaması gerektiğini unutmayın.	Evet
maksimum_parça_boyutu_jetonlar	tamsayı	Her öbekteki en fazla belirteç sayısı. Varsayılan değer `800` değeridir. En düşük değer, `100` en büyük değer ise şeklindedir `4096`. Kısıtlamalar: dk: 100, maksimum: 4096	Evet

OpenAI.StaticChunkingStrategyRequestParam

Öbek boyutu ve öbek çakışması ayarlayarak kendi öbekleme stratejinizi özelleştirin.

İsim	Türü	Description	Gerekli	Varsayılan
durağan	OpenAI.StaticChunkingStrategy		Evet
type	enum	Her zaman `static`. Olası değerler: `static`	Evet

OpenAI.StaticChunkingStrategyResponseParam

İsim	Türü	Description	Gerekli	Varsayılan
durağan	OpenAI.StaticChunkingStrategy		Evet
type	enum	Her zaman `static`. Olası değerler: `static`	Evet

OpenAI.StopConfiguration

En son mantık modelleri o3 ve o4-miniile desteklenmez. API'nin başka belirteçler üretmeyi durduracağı en fazla dört dizi. Döndürülen metin durdurma sırasını içermez.

Bu şema aşağıdaki türlerden birini kabul eder:

array
sıfır

OpenAI.SubmitToolOutputsRunRequest

İsim	Türü	Description	Gerekli	Varsayılan
veri akışı	boole veya null		Hayı
tool_outputs	OpenAI.SubmitToolOutputsRunRequestToolOutputs dizisi	Çıkışların gönderildiği araçların listesi.	Evet

OpenAI.SubmitToolOutputsRunRequestToolOutputs

İsim	Türü	Description	Gerekli	Varsayılan
çıktı	String		Hayı
tool_call_id	String		Hayı

OpenAI.Summary

Modelden özet metin.

İsim	Türü	Description	Gerekli	Varsayılan
text	String	Modelden şimdiye kadar elde edilen mantık çıkarlarının özeti.	Evet
type	enum	Nesnenin türü. Her zaman `summary_text`. Olası değerler: `summary_text`	Evet

OpenAI.SummaryTextContent

Modelden özet metin.

İsim	Türü	Description	Gerekli	Varsayılan
text	String	Modelden şimdiye kadar elde edilen mantık çıkarlarının özeti.	Evet
type	enum	Nesnenin türü. Her zaman `summary_text`. Olası değerler: `summary_text`	Evet

OpenAI.TextAnnotation

OpenAI.TextAnnotation 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.MessageContentTextAnnotationsFileCitationObject
`file_path`	OpenAI.MessageContentTextAnnotationsFilePathObject

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.TextAnnotationType		Evet

OpenAI.TextAnnotationType

Mülkiyet	Değer
Türü	String
Değerler	`file_citation` `file_path`

OpenAI.TextContent

Metin içeriği.

İsim	Türü	Description	Gerekli	Varsayılan
text	String		Evet
type	enum	Olası değerler: `text`	Evet

OpenAI.TextResponseFormatConfiguration

Modelin çıkış yapması gereken biçimi belirten bir nesne. Yapılandırma { "type": "json_schema" } , modelin sağlanan JSON şemanızla eşleşmesini sağlayan Yapılandırılmış Çıkışlar'ı etkinleştirir. Daha fazla bilgi için

Varsayılan biçim { "type": "text" } ek seçenek yoktur. gpt-4o ve daha yeni modeller için önerilmez:* Modelin oluşturduğu mesajın geçerli olmasını sağlayan eski JSON modunu etkinleştirmek için ayar { "type": "json_object" } . Destekleyen modeller için json_schema kullanılması tercih edilir.

OpenAI.TextResponseFormatConfiguration için Ayrıştırıcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
`json_schema`	OpenAI.TextResponseFormatJsonSchema
`text`	OpenAI.TextResponseFormatConfigurationResponseFormatText
`json_object`	OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.TextResponseFormatConfigurationType		Evet

OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Tanımlanan yanıt biçiminin türü. Her zaman `json_object`. Olası değerler: `json_object`	Evet

OpenAI.TextResponseFormatConfigurationResponseFormatText

Varsayılan yanıt biçimi. Metin yanıtları oluşturmak için kullanılır.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Tanımlanan yanıt biçiminin türü. Her zaman `text`. Olası değerler: `text`	Evet

OpenAI.TextResponseFormatConfigurationType

Mülkiyet	Değer
Türü	String
Değerler	`text` `json_schema` `json_object`

OpenAI.TextResponseFormatJsonSchema

JSON Şeması yanıt biçimi. Yapılandırılmış JSON yanıtları oluşturmak için kullanılır. Yapılandırılmış Çıktılar hakkında daha fazla bilgi edinin.

İsim	Türü	Description	Gerekli
açıklama	String	Model tarafından kullanılan yanıt biçiminin ne için olduğuna dair bir açıklama. Yanıt formatını nasıl belirleyeceğinizi öğrenin.	Hayı
name	String	Yanıt biçiminin adı. a-z, A-Z, 0-9 veya bunları içermelidir alt çizgi ve tirelerden oluşan, maksimum uzunluk 64 karakterdir.	Evet
şema	OpenAI.YanıtFormatıJsonŞemaŞeması	JSON Şeması nesnesi olarak tanımlanan yanıt biçimi şeması. JSON şemaları oluşturmayı buradan öğrenin.	Evet
Kesin	boole veya null		Hayı
type	enum	Tanımlanan yanıt biçiminin türü. Her zaman `json_schema`. Olası değerler: `json_schema`	Evet

OpenAI.ThreadObject

İleti içeren bir iş parçacığını temsil eder.

İsim	Türü	Description	Gerekli
oluşturulma_tarihi	tamsayı	İş parçacığının oluşturulduğu zaman için Unix zaman damgası (saniye olarak).	Evet
kimlik	String	API uç noktalarında başvurulabilen tanımlayıcı.	Evet
metadata	OpenAI.Metadata veya null		Evet
nesne	enum	Her zaman `thread`olan nesne türü. Olası değerler: `thread`	Evet
tool_resources	OpenAI.ThreadObjectToolResources veya null		Evet

OpenAI.ThreadObjectToolResources

İsim	Türü	Description	Gerekli	Varsayılan
code_interpreter	OpenAI.ThreadObjectToolResourcesCodeInterpreter		Hayı
file_search	OpenAI.ThreadObjectToolResourcesFileSearch		Hayı

OpenAI.ThreadObjectToolResourcesCodeInterpreter

İsim	Türü	Description	Gerekli	Varsayılan
dosya_kimlikleri	dize dizisi		Hayı

OpenAI.ThreadObjectToolResourcesFileSearch

İsim	Türü	Description	Gerekli	Varsayılan
vector_store_ids	dize dizisi		Hayı

OpenAI.TokenLimits

İsim	Türü	Description	Gerekli	Varsayılan
post_instructions	tamsayı	Kısıtlamalar: dk: 0	Hayı

OpenAI.Tool

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

OpenAI.Tool için Ayırıcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
`code_interpreter`	OpenAI.CodeInterpreterTool
`function`	OpenAI.FunctionTool
`file_search`	OpenAI.FileSearchTool
`computer_use_preview`	OpenAI.ComputerUsePreviewTool
`web_search`	OpenAI.WebSearchTool
`mcp`	OpenAI.MCPTool
`image_generation`	OpenAI.ImageGenTool
`local_shell`	OpenAI.LocalShellToolParam
`shell`	OpenAI.FunctionShellToolParam
`custom`	OpenAI.CustomToolParam
`web_search_preview`	OpenAI.WebSearchPreviewTool
`apply_patch`	OpenAI.ApplyPatchToolParam

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.ToolType		Evet

OpenAI.ToolChoiceAllowed

Modelin kullanabileceği araçları önceden tanımlanmış bir kümeyle kısıtlar.

İsim	Türü	Description	Gerekli
modu	enum	Modelin kullanabileceği araçları önceden tanımlanmış bir kümeyle kısıtlar. `auto` modelin izin verilen araçlar arasından seçim yapmasına ve Mesaj. `required` modelin izin verilen araçlardan birini veya daha fazlasını çağırmasını gerektirir. Olası değerler: `auto`, `required`	Evet
araçlar	nesne dizisi	Modelin çağırmasına izin verilmesi gereken araç tanımlarının listesi. Yanıtlar API'sinde araç tanımlarının listesi şöyle görünebilir: `json<br> [<br> { "type": "function", "name": "get_weather" },<br> { "type": "mcp", "server_label": "deepwiki" },<br> { "type": "image_generation" }<br> ]<br>`	Evet
type	enum	İzin verilen araç yapılandırma türü. Her zaman `allowed_tools`. Olası değerler: `allowed_tools`	Evet

OpenAI.ToolChoiceCodeInterpreter

Modelin bir yanıt oluşturmak için yerleşik bir araç kullanması gerektiğini gösterir. Yerleşik araçlar hakkında daha fazla bilgi edinin.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olası değerler: `code_interpreter`	Evet

OpenAI.ToolChoiceComputerUsePreview

Modelin bir yanıt oluşturmak için yerleşik bir araç kullanması gerektiğini gösterir. Yerleşik araçlar hakkında daha fazla bilgi edinin.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olası değerler: `computer_use_preview`	Evet

OpenAI.ToolChoiceCustom

Modeli belirli bir özel aracı çağırmaya zorlamak için bu seçeneği kullanın.

İsim	Türü	Description	Gerekli	Varsayılan
name	String	Çağrılacak özel aracın adı.	Evet
type	enum	Özel araç çağrısı için türü her zaman `custom`şeklindedir. Olası değerler: `custom`	Evet

OpenAI.ToolChoiceFileSearch

Modelin bir yanıt oluşturmak için yerleşik bir araç kullanması gerektiğini gösterir. Yerleşik araçlar hakkında daha fazla bilgi edinin.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olası değerler: `file_search`	Evet

OpenAI.ToolChoiceFunction

Modeli belirli bir işlevi çağırmaya zorlamak için bu seçeneği kullanın.

İsim	Türü	Description	Gerekli	Varsayılan
name	String	Çağrılacak işlevin adı.	Evet
type	enum	İşlev çağrısı için türü her zaman `function`şeklindedir. Olası değerler: `function`	Evet

OpenAI.ToolChoiceImageGeneration

Modelin bir yanıt oluşturmak için yerleşik bir araç kullanması gerektiğini gösterir. Yerleşik araçlar hakkında daha fazla bilgi edinin.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olası değerler: `image_generation`	Evet

OpenAI.ToolChoiceMCP

Modeli uzak bir MCP sunucusunda belirli bir aracı çağırmaya zorlamak için bu seçeneği kullanın.

İsim	Türü	Description	Gerekli
name	dize veya null		Hayı
sunucu etiketi	String	Kullanılacak MCP sunucusunun etiketi.	Evet
type	enum	MCP araçları için türü her zaman `mcp`şeklindedir. Olası değerler: `mcp`	Evet

OpenAI.ToolChoiceOptions

Mülkiyet	Değer
Türü	String
Değerler	`none` `auto` `required`

OpenAI.ToolChoiceParam

Modelin yanıt oluştururken kullanılacak aracı (veya araçları) seçmesi gerekir. Modelin hangi araçları çağırabileceğini belirtmek için tools parametresine bakın.

OpenAI.ToolChoiceParam için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
`allowed_tools`	OpenAI.ToolChoiceAllowed
`mcp`	OpenAI.ToolChoiceMCP
`custom`	OpenAI.ToolChoiceCustom
`apply_patch`	OpenAI.SpecificApplyPatchParam
`shell`	OpenAI.SpecificFunctionShellParam
`file_search`	OpenAI.ToolChoiceFileSearch
`web_search_preview`	OpenAI.ToolChoiceWebSearchPreview
`computer_use_preview`	OpenAI.ToolChoiceComputerUsePreview
`web_search_preview_2025_03_11`	OpenAI.ToolChoiceWebSearchPreview20250311
`image_generation`	OpenAI.ToolChoiceImageGeneration
`code_interpreter`	OpenAI.ToolChoiceCodeInterpreter

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.ToolChoiceParamType		Evet

OpenAI.ToolChoiceParamType

Mülkiyet	Değer
Türü	String
Değerler	`allowed_tools` `function` `mcp` `custom` `apply_patch` `shell` `file_search` `web_search_preview` `computer_use_preview` `web_search_preview_2025_03_11` `image_generation` `code_interpreter`

OpenAI.ToolChoiceWebSearchPreview

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

Modelin bir yanıt oluşturmak için yerleşik bir araç kullanması gerektiğini gösterir. Yerleşik araçlar hakkında daha fazla bilgi edinin.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olası değerler: `web_search_preview_2025_03_11`	Evet

OpenAI.ToolType

Mülkiyet	Değer
Türü	String
Değerler	`function` `file_search` `computer_use_preview` `web_search` `mcp` `code_interpreter` `image_generation` `local_shell` `shell` `custom` `web_search_preview` `apply_patch`

OpenAI.ToolsArray

Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Parametresini ayarlayarak tool_choice hangi aracın kullanılacağını belirtebilirsiniz. Aşağıdaki araç kategorilerini destekliyoruz:

Yerleşik araçlar: OpenAI tarafından sağlanan ve modelin yeteneklerini genişleten araçlar, örneğin web arama veya dosya arama gibi. yerleşik araçlar.
MCP Araçları: Özel MCP sunucuları veya Google Drive ve SharePoint gibi önceden tanımlanmış bağlayıcılar aracılığıyla üçüncü taraf sistemlerle tümleştirmeler. MCP Tools hakkında daha fazla bilgi edinin.
İşlev çağrıları (özel araçlar): Sizin tanımladığınız işlevler, modelin kesin olarak yazılan bağımsız değişkenler ve çıkışlarla kendi kodunuzu çağırmasını sağlar. function calling hakkında daha fazla bilgi edinin. Kendi kodunuzu çağırmak için özel araçlar da kullanabilirsiniz.

Dizisi: OpenAI.Tool

OpenAI.TopLogProb

Bir belirtecin en yüksek logaritmik olasılığı.

İsim	Türü	Gerekli
bytes	tamsayı dizisi	Evet
logprob	Numara	Evet
token	String	Evet

OpenAI.TranscriptionSegment

İsim	Türü	Description	Gerekli
avg_logprob	Numara	Segmentin ortalama logprob'ı. Değer -1'den küçükse logprobs'un başarısız olduğunu düşünün.	Evet
compression_ratio	Numara	Segmentin sıkıştırma oranı. Değer 2,4'ten büyükse sıkıştırmanın başarısız olduğunu düşünün.	Evet
son	Numara	Segmentin bitiş saati saniye olarak.	Evet
kimlik	tamsayı	Segmentin benzersiz tanımlayıcısı.	Evet
no_speech_prob	Numara	Segmentte konuşma olmaması olasılığı. Değer 1,0'dan yüksekse ve `avg_logprob` değeri -1'in altındaysa, bu kesimi sessiz olarak düşünün.	Evet
seek	tamsayı	Segmentin uzaklığını arayın.	Evet
start	Numara	Saniye olarak segmentin başlangıç zamanı.	Evet
sıcaklık	Numara	Segmenti oluşturmak için kullanılan sıcaklık parametresi.	Evet
text	String	Segmentin metin içeriği.	Evet
tokens	tamsayı dizisi	Metin içeriğinin belirteç kimlikleri dizisi.	Evet

OpenAI.TranscriptionWord

İsim	Türü	Description	Gerekli
son	Numara	Sözcüğün bitiş süresi saniye cinsinden.	Evet
start	Numara	Sözcüğün başlangıç zamanı saniye cinsinden.	Evet
word	String	Sözcüğün metin içeriği.	Evet

OpenAI.TruncationObject

Bir iş parçacığının çalıştırmadan önce nasıl kesileceğini denetler. Çalıştırmanın ilk bağlam penceresini denetlemek için bunu kullanın.

İsim	Türü	Description	Gerekli	Varsayılan
last_messages	tamsayı veya null		Hayı
type	enum	İş parçacığı için kullanılacak kesme stratejisi. Varsayılan değer: `auto`. olarak ayarlanırsa `last_messages`, iş parçacığı iş parçacığındaki n en son iletiye kesilir. olarak `auto`ayarlandığında, iş parçacığının ortasındaki iletiler, modelin `max_prompt_tokens`bağlam uzunluğuna uyacak şekilde bırakılır. Olası değerler: `auto`, `last_messages`	Evet

OpenAI.Type

Metin yazmak için bir eylem.

İsim	Türü	Description	Gerekli	Varsayılan
text	String	Yazılacak metin.	Evet
type	enum	Olay türünü belirtir. Tip eylemi için bu özellik her zaman `type` olarak ayarlanır. Olası değerler: `type`	Evet

OpenAI.UpdateConversationBody

İsim	Türü	Description	Gerekli	Varsayılan
metadata	OpenAI.Metadata veya null	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.	Evet

OpenAI.UpdateVectorStoreFileAttributesRequest

İsim	Türü	Description	Gerekli	Varsayılan
attributes	OpenAI.VectorStoreFileAttributes veya null		Evet

OpenAI.VektörMağazasıGüncellemeİsteği

İsim	Türü	Description	Gerekli
sona_erdikten_sonra	OpenAI.VectorStoreExpirationAfter	Vektör deposu için sona erme politikası.	Hayı
metadata	OpenAI.Metadata veya null		Hayı
name	dize veya null	Vektör deposunun adı.	Hayı

OpenAI.UrlCitationBody

Model yanıtı oluşturmak için kullanılan bir web kaynağı alıntısı.

İsim	Türü	Description	Gerekli
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.ValidateGraderResponse

İsim	Türü	Description	Gerekli	Varsayılan
Yol tesviye makinesi	OpenAI.GraderStringCheck veya OpenAI.GraderTextSimilarity veya OpenAI.GraderPython veya OpenAI.GraderScoreModel ya da OpenAI.GraderMulti veya GraderEndpoint	İnce ayar işi için kullanılan not veren.	Hayı

OpenAI.VectorStoreExpirationAfter

Vektör deposu için sona erme politikası.

İsim	Türü	Description	Gerekli	Varsayılan
anchor	enum	Son kullanım ilkesinin uygulanacağı referans zaman damgası. Desteklenen tutturucular: `last_active_at`. Olası değerler: `last_active_at`	Evet
Günler	tamsayı	Vektör deposunun süresinin dolacağı referans zamanından sonraki gün sayısı. Kısıtlamalar: dk: 1, maksimum: 365	Evet

OpenAI.VectorStoreFileAttributes

Tür: nesne

OpenAI.VectorStoreFileBatchObject

Vektör deposuna eklenmiş bir dosya grubu.

İsim	Türü	Description	Gerekli
oluşturulma_tarihi	tamsayı	Vektör depolama dosyaları toplu işleminin oluşturulduğu zaman için Unix zaman damgası (saniye cinsinden).	Evet
dosya_sayıları	OpenAI.VectorStoreFileBatchObjectFileCounts		Evet
kimlik	String	API uç noktalarında başvurulabilen tanımlayıcı.	Evet
nesne	enum	Her zaman `vector_store.file_batch`olan nesne türü. Olası değerler: `vector_store.files_batch`	Evet
durum	enum	Vektör deposu dosyaları toplu işleminin durumu , veya `in_progress`olabilir`completedcancelledfailed`. Olası değerler: `in_progress`, `completed`, `cancelled`, `failed`	Evet
vektör_depolama_kimliği	String	Dosyanın bağlı olduğu vektör deposunun kimliği.	Evet

OpenAI.VectorStoreFileBatchObjectFileCounts

İsim	Türü	Gerekli
cancelled	tamsayı	Evet
Tamamlandı	tamsayı	Evet
başarısız	tamsayı	Evet
in_progress	tamsayı	Evet
toplam	tamsayı	Evet

OpenAI.VectorStoreFileObject

Vektör deposuna eklenmiş dosyaların listesi.

İsim	Türü	Description	Gerekli
attributes	OpenAI.VectorStoreFileAttributes veya null		Hayı
chunking_strategy	OpenAI.ChunkingStrategyResponse	Dosyayı öbeklemek için kullanılan strateji.	Hayı
oluşturulma_tarihi	tamsayı	Vektör deposu dosyasının oluşturulduğu zaman için Unix zaman damgası (saniye olarak).	Evet
kimlik	String	API uç noktalarında başvurulabilen tanımlayıcı.	Evet
Son_hata	OpenAI.VectorStoreFileObjectLastError veya null		Evet
nesne	enum	Her zaman `vector_store.file`olan nesne türü. Olası değerler: `vector_store.file`	Evet
durum	enum	, , `in_progress`veya `completed`olabilir `cancelledfailed`vektör deposu dosyasının durumu. Durum `completed` , vektör deposu dosyasının kullanıma hazır olduğunu gösterir. Olası değerler: `in_progress`, `completed`, `cancelled`, `failed`	Evet
kullanım_baytları	tamsayı	Bayt cinsinden toplam vektör deposu kullanımı. Bunun özgün dosya boyutundan farklı olabileceğini unutmayın.	Evet
vektör_depolama_kimliği	String	Dosyanın bağlı olduğu vektör deposunun kimliği.	Evet

OpenAI.VectorStoreFileObjectLastError

İsim	Türü	Description	Gerekli	Varsayılan
kod	enum	Olası değerler: `server_error`, `unsupported_file`, `invalid_file`	Evet
mesaj	String		Evet

OpenAI.VectorStoreObject

Vektör deposu, araç tarafından file_search kullanılabilecek işlenmiş dosya koleksiyonudur.

İsim	Türü	Description	Gerekli
oluşturulma_tarihi	tamsayı	Vektör deposunun oluşturulduğu zaman için Unix zaman damgası (saniye olarak).	Evet
sona_erdikten_sonra	OpenAI.VectorStoreExpirationAfter	Vektör deposu için sona erme politikası.	Hayı
sona_erdigi_tarih	dize veya null		Hayı
dosya_sayıları	OpenAI.VectorStoreObjectFileCounts		Evet
kimlik	String	API uç noktalarında başvurulabilen tanımlayıcı.	Evet
son etkinlik zamanı	dize veya null		Evet
metadata	OpenAI.Metadata veya null		Evet
name	String	Vektör deposunun adı.	Evet
nesne	enum	Her zaman `vector_store`olan nesne türü. Olası değerler: `vector_store`	Evet
durum	enum	, veya `expired`olabilir `in_progresscompleted`vektör deposunun durumu. durumu `completed` , vektör deposunun kullanıma hazır olduğunu gösterir. Olası değerler: `expired`, `in_progress`, `completed`	Evet
kullanım_baytları	tamsayı	Vektör deposundaki dosyalar tarafından kullanılan toplam bayt sayısı.	Evet

OpenAI.VectorStoreObjectFileCounts

İsim	Türü	Gerekli
cancelled	tamsayı	Evet
Tamamlandı	tamsayı	Evet
başarısız	tamsayı	Evet
in_progress	tamsayı	Evet
toplam	tamsayı	Evet

OpenAI.VectorStoreSearchRequest

İsim	Türü	Description	Gerekli	Varsayılan
filters	OpenAI.ComparisonFilter veya OpenAI.CompoundFilter	Dosya özniteliklerine göre uygulanacak bir filtre.	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. Kısıtlamalar: dk: 1, maksimum: 50	Hayı	10
soru	dize veya dize dizisi	Arama için sorgu dizesi	Evet
Sıralama_seçenekleri	OpenAI.VectorStoreSearchRequestRankingOptions		Hayı
└─ sıralama yapıcı	enum	Olası değerler: `none`, `auto`, `default-2024-11-15`	Hayı
└─ skor_eşiği	Numara	Kısıtlamalar: min: 0, max: 1	Hayı
rewrite_query	Boolean	Vektör araması için doğal dil sorgusunun yeniden yazıp yazılmayacağı.	Hayı

OpenAI.VectorStoreSearchRequestRankingOptions

İsim	Türü	Description	Gerekli	Varsayılan
sıralayıcı	enum	Olası değerler: `none`, `auto`, `default-2024-11-15`	Hayı
puan_eşik_değeri	Numara	Kısıtlamalar: min: 0, max: 1	Hayı

OpenAI.VectorStoreSearchResultContentObject

İsim	Türü	Description	Gerekli	Varsayılan
text	String	Aramadan döndürülen metin içeriği.	Evet
type	enum	İçerik türü. Olası değerler: `text`	Evet

OpenAI.VectorStoreSearchResultItem

İsim	Türü	Description	Gerekli
attributes	OpenAI.VectorStoreFileAttributes veya null		Evet
içerik	OpenAI.VectorStoreSearchResultContentObject dizisi	Dosyadan içerik öbekleri.	Evet
dosya_kimlik	String	Vektör deposu dosyasının kimliği.	Evet
filename	String	Vektör deposu dosyasının adı.	Evet
Puan	Numara	Sonuç için benzerlik puanı. Kısıtlamalar: min: 0, max: 1	Evet

OpenAI.VectorStoreSearchResultsPage

İsim	Türü	Description	Gerekli
veriler	OpenAI.VectorStoreSearchResultItem dizisi	Arama sonucu öğelerinin listesi.	Evet
daha_fazla	Boolean	Getirilecek daha fazla sonuç olup olmadığını gösterir.	Evet
next_page	dize veya null		Evet
nesne	enum	Her zaman olan nesne türü `vector_store.search_results.page` Olası değerler: `vector_store.search_results.page`	Evet
search_query	dize dizisi		Evet

OpenAI.Verbosity

Modelin yanıtının çok fazla olduğunu sınırlar. Daha düşük değerler daha kısa yanıtlar sağlarken, daha yüksek değerler daha fazla sözlü yanıtlar sağlar. Şu anda desteklenen değerler , lowve medium'tirhigh.

Mülkiyet	Değer
Türü	String
Değerler	`low` `medium` `high`

OpenAI.VoiceIdsShared

Mülkiyet	Değer
Türü	String
Değerler	`alloy` `ash` `ballad` `coral` `echo` `sage` `shimmer` `verse` `marin` `cedar`

OpenAI.Wait

Bir bekleme eylemi.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olay türünü belirtir. Bekleme eylemi için bu özellik her zaman `wait` olarak ayarlanır. Olası değerler: `wait`	Evet

OpenAI.WebSearchActionFind

Eylem türü "bul": Yüklenen bir sayfada desen arar.

İsim	Türü	Description	Gerekli
pattern	String	Sayfa içinde aranacak desen veya metin.	Evet
type	enum	Eylem türü. Olası değerler: `find_in_page`	Evet
url	String	Desenin arandığı sayfanın URL'si.	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	Modelin açtığı URL	Evet

OpenAI.WebSearchActionSearch

Eylem türü "arama" - Web araması sorgusu gerçekleştirir.

İsim	Türü	Description	Gerekli
queries	dize dizisi	Arama sorguları.	Hayı
soru	dize (kullanım dışı)	[KULLANIM DIŞI] Arama sorgusu.	Evet
Kaynak	OpenAI.WebSearchActionSearchSources dizisi	Aramada kullanılan kaynaklar.	Hayı
type	enum	Eylem türü. Olası değerler: `search`	Evet

OpenAI.WebSearchActionSearchSources

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olası değerler: `url`	Evet
url	String		Evet

OpenAI.WebSearchApproximateLocation

Kullanıcının yaklaşık konumu.

İsim	Türü	Description	Gerekli
city	dize veya null		Hayı
country	dize veya null		Hayı
region	dize veya null		Hayı
timezone	dize veya null		Hayı
type	enum	Konum yaklaşımının türü. Her zaman `approximate`. Olası değerler: `approximate`	Hayı

OpenAI.WebSearchPreviewTool

Not: web_search henüz Azure OpenAI aracılığıyla sağlanmaz.

İsim	Türü	Description	Gerekli
arama_bağlam_boyutu	OpenAI.SearchContextSize		Hayı
type	enum	Web arama aracının türü. `web_search_preview` veya `web_search_preview_2025_03_11`'den biri. Olası değerler: `web_search_preview`	Evet
kullanıcı_konumu	OpenAI.ApproximateLocation veya null		Hayı

OpenAI.WebSearchTool

Not: web_search henüz Azure OpenAI aracılığıyla sağlanmaz.

İsim	Türü	Description	Gerekli
filters	OpenAI.WebSearchToolFilters veya null		Hayı
arama_bağlam_boyutu	enum	Arama için kullanılacak bağlam penceresi alanı miktarına yönelik üst düzey kılavuz. `low`, `medium`veya `high`. `medium` varsayılan değerdir. Olası değerler: `low`, `medium`, `high`	Hayı
type	enum	Web arama aracının türü. `web_search` veya `web_search_2025_08_26`'den biri. Olası değerler: `web_search`	Evet
kullanıcı_konumu	OpenAI.WebSearchApproximateLocation veya null		Hayı

OpenAI.WebSearchToolFilters

İsim	Türü	Description	Gerekli	Varsayılan
allowed_domains	dize dizisi veya null		Hayı

Sipariş

Mülkiyet	Değer
Türü	String
Değerler	`asc` `desc`

ResponseFormatJSONSchemaRequest

İsim	Türü	Description	Gerekli	Varsayılan
json şeması	nesne	Yanıt biçimi için JSON Şeması	Evet
type	enum	Yanıt biçimi türü Olası değerler: `json_schema`	Evet

SpeechGenerationResponse

Metin okuma işlemi için yanıtın gösterimi.

İsim	Türü	Description	Gerekli	Varsayılan
audio	String	İstenen ses çıkış biçiminde oluşturulan ses.	Evet

SpeechGenerationResponseFormat

Metin okuma için desteklenen ses çıkış biçimleri.

Bu bileşen aşağıdakilerden biri olabilir:

string
dize: mp3, opus, aac, flac, wav, pcm

SpeechVoice

Metin okuma için kullanılabilir sesler.

Mülkiyet	Değer
Açıklama	Metin okuma için kullanılabilir sesler.
Türü	String
Değerler	`alloy` `echo` `fable` `onyx` `nova` `shimmer`

VideoContent

İsim	Türü	Description	Gerekli	Varsayılan
içerik	String		Evet

VideoContentVariant

İndirilen içerik için seçilebilir varlık değişkenleri.

Mülkiyet	Değer
Açıklama	İndirilen içerik için seçilebilir varlık değişkenleri.
Türü	String
Değerler	`video` `thumbnail` `spritesheet`

VideoIdParameter

İsim	Türü	Description	Gerekli	Varsayılan
video kimliği	String	Azure OpenAI isteği için kullanılacak videonun kimliği.	Evet

Video oluşturma işlerinin listesi.

İsim	Türü	Description	Gerekli
veriler	VideoResource dizisi	Video oluşturma işlerinin listesi.	Evet
ilk_kimlik	String	Varsa, geçerli sayfadaki ilk videonun kimliği.	Hayı
daha_fazla	Boolean	Listeden sonra kullanılabilir daha fazla iş olup olmadığını gösteren bir bayrak.	Evet
son_kimlik	String	Varsa, geçerli sayfadaki son videonun kimliği.	Hayı
nesne	enum	Olası değerler: `list`	Evet

VideoKaynak

Oluşturulan bir video işini açıklayan yapılandırılmış bilgiler.

İsim	Türü	Description	Gerekli
tamamlanma_tarihi	tamsayı	İşin tamamlandığı zaman için unix zaman damgası (saniye) (tamamlandıysa).	Hayı
oluşturulma_tarihi	tamsayı	İşin oluşturulduğu zaman için Unix zaman damgası (saniye).	Evet
hata	Error		Hayı
└─ kod	String		Evet
└─ ileti	String		Evet
sona_erdigi_tarih	tamsayı	Video oluşturma süresinin dolacağı (ve silineceği) için Unix zaman damgası (saniye).	Hayı
kimlik	String	Video işinin benzersiz tanımlayıcısı.	Evet
model	String	İşi üreten video oluşturma modeli dağıtımı.	Evet
nesne	String	Her zaman `video`olan nesne türü.	Evet
ilerleme	tamsayı	Oluşturma görevi için yaklaşık tamamlanma yüzdesi.	Evet
remixed_from_video_id	String	Bu video bir remix ise kaynak videonun tanımlayıcısı.	Hayı
saniye	VideoSaniyeler	Saniye cinsinden ölçülen desteklenen klip süreleri.	Evet
boyut	Video Boyutu	olarak `{width}x{height}`biçimlendirilmiş çıkış boyutları.	Evet
durum	VideoStatus	Oluşturulan videonun yaşam döngüsü durumu.	Evet

VideoSaniyeler

Saniye cinsinden ölçülen desteklenen klip süreleri.

Mülkiyet	Değer
Açıklama	Saniye cinsinden ölçülen desteklenen klip süreleri.
Türü	String
Değerler	`4` `8` `12`

Video Boyutu

olarak {width}x{height}biçimlendirilmiş çıkış boyutları.

Mülkiyet	Değer
Açıklama	olarak `{width}x{height}`biçimlendirilmiş çıkış boyutları.
Türü	String
Değerler	`720x1280` `1280x720` `1024x1792` `1792x1024`

VideoStatus

Oluşturulan videonun yaşam döngüsü durumu.

Mülkiyet	Değer
Açıklama	Oluşturulan videonun yaşam döngüsü durumu.
Türü	String
Değerler	`queued` `in_progress` `completed` `failed`

Geri Bildirim

Bu sayfayı yararlı buldunuz mu?

Last updated on 2026-03-11

Aracılığıyla paylaş

Azure OpenAI için Microsoft Foundry Models v1 REST API Referansı

Kimlik Doğrulaması

API anahtarı

Kimlik doğrulama belirteçleri

Oauth2authoauth20

Batch

Toplu iş oluşturma

URI Parametreleri

İstek Başlığı

İstek Gövdesi

Yanıtlar

Toplu işleri listeleme

URI Parametreleri

İstek Başlığı

Yanıtlar

Toplu işlemi alma

URI Parametreleri

İstek Başlığı

Yanıtlar

Toplu işlemi iptal et

URI Parametreleri

İstek Başlığı

Yanıtlar

Chat

Sohbet tamamlama işlemi oluşturma

URI Parametreleri

İstek Gövdesi

Yanıtlar

Örnekler

Example

Tamamlamalar

Tamamlama oluşturma

URI Parametreleri

İstek Gövdesi

Yanıtlar

Örnekler

Example

Konteynerler

Kapsayıcıları listele

URI Parametreleri

Yanıtlar

Kapsayıcı oluşturma

URI Parametreleri

İstek Gövdesi

Yanıtlar

Kapsayıcıyı alma

URI Parametreleri

Yanıtlar

Kapsayıcıyı sil

URI Parametreleri

Yanıtlar

Kapsayıcı dosyalarını listeleme

URI Parametreleri

Yanıtlar

Kapsayıcı dosyası oluşturma

URI Parametreleri

İstek Gövdesi

Yanıtlar

Kapsayıcı dosyasını alma

URI Parametreleri

Yanıtlar

Kapsayıcı dosyasını silme

URI Parametreleri

Yanıtlar

Kapsayıcı dosyası içeriğini alma

URI Parametreleri

Yanıtlar

Konuşma

Konuşma oluşturma

URI Parametreleri

İstek Gövdesi

Yanıtlar

Konuşmayı alma

URI Parametreleri

Yanıtlar

Konuşmayı güncelleştirme

URI Parametreleri

İstek Gövdesi

Yanıtlar