Microsoft Foundry Modellerindeki Azure OpenAI REST API v1 önizleme referansı

Bu makalede, Azure OpenAI için çıkarım REST API uç noktaları hakkında ayrıntılar sağlanır.

Veri düzlemi çıkarımı

Makalenin geri kalanı, Azure OpenAI veri düzlemi çıkarım belirtiminin yeni v1 önizleme API'sinin sürümünü kapsar. API yaşam döngüsü kılavuzumuzdan daha fazla bilgi edinin.

En son v1 GA API sürümüyle ilgili belgeler arıyorsanız en son GA veri düzlemi çıkarım API'sine bakın

Konuşma oluştur

POST {endpoint}/openai/v1/audio/speech?api-version=preview

Girilen metinden sesli okuma sesi üretir.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Microsoft Foundry Modelleri API sürümü. v1 aksi belirtilmediyse.

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

İstek Gövdesi

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

İsim	Türü	Description	Gerekli	Varsayılan
girdi	String	Ses oluşturulacak metin. Uzunluk üst sınırı 4096 karakterdir.	Evet
instructions	String	Ek yönergelerle oluşturulan sesinizin sesini kontrol edin. tts-1 veya tts-1-hd ile çalışmaz.	Hayı
model	String	Bu metin okuma isteği için kullanılacak model.	Evet
yanıt formatı	nesne	Metin okuma için desteklenen ses çıkış biçimleri.	Hayı
speed	Numara	Oluşturulan ses için konuşma hızı. Değerler 0,25 ile 4,0 aralığında geçerlidir; varsayılan değer 1,0 ve daha hızlı konuşmaya karşılık gelen daha yüksek değerlerdir.	Hayı	1
stream_format	enum	Ses akışı için biçim. Desteklenen biçimler sse ve audio'dir. sseveya tts-1için tts-1-hd desteklenmez. Olası değerler: sse, audio	Hayı
voice	nesne		Evet

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Örnekler

Example

Sağlanan metinden ses sentezler.

POST {endpoint}/openai/v1/audio/speech?api-version=preview

{
 "input": "Hi! What are you going to make?",
 "voice": "fable",
 "response_format": "mp3",
 "model": "tts-1"
}

Yanıtlar: Durum Kodu: 200

{
  "body": "101010101"
}

Transkripsiyon oluşturma

POST {endpoint}/openai/v1/audio/transcriptions?api-version=preview

Sesi giriş diline ayırır.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm Modelleri API sürümü. v1 aksi belirtilmediyse.

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

İstek Gövdesi

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

İsim	Türü	Description	Gerekli	Varsayılan
chunking_strategy	nesne		Hayı
└─ ön_ek_yastıklama_ms	tamsayı	VAD konuşma algılamadan önce eklenecek ses miktarı (milisaniye cinsinden).	Hayı	300
└─ sessizlik_süresi_ms	tamsayı	Konuşma durdurmayı algılamak için sessizlik süresi (milisaniye cinsinden). Daha kısa değerlerle model daha hızlı yanıt verir, ancak kullanıcı kısa durakladığında araya girebilir.	Hayı	200
└─ eşik	Numara	Ses etkinliği algılama için duyarlılık eşiği (0,0 - 1,0). Daha yüksek bir eşik, modeli etkinleştirmek için daha yüksek ses gerektirir ve bu nedenle gürültülü ortamlarda daha iyi performans gösterebilir.	Hayı	0,5
└─ türü	enum	Manuel parçalamayı sunucu tarafı VAD kullanarak etkinleştirmek için server_vad olarak ayarlanmalıdır. Olası değerler: server_vad	Hayı
dosya	String		Evet
filename	String	Ses verileriyle ilişkilendirilecek isteğe bağlı dosya adı veya açıklayıcı tanımlayıcı.	Hayı
include[]	dizi	Transkripsiyon yanıtına eklenecek ek bilgiler. logprobs , modelin transkripsiyona olan güvenini anlamak için yanıttaki belirteçlerin günlük olasılıklarını döndürür. logprobs yalnızca json olarak ayarlandığında ve yalnızca gpt-4o-transcribe, gpt-4o-transcribe-diarize, gpt-4o-mini-transcribe ve gpt-4o-mini-transcribe-2025-12-15 modelleriyle çalışır.	Hayı
language	String	Giriş sesinin dili. Giriş dilini ISO-639-1 (ör. en) biçiminde sağlamak doğruluğu ve gecikme süresini artırır.	Hayı
model	String	Bu transkripsiyon isteği için kullanılacak model.	Hayı
prompt	String	Modelin stiline kılavuzluk etmek veya önceki bir ses kesimine devam etmek için isteğe bağlı bir metin. İstem, ses diliyle eşleşmelidir.	Hayı
yanıt formatı	nesne		Hayı
veri akışı	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. Not: whisper-1 modeli için streaming desteklenmez ve yoksayılır.	Hayı	Yanlış
sıcaklık	Numara	Örnekleme sıcaklığı, 0 ile 1 arasında. 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. 0 olarak ayarlanırsa model, belirli eşiklere isabet edene kadar sıcaklığı otomatik olarak artırmak için günlük olasılığını kullanır.	Hayı	0
timestamp_granularities[]	dizi	Bu transkripsiyon için doldurulacak zaman damgası tanecikleri. response_format zaman damgası taneciklerini kullanacak şekilde ayarlanmalıdır verbose_json . Bu seçeneklerden biri veya her ikisi de desteklenir: word, veya segment. Not: Segment zaman damgaları için ek gecikme süresi yoktur, ancak sözcük zaman damgaları oluşturmak ek gecikmeye neden olur.	Hayı	['segment']

Yanıtlar

Durum Kodu: 200

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

İçerik Türü	Türü	Açıklama
uygulama/json	AzureAudioTranscriptionResponse
düz metin	String

Durum Kodu: varsayılan

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

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

Örnekler

Example

Sağlanan konuşulan ses verilerinden dökümü alınmış metinleri ve ilişkili meta verileri alır.

POST {endpoint}/openai/v1/audio/transcriptions?api-version=preview

{
 "file": "<binary audio data>",
 "model": "whisper-1",
 "response_format": "text"
}

Yanıtlar: Durum Kodu: 200

{
  "body": "plain text when requesting text, srt, or vtt"
}

Çeviri oluşturma

POST {endpoint}/openai/v1/audio/translations?api-version=preview

Sağlanan konuşulan ses verilerinden İngilizce dil dökümü metni ve ilişkili meta verileri alır.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm Modelleri API sürümü. v1 aksi belirtilmediyse.

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

İstek Gövdesi

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

İsim	Türü	Description	Gerekli	Varsayılan
dosya	String		Evet
filename	String	Ses verileriyle ilişkilendirilecek isteğe bağlı dosya adı veya açıklayıcı tanımlayıcı	Hayı
model	String	Bu çeviri isteği için kullanılacak model.	Hayı
prompt	String	Modelin stiline kılavuzluk etmek veya önceki bir ses kesimine devam etmek için isteğe bağlı bir metin. İstem İngilizce olmalıdır.	Hayı
yanıt formatı	nesne		Hayı
sıcaklık	Numara	Örnekleme sıcaklığı, 0 ile 1 arasında. 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. 0 olarak ayarlanırsa model, belirli eşiklere isabet edene kadar sıcaklığı otomatik olarak artırmak için günlük olasılığını kullanır.	Hayı	0

Yanıtlar

Durum Kodu: 200

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

İçerik Türü	Türü	Açıklama
uygulama/json	AzureAudioTranslationResponse
düz metin	String

Durum Kodu: varsayılan

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

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

Örnekler

Example

Sağlanan konuşulan ses verilerinden İngilizce dil dökümü metni ve ilişkili meta verileri alır.

POST {endpoint}/openai/v1/audio/translations?api-version=preview

{
 "file": "<binary audio data>",
 "model": "whisper-1",
 "response_format": "text"
}

Yanıtlar: Durum Kodu: 200

{
  "body": "plain text when requesting text, srt, or vtt"
}

Sohbet tamamlama oluşturma

POST {endpoint}/openai/v1/chat/completions?api-version=preview

"Sohbet tamamlama işlemini oluşturur."

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm Modelleri API sürümü. v1 aksi belirtilmediyse.

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
audio	nesne	Ses çıkışı parametreleri. ile modalities: ["audio"]ses çıkışı istendiğinde gereklidir.	Hayı
└─ biçimi	enum	Çıkış ses biçimini belirtir. Bir wav, mp3, flac, opus veya pcm16'den biri olmalıdır. Olası değerler: wav, aac, mp3, flac, , opus, pcm16	Hayı
└─ ses	nesne		Hayı
data_sources	dizi	Azure OpenAI'ye özel olarak Verilerinizde özelliği için kullanılacak veri kaynakları.	Hayı
frekans cezası	Numara	-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.	Hayı	0
function_call	enum	aracılığıyla {"name": "my_function"} belirli bir işlevin belirtilmesi, modeli bu işlevi çağırmaya zorlar. Olası değerler: none, auto	Hayı
functions	dizi	yerine toolskullanım dışı bırakıldı. Modelin JSON girişleri oluşturabileceği işlevlerin listesi.	Hayı
logit önyargısı	nesne	Belirtilen belirteçlerin tamamlanmada görünme olasılığını değiştirin. Belirteçleri (belirteç oluşturucudaki 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.	Hayı	Hiç kimse
logprobs	Boolean	Çıkış belirteçlerinin günlük olasılıklarının döndürülmesi veya döndürülmemesi. True ise, içinde döndürülen contentmessageher çıkış belirtecinin günlük olasılıklarını döndürür.	Hayı	Yanlış
max_completion_tokens	tamsayı	Görünür çıkış belirteçleri ve muhakeme belirteçleri de dahil olmak üzere tamamlanmak üzere oluşturulabilecek belirteç sayısı için üst sınır.	Hayı
maksimum_token	tamsayı	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 artık max_completion_tokens lehine kullanım dışı bırakılmıştır ve o1 serisi modelleriyle uyumlu değildir.	Hayı
Mesajlar	dizi	Şu ana kadarki konuşmayı içeren iletilerin listesi. Kullandığınız modele bağlı olarak metin, resim ve ses gibi farklı ileti türleri (kalıcılıklar) desteklenir.	Evet
metadata	nesne	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.	Hayı
kalıcılıklar	nesne	Modelin oluşturmasını istediğiniz çıkış türleri. Çoğu model, varsayılan olan metin oluşturabilir: ["text"] Model gpt-4o-audio-preview ses 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"]	Hayı
model	String	Sohbet tamamlama isteği için kullanılacak model dağıtım tanımlayıcısı.	Evet
n	tamsayı	Her giriş iletisi için oluşturulacak sohbet tamamlama seçenekleri. Tüm seçeneklerde oluşturulan belirteç sayısına göre ücretlendirileceğini unutmayın. Maliyetleri en aza indirmek için farklı n tutun1.	Hayı	1
paralel araç çağrıları	nesne	Araç kullanımı sırasında paralel işlev çağrısının etkinleştirilip etkinleştirilmeyileceği.	Hayı
prediction	nesne	Modelden tahmin edilen çıkışın temel gösterimi.	Hayı
└─ türü	OpenAI.ChatOutputPredictionType		Hayı
varlık cezası	Numara	-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.	Hayı	0
akıl yürütme çabası	nesne	yalnızca o serisi modeller Mantıp modelleri için mantık yürütme çabasını kısıtlar. Şu anda desteklenen değerler , lowve medium'tirhigh. Muhakeme çabasının azaltılması, yanıtta daha hızlı yanıtlar ve daha az belirteç kullanılmasına neden olabilir.	Hayı
yanıt formatı	nesne		Hayı
└─ türü	enum	Olası değerler: text, json_object, json_schema	Hayı
seed	tamsayı	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	nesne	En son mantık modelleri o3 ve o4-miniile desteklenmez. API'nin başka belirteçler üretmeyi durduracağı en fazla 4 dizi. Döndürülen metin durdurma sırasını içermez.	Hayı
store	Boolean	Bu sohbet tamamlama isteğinin çıktısını model damıtma veya değerlendirme ürünlerinde kullanmak için depolayıp depolamayacağınıza karar verme.	Hayı	Yanlış
veri akışı	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.	Hayı	Yanlış
stream_options	nesne	Akış yanıtı seçenekleri. Bunu yalnızca ayarladığınızda ayarlayın stream: true.	Hayı
└─ kullanım_dahil_et	Boolean	Ayarlanırsa, iletiden önce data: [DONE] ek bir öbek akışı oluşturulur. usage Bu öbek üzerindeki alan, isteğin tamamı için belirteç kullanım istatistiklerini gösterir ve choices alan her zaman boş bir dizi olur. Diğer tüm öbekler de null değer içeren bir usage alan içerir. NOT: Akış kesintiye uğrarsa, istek için toplam belirteç kullanımını içeren son kullanım öbeği almayabilirsiniz.	Hayı
sıcaklık	Numara	0 ile 2 arasında hangi örnekleme sıcaklığının kullanılacağı. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir. Genellikle bunu değiştirmenizi öneririz top_p ancak ikisini birden değiştirmemenizi öneririz.	Hayı	1
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	dizi	Modelin çağırabileceği araçların listesi. Şu anda araç olarak yalnızca işlevler desteklenmektedir. Modelin JSON girişleri oluşturabileceği işlevlerin listesini sağlamak için bunu kullanın. En fazla 128 işlev desteklenir.	Hayı
top_logprobs	tamsayı	Her biri ilişkili günlük olasılığına sahip her belirteç konumunda döndürülecek en olası belirteç sayısını belirten 0 ile 20 arasında bir tamsayı.	Hayı
top_p	Numara	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ı	1
user	String	Kötüye kullanımı izlemenize ve algılamanıza yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı.	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. Bulut için Microsoft Defender kullanarak yapay zeka uygulamalarını koruma hakkında daha fazla bilgi edinin.	Hayı

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Örnekler

Example

Sağlanan istem, parametreler ve seçilen model için bir tamamlama oluşturur.

POST {endpoint}/openai/v1/chat/completions?api-version=preview

{
 "model": "gpt-4o-mini",
 "messages": [
  {
   "role": "system",
   "content": "you are a helpful assistant that talks like a pirate"
  },
  {
   "role": "user",
   "content": "can you tell me how to care for a parrot?"
  }
 ]
}

Yanıtlar: Durum Kodu: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh?..."
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Ekleme oluşturma

POST {endpoint}/openai/v1/embeddings?api-version=preview

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm Modelleri API sürümü. v1 aksi belirtilmediyse.

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
dimensions	tamsayı	Sonuçta elde edilen çıktı eklemelerinin sahip olması gereken boyut sayısı. Yalnızca ve sonraki modellerde text-embedding-3 desteklenir.	Hayı
encoding_format	enum	Eklemelerin döndürüleceği biçim. veya floatolabilirbase64. Olası değerler: float, base64	Hayı
girdi	dize veya dizi		Evet
model	String	Ekleme isteği için kullanılacak model.	Evet
user	String	OpenAI'nin kötüye kullanımı izlemesine ve algılamasına yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı.	Hayı

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Örnekler

Example

Belirli bir istem için eklemeleri döndürür.

POST {endpoint}/openai/v1/embeddings?api-version=preview

{
 "model": "text-embedding-ada-002",
 "input": [
  "this is a test"
 ]
}

Yanıtlar: Durum Kodu: 200

{
  "body": {
    "data": [
      {
        "index": 0,
        "embedding": [
          -0.012838088,
          -0.007421397,
          -0.017617522,
          -0.028278312,
          -0.018666342,
          0.01737855,
          -0.01821495,
          -0.006950092,
          -0.009937238,
          -0.038580645,
          0.010674067,
          0.02412286,
          -0.013647936,
          0.013189907,
          0.0021125758,
          0.012406612,
          0.020790534,
          0.00074595667,
          0.008397198,
          -0.00535031,
          0.008968075,
          0.014351576,
          -0.014086051,
          0.015055214,
          -0.022211088,
          -0.025198232,
          0.0065186154,
          -0.036350243,
          0.009180495,
          -0.009698266,
          0.009446018,
          -0.008463579,
          -0.0040426035,
          -0.03443847,
          -0.00091273896,
          -0.0019217303,
          0.002349888,
          -0.021560553,
          0.016515596,
          -0.015572986,
          0.0038666942,
          -8.432463e-05,
          0.0032178196,
          -0.020365695,
          -0.009631885,
          -0.007647093,
          0.0033837722,
          -0.026764825,
          -0.010501476,
          0.020219658,
          0.024640633,
          -0.0066912062,
          -0.036456455,
          -0.0040923897,
          -0.013966565,
          0.017816665,
          0.005366905,
          0.022835068,
          0.0103488,
          -0.0010811808,
          -0.028942121,
          0.0074280356,
          -0.017033368,
          0.0074877786,
          0.021640211,
          0.002499245,
          0.013316032,
          0.0021524043,
          0.010129742,
          0.0054731146,
          0.03143805,
          0.014856071,
          0.0023366117,
          -0.0008243692,
          0.022781964,
          0.003038591,
          -0.017617522,
          0.0013309394,
          0.0022154662,
          0.00097414135,
          0.012041516,
          -0.027906578,
          -0.023817508,
          0.013302756,
          -0.003003741,
          -0.006890349,
          0.0016744611
        ]
      }
    ],
    "usage": {
      "prompt_tokens": 4,
      "total_tokens": 4
    }
  }
}

Değerlendirmeleri listeleme

GET {endpoint}/openai/v1/evals?api-version=preview

Proje için değerlendirmeleri listeleme.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm Modelleri API sürümü. v1 aksi belirtilmediyse.
aoai-evals	üstbilgi	Evet	String Olası değerler: preview	Bir önizleme özelliği olan AOAI Değerlendirmeleri'ne erişim sağlar. Bu özellik için 'aoai-evals' üst bilgisinin 'önizleme' olarak ayarlanması gerekir.
after	soru	Hayı	String	Önceki sayfalandırma isteğinin son değerlendirme tanımlayıcısı.
limit	soru	Hayı	tamsayı	Tek bir sayfalandırma yanıtında döndürülecek değerlendirme sayısı sınırı.
order	soru	Hayı	String Olası değerler: asc, desc	Değerlendirmeler zaman damgasına göre sıralanır. artan sırayla sıralama için asc veya azalan sırayla sıralama için desc kullanın.
sırala_göre	soru	Hayı	String Olası değerler: created_at, updated_at	Değerlendirmeler oluşturma zamanına veya son güncelleştirme zamanına göre sıralanabilir. created_at oluşturma zamanı veya updated_at son güncelleştirme zamanı için kullanın.

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Createeval

POST {endpoint}/openai/v1/evals?api-version=preview

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.

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 url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm Modelleri API sürümü. v1 aksi belirtilmediyse.
aoai-evals	üstbilgi	Evet	String Olası değerler: preview	Bir önizleme özelliği olan AOAI Değerlendirmeleri'ne erişim sağlar. Bu özellik için 'aoai-evals' üst bilgisinin 'önizleme' olarak ayarlanması gerekir.

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
veri_kaynağı_yapılandırması	nesne		Evet
└─ türü	OpenAI.EvalDataSourceConfigType		Hayı
metadata	nesne	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.	Hayı
name	String	Değerlendirmenin adı.	Hayı
durum kodu	enum	Olası değerler: 201	Evet
test kriterleri	dizi	Bu gruptaki tüm değerlendirme çalıştırmaları için değerlendirici listesi. Not verenler, gibi {{item.variable_name}}çift küme ayracı gösterimini kullanarak veri kaynağındaki değişkenlere başvurabilir. Modelin çıkışına başvurmak için ad alanını sample (örneğin, {{sample.output_text}}) kullanın.	Evet

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Değerlendirme alma

GET {endpoint}/openai/v1/evals/{eval_id}?api-version=preview

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

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 url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm Modelleri API sürümü. v1 aksi belirtilmediyse.
aoai-evals	üstbilgi	Evet	String Olası değerler: preview	Bir önizleme özelliği olan AOAI Değerlendirmeleri'ne erişim sağlar. Bu özellik için 'aoai-evals' üst bilgisinin 'önizleme' olarak ayarlanması gerekir.
eval_id	path	Evet	String

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Değerlendirmeyi güncelleştirme

POST {endpoint}/openai/v1/evals/{eval_id}?api-version=preview

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

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 url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm Modelleri API sürümü. v1 aksi belirtilmediyse.
aoai-evals	üstbilgi	Evet	String Olası değerler: preview	Bir önizleme özelliği olan AOAI Değerlendirmeleri'ne erişim sağlar. Bu özellik için 'aoai-evals' üst bilgisinin 'önizleme' olarak ayarlanması gerekir.
eval_id	path	Evet	String

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

İstek Gövdesi

İçerik Türü: application/json

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

Durum Kodu: varsayılan

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

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

Değerlendirmeyi sil

DELETE {endpoint}/openai/v1/evals/{eval_id}?api-version=preview

Belirtilen değerlendirmeyi silin.

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 url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm Modelleri API sürümü. v1 aksi belirtilmediyse.
aoai-evals	üstbilgi	Evet	String Olası değerler: preview	Bir önizleme özelliği olan AOAI Değerlendirmeleri'ne erişim sağlar. Bu özellik için 'aoai-evals' üst bilgisinin 'önizleme' olarak ayarlanması gerekir.
eval_id	path	Evet	String

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

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

GET {endpoint}/openai/v1/evals/{eval_id}/runs?api-version=preview

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

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 url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm Modelleri API sürümü. v1 aksi belirtilmediyse.
aoai-evals	üstbilgi	Evet	String Olası değerler: preview	Bir önizleme özelliği olan AOAI Değerlendirmeleri'ne erişim sağlar. Bu özellik için 'aoai-evals' üst bilgisinin 'önizleme' olarak ayarlanması gerekir.
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

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

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

POST {endpoint}/openai/v1/evals/{eval_id}/runs?api-version=preview

Not verme işlemine başlayarak yeni bir değerlendirme çalıştırması oluşturun.

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 url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm Modelleri API sürümü. v1 aksi belirtilmediyse.
aoai-evals	üstbilgi	Evet	String Olası değerler: preview	Bir önizleme özelliği olan AOAI Değerlendirmeleri'ne erişim sağlar. Bu özellik için 'aoai-evals' üst bilgisinin 'önizleme' olarak ayarlanması gerekir.
eval_id	path	Evet	String

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
veri_kaynağı	nesne		Evet
└─ türü	OpenAI.EvalRunDataSourceType		Hayı
metadata	nesne	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.	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

Durum Kodu: varsayılan

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

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

Değerlendirme çalıştırması alma

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

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

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 url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm Modelleri API sürümü. v1 aksi belirtilmediyse.
aoai-evals	üstbilgi	Evet	String Olası değerler: preview	Bir önizleme özelliği olan AOAI Değerlendirmeleri'ne erişim sağlar. Bu özellik için 'aoai-evals' üst bilgisinin 'önizleme' olarak ayarlanması gerekir.
eval_id	path	Evet	String
run_id	path	Evet	String

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Değerlendirme çalıştırmayı iptal etme

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

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

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 url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm Modelleri API sürümü. v1 aksi belirtilmediyse.
aoai-evals	üstbilgi	Evet	String Olası değerler: preview	Bir önizleme özelliği olan AOAI Değerlendirmeleri'ne erişim sağlar. Bu özellik için 'aoai-evals' üst bilgisinin 'önizleme' olarak ayarlanması gerekir.
eval_id	path	Evet	String
run_id	path	Evet	String

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Deleteevalrun

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

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

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 url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm Modelleri API sürümü. v1 aksi belirtilmediyse.
aoai-evals	üstbilgi	Evet	String Olası değerler: preview	Bir önizleme özelliği olan AOAI Değerlendirmeleri'ne erişim sağlar. Bu özellik için 'aoai-evals' üst bilgisinin 'önizleme' olarak ayarlanması gerekir.
eval_id	path	Evet	String
run_id	path	Evet	String

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

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

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

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

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 url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm Modelleri API sürümü. v1 aksi belirtilmediyse.
aoai-evals	üstbilgi	Evet	String Olası değerler: preview	Bir önizleme özelliği olan AOAI Değerlendirmeleri'ne erişim sağlar. Bu özellik için 'aoai-evals' üst bilgisinin 'önizleme' olarak ayarlanması gerekir.
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

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

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

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

Bir değerlendirme çalıştırmasından kimliğine göre belirli bir çıkış öğesini alın.

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 url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm Modelleri API sürümü. v1 aksi belirtilmediyse.
aoai-evals	üstbilgi	Evet	String Olası değerler: preview	Bir önizleme özelliği olan AOAI Değerlendirmeleri'ne erişim sağlar. Bu özellik için 'aoai-evals' üst bilgisinin 'önizleme' olarak ayarlanması gerekir.
eval_id	path	Evet	String
run_id	path	Evet	String
output_item_id	path	Evet	String

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Dosya oluşturma

POST {endpoint}/openai/v1/files?api-version=preview

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm Modelleri API sürümü. v1 aksi belirtilmediyse.

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

İstek Gövdesi

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

İsim	Türü	Description	Gerekli	Varsayılan
sona_erdikten_sonra	nesne		Evet
└─ tutturucu	AzureFileExpiryAnchor		Hayı
└─ saniye	tamsayı		Hayı
dosya	String		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	AzureOpenAIFile

Durum Kodu: varsayılan

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

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

Örnekler

Example

POST {endpoint}/openai/v1/files?api-version=preview

Dosyaları listeleme

GET {endpoint}/openai/v1/files?api-version=preview

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm Modelleri API sürümü. v1 aksi belirtilmediyse.
purpose	soru	Hayı	String

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Dosyayı alma

GET {endpoint}/openai/v1/files/{file_id}?api-version=preview

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm Modelleri API sürümü. v1 aksi belirtilmediyse.
dosya_kimlik	path	Evet	String	Bu istek için kullanılacak dosyanın kimliği.

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Dosyayı sil

DELETE {endpoint}/openai/v1/files/{file_id}?api-version=preview

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm Modelleri API sürümü. v1 aksi belirtilmediyse.
dosya_kimlik	path	Evet	String	Bu istek için kullanılacak dosyanın kimliği.

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Dosyayı indirme

GET {endpoint}/openai/v1/files/{file_id}/content?api-version=preview

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm Modelleri API sürümü. v1 aksi belirtilmediyse.
dosya_kimlik	path	Evet	String	Bu istek için kullanılacak dosyanın kimliği.

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Rungrader

POST {endpoint}/openai/v1/fine_tuning/alpha/graders/run?api-version=preview

Bir not veren çalıştırın.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm Modelleri API sürümü. v1 aksi belirtilmediyse.

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
Greyder	nesne	Belirtilen işlemi kullanarak giriş ve başvuru arasında dize karşılaştırması gerçekleştiren bir StringCheckGrader nesnesi.	Evet
└─ çıktıyı_hesapla	String	Not veren sonuçlarına göre çıkışı hesaplamak için bir formül.	Hayı
└─ değerlendirme_metriği	enum	Kullanılacak değerlendirme ölçümü. fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5 veya rouge_l. Olası değerler: fuzzy_match, bleu, gleu, , meteor, rouge_1, , rouge_2, rouge_3rouge_4, rouge_5,rouge_l	Hayı
└─ greyderler	nesne		Hayı
└─ görsel_etiketi	String	Python betiği için kullanılacak görüntü etiketi.	Hayı
└─ giriş	dizi	Giriş metni. Bu, şablon dizelerini içerebilir.	Hayı
└─ modeli	String	Değerlendirme için kullanılacak model.	Hayı
└─ ad	String	Değerlendiricinin adı.	Hayı
└─ işlem	enum	Gerçekleştirilecek dize denetimi işlemi. eq, ne, like veya ilike. Olası değerler: eq, ne, like, ilike	Hayı
└─ aralığı	dizi	Puan aralığı. Varsayılan olarak [0, 1] değerini alır.	Hayı
└─ başvuru	String	Değerlendirmenin yapıldığı metin.	Hayı
└─ örnekleme_parametreleri		Modelin örnekleme parametreleri.	Hayı
└─ kaynak	String	Python betiğinin kaynak kodu.	Hayı
└─ türü	enum	Her zaman multiolan nesne türü. Olası değerler: multi	Hayı
öğe		Not verene sağlanan veri kümesi öğesi. Bu, ad alanını item doldurmak için kullanılır.	Hayı
model_sample	String	Değerlendirilecek model örneği. Bu değer ad alanını sample doldurmak için kullanılır. output_json Model örneği geçerli bir JSON dizesiyse değişken doldurulur.	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	AzureErrorResponse

Not vereni doğrulama

POST {endpoint}/openai/v1/fine_tuning/alpha/graders/validate?api-version=preview

Not vereni doğrulama.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm Modelleri API sürümü. v1 aksi belirtilmediyse.

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
Greyder	nesne	Belirtilen işlemi kullanarak giriş ve başvuru arasında dize karşılaştırması gerçekleştiren bir StringCheckGrader nesnesi.	Evet
└─ çıktıyı_hesapla	String	Not veren sonuçlarına göre çıkışı hesaplamak için bir formül.	Hayı
└─ değerlendirme_metriği	enum	Kullanılacak değerlendirme ölçümü. fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5 veya rouge_l. Olası değerler: fuzzy_match, bleu, gleu, , meteor, rouge_1, , rouge_2, rouge_3rouge_4, rouge_5,rouge_l	Hayı
└─ greyderler	nesne		Hayı
└─ görsel_etiketi	String	Python betiği için kullanılacak görüntü etiketi.	Hayı
└─ giriş	dizi	Giriş metni. Bu, şablon dizelerini içerebilir.	Hayı
└─ modeli	String	Değerlendirme için kullanılacak model.	Hayı
└─ ad	String	Değerlendiricinin adı.	Hayı
└─ işlem	enum	Gerçekleştirilecek dize denetimi işlemi. eq, ne, like veya ilike. Olası değerler: eq, ne, like, ilike	Hayı
└─ aralığı	dizi	Puan aralığı. Varsayılan olarak [0, 1] değerini alır.	Hayı
└─ başvuru	String	Değerlendirmenin yapıldığı metin.	Hayı
└─ örnekleme_parametreleri		Modelin örnekleme parametreleri.	Hayı
└─ kaynak	String	Python betiğinin kaynak kodu.	Hayı
└─ türü	enum	Her zaman multiolan nesne türü. Olası değerler: multi	Hayı

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	AzureErrorResponse

İnce ayar işi oluşturma

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

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

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm Modelleri API sürümü. v1 aksi belirtilmediyse.

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

İstek Gövdesi

İçerik Türü: application/json

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

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

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

Kuruluşunuzun ince ayar işlerini listeleme

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm 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ı	Alınacak ince ayar işlerinin sayısı.

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

hassas ayarlama işini alma

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

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm Modelleri API sürümü. v1 aksi belirtilmediyse.
ince_ayarlama_iş_id	path	Evet	String	İnce ayar işinin kimliği.

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

İnce ayarlama işini iptal etme

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

Hassas ayarlama işini hemen iptal edin.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm Modelleri API sürümü. v1 aksi belirtilmediyse.
ince_ayarlama_iş_id	path	Evet	String	İptal edilecek ince ayar işinin kimliği.

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

İnce ayar iş denetim noktalarını listeleme

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

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm Modelleri API sürümü. v1 aksi belirtilmediyse.
ince_ayarlama_iş_id	path	Evet	String	Denetim noktalarını almak için ince ayar işinin kimliği.
after	soru	Hayı	String	Önceki sayfalandırma isteğindeki son denetim noktası kimliğinin tanımlayıcısı.
limit	soru	Hayı	tamsayı	Alınacak denetim noktası sayısı.

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

İnce ayar olaylarını listeleme

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

bir ince ayar işi için durum güncelleştirmelerini alın.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm Modelleri API sürümü. v1 aksi belirtilmediyse.
ince_ayarlama_iş_id	path	Evet	String	Olay almak için ince ayar işinin kimliği.
after	soru	Hayı	String	Önceki sayfalandırma isteğindeki son olayın tanımlayıcısı.
limit	soru	Hayı	tamsayı	Alınacak olay sayısı.

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

İnce ayarlama işini duraklatma

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

İnce ayar işini duraklatma.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm Modelleri API sürümü. v1 aksi belirtilmediyse.
ince_ayarlama_iş_id	path	Evet	String	Duraklatmak için ince ayar işinin kimliği.

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

hassas ayarlama işini sürdürme

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

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm Modelleri API sürümü. v1 aksi belirtilmediyse.
ince_ayarlama_iş_id	path	Evet	String	Sürdürülecek ince ayar işinin kimliği.

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Görüntü düzenleme oluşturma

POST {endpoint}/openai/v1/images/edits?api-version=preview

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm Modelleri API sürümü. v1 aksi belirtilmediyse.

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

İstek Gövdesi

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

İsim	Türü	Description	Gerekli	Varsayılan
arka plan	enum	Oluşturulan görüntülerin arka planı için saydamlık ayarlamaya olanak tanır. Bu parametre yalnızca gpt-image-1-serisi modeller için desteklenir. transparent, opaque veya auto'den biri olmalıdır (varsayılan değer). Kullanıldığında auto , model görüntü için en iyi arka planı otomatik olarak belirler. isetransparent, çıkış biçiminin saydamlığı desteklemesi gerektiğinden (varsayılan değer) veya pngolarak webp ayarlanmalıdır. Olası değerler: transparent, opaque, auto	Hayı
image	dize veya dizi		Evet
mask	String		Hayı
model	String	Görüntü düzenleme işlemi için kullanılacak modelin dağıtımı.	Evet
n	tamsayı	Oluşturulacak görüntü sayısı. 1 ile 10 arasında olmalıdır.	Hayı	1
çıktı sıkıştırma	tamsayı	Oluşturulan görüntüler için sıkıştırma düzeyi (0-100%). Bu parametre yalnızca gpt-image-1 serisi modeller için webp veya jpeg çıkış biçimlerine sahip olduğunda desteklenir ve varsayılan olarak 100'dür.	Hayı	100
çıkış formatı	enum	Oluşturulan görüntülerin döndürüldiği biçim. Bu parametre yalnızca gpt-image-1-serisi modeller için desteklenir. png, jpeg veya webp'den biri olmalıdır. Varsayılan değer png değeridir. Olası değerler: png, jpeg, webp	Hayı
prompt	String	İstenen resimlerin metin açıklaması. Maksimum uzunluk dall-e-2 için 1000 karakter ve gpt-image-1 serisi modeller için 32000 karakterdir.	Evet
nitelik	enum	Oluşturulacak görüntünün kalitesi. high, medium ve low yalnızca gpt-image-1 serisi modellerde desteklenir. dall-e-2 yalnızca kaliteyi destekler standard . Varsayılan olarak auto değerini alır. Olası değerler: standard, low, medium, high, auto	Hayı
yanıt formatı	enum	Oluşturulan görüntülerin döndürüldiği biçim. url veya b64_jsonbiri olmalıdır. URL'ler, görüntü oluşturulduktan sonra yalnızca 60 dakika boyunca geçerlidir. Bu parametre yalnızca dall-e-2 için desteklenir, çünkü gpt-image-1-serisi modeller her zaman base64 ile kodlanmış görüntüler döndürecektir. Olası değerler: url, b64_json	Hayı
boyut	enum	Oluşturulan görüntülerin boyutu. 1024x1024-serisi modeller için, 1536x1024, 1024x1536 (yatay), auto (dikey) veya gpt-image-1 (varsayılan değer) değerlerinden biri olmalıdır ve 256x256 için 512x512, 1024x1024 veya dall-e-2 değerlerinden biri olmalıdır. Olası değerler: 256x256, 512x512, 1024x1024, 1536x1024, , 1024x1536, auto	Hayı
user	String	OpenAI'nin kötüye kullanımı izlemesine ve algılamasına yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı.	Hayı

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Createimage

POST {endpoint}/openai/v1/images/generations?api-version=preview

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm Modelleri API sürümü. v1 aksi belirtilmediyse.

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
arka plan	enum	Oluşturulan görüntülerin arka planı için saydamlık ayarlamaya olanak tanır. Bu parametre yalnızca gpt-image-1-serisi modeller için desteklenir. transparent, opaque veya auto'den biri olmalıdır (varsayılan değer). Kullanıldığında auto , model görüntü için en iyi arka planı otomatik olarak belirler. isetransparent, çıkış biçiminin saydamlığı desteklemesi gerektiğinden (varsayılan değer) veya pngolarak webp ayarlanmalıdır. Olası değerler: transparent, opaque, auto	Hayı
model	String	Görüntü oluşturma için kullanılacak dağıtım modeli.	Evet
moderation	enum	-series modelleri tarafından gpt-image-1oluşturulan görüntüler için içerik denetim düzeyini denetleyin. Ya low daha az kısıtlayıcı filtreleme için ya da auto (varsayılan değer) olmalıdır. Olası değerler: low, auto	Hayı
n	tamsayı	Oluşturulacak görüntü sayısı. 1 ile 10 arasında olmalıdır. için dall-e-3yalnızca n=1 desteklenir.	Hayı	1
çıktı sıkıştırma	tamsayı	Oluşturulan görüntüler için sıkıştırma düzeyi (0-100%). Bu parametre yalnızca gpt-image-1 serisi modeller için webp veya jpeg çıkış biçimlerine sahip olduğunda desteklenir ve varsayılan olarak 100'dür.	Hayı	100
çıkış formatı	enum	Oluşturulan görüntülerin döndürüldiği biçim. Bu parametre yalnızca gpt-image-1-serisi modeller için desteklenir. png, jpeg veya webp'den biri olmalıdır. Olası değerler: png, jpeg, webp	Hayı
prompt	String	İstenen resimlerin metin açıklaması. En fazla uzunluk, -serisi modelleri için gpt-image-132000 karakter, için dall-e-2 1000 karakter ve için dall-e-34000 karakterdir.	Evet
nitelik	enum	Oluşturulacak görüntünün kalitesi. - auto (varsayılan değer), verilen model için en iyi kaliteyi otomatik olarak seçer. - high, medium ve lowgpt-image-1-series modellerinde desteklenir. - hd ve standard için dall-e-3desteklenir. - standard için tek seçenektir dall-e-2. Olası değerler: standard, hd, low, medium, , high, auto	Hayı
yanıt formatı	enum	dall-e-2 ve dall-e-3 ile oluşturulan görüntülerin geri döndürüldüğü format. url veya b64_jsonbiri olmalıdır. URL'ler, görüntü oluşturulduktan sonra yalnızca 60 dakika boyunca geçerlidir. Bu parametre, her zaman base64 ile kodlanmış görüntüler döndürecek olan -series modellerinde desteklenmez gpt-image-1. Olası değerler: url, b64_json	Hayı
boyut	enum	Oluşturulan görüntülerin boyutu. 1024x1024-serisi modelleri için 1536x1024, 1024x1536 (yatay), auto (dikey) veya gpt-image-1 (varsayılan değer) olmalıdır; 256x256 için 512x512, 1024x1024 veya dall-e-2; ve 1024x1024 için 1792x1024, 1024x1792 veya dall-e-3 olmalıdır. Olası değerler: auto, 1024x1024, 1536x1024, 1024x1536, 256x256, 512x512, 1792x1024, 1024x1792	Hayı
style	enum	Oluşturulan görüntülerin stili. Bu parametre yalnızca için dall-e-3desteklenir. vivid veya naturalbiri olmalıdır. Canlı, modelin hiper-gerçek ve dramatik görüntüler üretmeye yönelmesine neden olur. Doğal, modelin daha doğal, daha az hiper gerçek görünümlü görüntüler üretmesine neden olur. Olası değerler: vivid, natural	Hayı
user	String	OpenAI'nin kötüye kullanımı izlemesine ve algılamasına yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı.	Hayı

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Örnekler

Example

İstendiğinde görüntüler oluşturur.

POST {endpoint}/openai/v1/images/generations?api-version=preview

{
 "model": "dall-e-3",
 "prompt": "In the style of WordArt, Microsoft Clippy wearing a cowboy hat.",
 "n": 1,
 "style": "natural",
 "quality": "standard"
}

Yanıtlar: Durum Kodu: 200

{
  "body": {
    "created": 1698342300,
    "data": [
      {
        "revised_prompt": "A vivid, natural representation of Microsoft Clippy wearing a cowboy hat.",
        "prompt_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          },
          "profanity": {
            "detected": false,
            "filtered": false
          },
          "custom_blocklists": {
            "filtered": false,
            "details": []
          }
        },
        "url": "https://dalletipusw2.blob.core.windows.net/private/images/e5451cc6-b1ad-4747-bd46-b89a3a3b8bc3/generated_00.png?se=2023-10-27T17%3A45%3A09Z&...",
        "content_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          }
        }
      }
    ]
  }
}

Modelleri listeleme

GET {endpoint}/openai/v1/models?api-version=preview

Ş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 url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm Modelleri API sürümü. v1 aksi belirtilmediyse.

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Modeli alma

GET {endpoint}/openai/v1/models/{model}?api-version=preview

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 url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm Modelleri API sürümü. v1 aksi belirtilmediyse.
model	path	Evet	String	Bu istek için kullanılacak modelin kimliği.

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Yanıt oluşturma

POST {endpoint}/openai/v1/responses?api-version=preview

Model yanıtı oluşturur.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm Modelleri API sürümü. v1 aksi belirtilmediyse.

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
arka plan	Boolean	Model yanıtının arka planda çalıştırılıp çalıştırılmayacağı.	Hayı	Yanlış
include	dizi	Model yanıtına eklenecek ek çıktı verilerini belirtin. Şu anda desteklenen değerler şunlardır: - code_interpreter_call.outputs: Kod yorumlayıcı aracı çağrı öğelerinde python kod yürütme çıktılarını içerir. - computer_call_output.output.image_url: Bilgisayar çağrısı çıkışından görüntü URL'lerini ekleyin. - file_search_call.results: Dosya arama aracı çağrısının arama sonuçlarını ekleyin. - message.input_image.image_url: Giriş iletisinden görüntü URL'lerini ekleyin. - message.output_text.logprobs: Yardımcı iletilerine logprobs ekleyin. - reasoning.encrypted_content: Akıl yürütme öğesi çıkışlarında akıl yürütme belirteçlerinin şifrelenmiş bir sürümünü içerir. Bu, Yanıtlar API'sini durum bilgisi olmadan kullanırken (örneğin, store parametresi false olarak ayarlandığında veya bir kuruluş sıfır veri saklama programına kaydedildiğinde) akıl yürütme öğelerinin çok aşamalı konuşmalarda kullanılmasını sağlar.	Hayı
girdi	dize veya dizi		Hayı
instructions	String	Modelin bağlamı içine eklenen bir sistem (veya geliştirici) iletisi. ile previous_response_idbirlikte kullanıldığında, önceki yanıttan alınan yönergeler sonraki yanıta taşınmaz. Bu, sistem (veya geliştirici) iletilerini yeni yanıtlarda değiştirme işlemini basitleştirir.	Hayı
max_output_tokens	tamsayı	Görünür çıkış belirteçleri ve muhakeme belirteçleri de dahil olmak üzere yanıt için oluşturulabilecek belirteç sayısı için üst sınır	Hayı
max_tool_calls	tamsayı	Bir yanıtta işlenebilen yerleşik araçlara yapılan toplam çağrı sayısı üst sınırı. Bu maksimum sayı, tek tek araç başına değil, tüm yerleşik araç çağrıları için geçerlidir. Model tarafından bir aracı çağırmaya yönelik diğer girişimler yoksayılır.	Hayı
metadata	nesne	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, 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.	Hayı
model	String	Bu yanıtın oluşturulması için kullanılacak model dağıtımı.	Evet
paralel araç çağrıları	Boolean	Modelin araç çağrılarını paralel olarak çalıştırmasına izin verilip verilmeyeceği.	Hayı	Doğru
previous_response_id	String	Modele önceki yanıtın benzersiz kimliği. Çok aşamalı konuşmalar oluşturmak için bunu kullanın.	Hayı
prompt	nesne	bir istem şablonuna ve değişkenlerine başvuru.	Hayı
└─ kimlik	String	Kullanılacak istem şablonunun benzersiz tanımlayıcısı.	Hayı
└─ değişkenler	OpenAI.ResponsePromptVariables	İsteminizde değişkenlerin yerine kullanılacak isteğe bağlı değer eşlemesi. Değiştirme değerleri dizeler veya görüntüler veya dosyalar gibi diğer yanıt giriş türleri olabilir.	Hayı
└─ sürümü	String	İstem şablonunun isteğe bağlı sürümü.	Hayı
reasoning	nesne	yalnızca o serisi modeller Mantık modelleri için yapılandırma seçenekleri.	Hayı
└─ çaba	OpenAI.ReasoningEffort	yalnızca o serisi modeller Mantıp modelleri için mantık yürütme çabasını kısıtlar. Şu anda desteklenen değerler , lowve medium'tirhigh. Muhakeme çabasının azaltılması, yanıtta daha hızlı yanıtlar ve daha az belirteç kullanılmasına neden olabilir.	Hayı
└─ özet oluştur	enum	Kullanım dışı: bunun yerine kullanın summary . Model tarafından gerçekleştirilen mantığın özeti. Bu, hata ayıklama ve modelin akıl yürütme işlemini anlamak için yararlı olabilir. auto, conciseveya detailed. Olası değerler: auto, concise, detailed	Hayı
└─ özeti	enum	Model tarafından gerçekleştirilen mantığın özeti. Bu, hata ayıklama ve modelin akıl yürütme işlemini anlamak için yararlı olabilir. auto, conciseveya detailed. Olası değerler: auto, concise, detailed	Hayı
store	Boolean	Oluşturulan model yanıtının daha sonra API ile alınabilmesi için depolanıp depolanmayacağı.	Hayı	Doğru
veri akışı	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.	Hayı	Yanlış
sıcaklık	Numara	0 ile 2 arasında hangi örnekleme sıcaklığının kullanılacağı. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir. Genellikle bunu değiştirmenizi öneririz top_p ancak ikisini birden değiştirmemenizi öneririz.	Hayı	1
text	nesne	Modelden metin yanıtı için yapılandırma seçenekleri. Düz metin veya yapılandırılmış JSON verileri olabilir.	Hayı
└─ biçimi	OpenAI.ResponseTextFormatConfiguration		Hayı
tool_choice	nesne	Model tarafından çağrılan aracı (varsa) denetler. none modelin herhangi bir aracı çağırmayacağı ve bunun yerine bir ileti oluşturduğu anlamına gelir. auto modelin 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.	Hayı
└─ türü	OpenAI.ToolChoiceObjectType	Modelin bir yanıt oluşturmak için yerleşik bir araç kullanması gerektiğini gösterir.	Hayı
araçlar	dizi	Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Sen parametresini ayarlayarak tool_choice hangi aracın kullanılacağını belirtebilir. Modeli sağlayabileceğiniz iki araç kategorisi şunlardır: - Yerleşik araçlar: OpenAI tarafından sağlanan ve dosya arama gibi modelin özelliklerini genişleten araçlar. - İşlev çağrıları (özel araçlar): Sizin tanımladığınız ve modelin kendi kodunuzu çağırmasını sağlayan işlevler.	Hayı
top_logprobs	tamsayı	Her biri ilişkili günlük olasılığına sahip her belirteç konumunda döndürülecek en olası belirteç sayısını belirten 0 ile 20 arasında bir tamsayı.	Hayı
top_p	Numara	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ı	1
truncation	enum	Model yanıtı için kullanılacak kesme stratejisi. - auto: Bu yanıtın bağlamı ve öncekiler modelin bağlam penceresi boyutunu aşarsa, model konuşmanın ortasına giriş öğelerini bırakarak yanıtı bağlam penceresine uyacak şekilde kesecektir. - disabled (varsayılan): Model yanıtı bir modelin bağlam penceresi boyutunu aşarsa istek 400 hatasıyla başarısız olur. Olası değerler: auto, disabled	Hayı
user	String	OpenAI'nin kötüye kullanımı izlemesine ve algılamasına yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı.	Hayı

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Örnekler

Example

Model yanıtı oluşturma

POST {endpoint}/openai/v1/responses?api-version=preview

Yanıtı al

GET {endpoint}/openai/v1/responses/{response_id}?api-version=preview

Belirtilen ID numarası ile bir model tepkisi getirir.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm Modelleri API sürümü. v1 aksi belirtilmediyse.
response_id	path	Evet	String
include[]	soru	Hayı	dizi

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Yanıtı silme

DELETE {endpoint}/openai/v1/responses/{response_id}?api-version=preview

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm Modelleri API sürümü. v1 aksi belirtilmediyse.
response_id	path	Evet	String

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Giriş öğelerini listeleme

GET {endpoint}/openai/v1/responses/{response_id}/input_items?api-version=preview

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm 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 düzen vedesc azalan düzen için.
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, listenin sonraki sayfasını getirmek için sonraki çağrınız 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, listenin önceki sayfasını getirmek için sonraki çağrınız before=obj_foo içerebilir.

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Vektör depolarını listeleme

GET {endpoint}/openai/v1/vector_stores?api-version=preview

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

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm 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 düzen vedesc azalan düzen için.
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, listenin sonraki sayfasını getirmek için sonraki çağrınız 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, listenin önceki sayfasını getirmek için sonraki çağrınız before=obj_foo içerebilir.

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Vektör deposu oluşturma

POST {endpoint}/openai/v1/vector_stores?api-version=preview

Vektör deposu oluşturur.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm Modelleri API sürümü. v1 aksi belirtilmediyse.

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
chunking_strategy	nesne	Varsayılan strateji. Bu strateji şu anda ve'nin max_chunk_size_tokens bir 800 sürümünü chunk_overlap_tokens400kullanır.	Hayı
└─ statik	OpenAI.StaticChunkingStrategy		Hayı
└─ türü	enum	Her zaman static. Olası değerler: static	Hayı
sona_erdikten_sonra	OpenAI.VectorStoreExpirationAfter	Vektör deposu için süre sonu ilkesi.	Hayı
dosya_kimlikleri	dizi	Vektör deposunun kullanması gereken dosya kimliklerinin listesi. Dosyalara erişebilecek gibi file_search araçlar için kullanışlıdır.	Hayı
metadata	nesne	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.	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

Durum Kodu: varsayılan

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

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

Örnekler

Örnek dosya bulunamadı: ./examples/vector_stores.json

Vektör deposu alma

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}?api-version=preview

Bir vektör deposu alır.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm Modelleri API sürümü. v1 aksi belirtilmediyse.
vektör_depolama_kimliği	path	Evet	String	Erişilecek vektör deposunun ID'si.

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

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

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}?api-version=preview

Vektör depolarını değiştirir.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm 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 Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
sona_erdikten_sonra	nesne	Vektör deposu için süre sonu ilkesi.	Hayı
└─ tutturucu	enum	Süre sonu ilkesinin uygulanacağı bağlantı zaman damgası. Desteklenen tutturucular: last_active_at. Olası değerler: last_active_at	Hayı
└─ gün	tamsayı	Vektör deposunun süresinin dolacağı yer işareti saatinden sonraki gün sayısı.	Hayı
metadata	nesne	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.	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

Durum Kodu: varsayılan

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

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

Vektör depolarını silme

DELETE {endpoint}/openai/v1/vector_stores/{vector_store_id}?api-version=preview

Vektör depolarını silme.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm Modelleri API sürümü. v1 aksi belirtilmediyse.
vektör_depolama_kimliği	path	Evet	String	Silinecek vektör deposunun kimliği.

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Vektör deposu dosyası oluşturma toplu işlemi

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches?api-version=preview

Vektör deposu dosyası toplu işlemi oluşturun.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm 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 Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
attributes	nesne	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, nesne hakkında ek bilgileri yapılandırılmış biçimde depolamak ve API veya pano aracılığıyla nesneleri sorgulamak için yararlı olabilir. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler, uzunluğu en fazla 512 karakter, boole veya sayı olan dizelerdir.	Hayı
chunking_strategy	OpenAI.ChunkingStrategyRequestParam	Dosyaları öbekleme için kullanılan öbekleme stratejisi. Ayarlanmadıysa, stratejiyi auto kullanır.	Hayı
dosya_kimlikleri	dizi	Vektör deposunun kullanması gereken dosya kimliklerinin listesi. 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.VectorStoreFileBatchObject

Durum Kodu: varsayılan

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

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

Vektör deposu dosya toplu işlemini alma

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=preview

Vektör deposu dosya toplu işlemini alır.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm 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.

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Vektör depolama dosyası toplu işlemini iptal etme

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel?api-version=preview

Vektör deposu dosya toplu işlemini iptal etme. 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 url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm 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.

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Vektör deposu toplu işleminde dosyaları listeleme

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=preview

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 url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm 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 düzen vedesc azalan düzen için.
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, listenin sonraki sayfasını getirmek için sonraki çağrınız 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, listenin önceki sayfasını getirmek için sonraki çağrınız before=obj_foo içerebilir.
filtre	soru	Hayı		Dosya durumuna göre filtreleyin. in_progress, completed, failed veya cancelled'den biri.

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Vektör deposu dosyalarını listeleme

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/files?api-version=preview

Vektör deposu dosyalarının listesini döndürür.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm 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 düzen vedesc azalan düzen için.
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, listenin sonraki sayfasını getirmek için sonraki çağrınız 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, listenin önceki sayfasını getirmek için sonraki çağrınız before=obj_foo içerebilir.
filtre	soru	Hayı		Dosya durumuna göre filtreleyin. in_progress, completed, failed veya cancelled'den biri.

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Vektör deposu dosyası oluşturma

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/files?api-version=preview

Bir vektör deposuna dosya ekleyerek bir vektör deposu dosyası oluşturun.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm 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 Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
attributes	nesne	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, nesne hakkında ek bilgileri yapılandırılmış biçimde depolamak ve API veya pano aracılığıyla nesneleri sorgulamak için yararlı olabilir. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler, uzunluğu en fazla 512 karakter, boole veya sayı olan dizelerdir.	Hayı
chunking_strategy	OpenAI.ChunkingStrategyRequestParam	Dosyaları öbekleme için kullanılan öbekleme stratejisi. Ayarlanmadıysa, stratejiyi auto kullanır.	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

Durum Kodu: varsayılan

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

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

Vektör deposu dosyasını alma

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/files/{file_id}?api-version=preview

Vektör deposu dosyasını alır.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm 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.

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Vektör deposu dosya özniteliklerini güncelleştirme

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/files/{file_id}?api-version=preview

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm Modelleri API sürümü. v1 aksi belirtilmediyse.
vektör_depolama_kimliği	path	Evet	String
dosya_kimlik	path	Evet	String

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
attributes	nesne	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, nesne hakkında ek bilgileri yapılandırılmış biçimde depolamak ve API veya pano aracılığıyla nesneleri sorgulamak için yararlı olabilir. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler, uzunluğu en fazla 512 karakter, boole veya sayı olan dizelerdir.	Evet

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Vektör deposu dosyasını silme

DELETE {endpoint}/openai/v1/vector_stores/{vector_store_id}/files/{file_id}?api-version=preview

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ını kullanın.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm 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.

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Video oluşturma görevleri - Oluştur

POST {endpoint}/openai/v1/video/generations/jobs?api-version=preview

Yeni bir video oluşturma işi oluşturur.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm Modelleri API sürümü. v1 aksi belirtilmediyse.

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
height	tamsayı	Videonun yüksekliği. Aşağıdaki boyutlar desteklenir: 480x480, 854x480, 720x720, 1280x720, 1080x1080 ve 1920x1080 hem yatay hem de dikey yönlerde.	Evet
model	String	Bu istek için kullanılacak dağıtımın adı.	Evet
n_seconds	tamsayı	Video oluşturma işinin süresi. 1 ile 20 saniye arasında olmalıdır.	Hayı	5
n_variants	tamsayı	Bu iş için değişken olarak oluşturulacak video sayısı. 1 ile 5 arasında olmalıdır. Daha küçük boyutlar daha fazla değişken sağlar.	Hayı	1
prompt	String	Bu video oluşturma işinin istemi.	Evet
width	tamsayı	Videonun genişliği. Aşağıdaki boyutlar desteklenir: 480x480, 854x480, 720x720, 1280x720, 1080x1080 ve 1920x1080 hem yatay hem de dikey yönlerde.	Evet

İstek Gövdesi

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

İsim	Türü	Description	Gerekli	Varsayılan
files	dizi		Evet
height	tamsayı	Videonun yüksekliği. Aşağıdaki boyutlar desteklenir: 480x480, 854x480, 720x720, 1280x720, 1080x1080 ve 1920x1080 hem yatay hem de dikey yönlerde.	Evet
inpaint_items	dizi	Bu video oluşturma işi için isteğe bağlı renklendirme öğeleri.	Hayı
model	String	Bu istek için kullanılacak dağıtımın adı.	Evet
n_seconds	tamsayı	Video oluşturma işinin süresi. 1 ile 20 saniye arasında olmalıdır.	Hayı	5
n_variants	tamsayı	Bu iş için değişken olarak oluşturulacak video sayısı. 1 ile 5 arasında olmalıdır. Daha küçük boyutlar daha fazla değişken sağlar.	Hayı	1
prompt	String	Bu video oluşturma işinin istemi.	Evet
width	tamsayı	Videonun genişliği. Aşağıdaki boyutlar desteklenir: 480x480, 854x480, 720x720, 1280x720, 1080x1080 ve 1920x1080 hem yatay hem de dikey yönlerde.	Evet

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Örnekler

Örnek dosya bulunamadı: ./examples/create_video_generation_job_simple.json

Video oluşturma işleri - Liste

GET {endpoint}/openai/v1/video/generations/jobs?api-version=preview

Video oluşturma işlerini listeler.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm Modelleri API sürümü. v1 aksi belirtilmediyse.
önce	soru	Hayı	String
after	soru	Hayı	String
limit	soru	Evet	tamsayı
statuses	soru	Hayı	dizi

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Örnekler

Örnek dosya bulunamadı: ./examples/get_video_generation_job_list.json

Video oluşturma işlerini al

GET {endpoint}/openai/v1/video/generations/jobs/{job-id}?api-version=preview

Video oluşturma işinin özelliklerini alır.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm Modelleri API sürümü. v1 aksi belirtilmediyse.
job-id	path	Evet	String	Azure OpenAI isteği için kullanılacak video oluşturma görevinin kimliği.

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Örnekler

Örnek dosya bulunamadı: ./examples/get_video_generation_job.json

Video oluşturma işleri - Silme

DELETE {endpoint}/openai/v1/video/generations/jobs/{job-id}?api-version=preview

Video oluşturma işini siler.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm Modelleri API sürümü. v1 aksi belirtilmediyse.
job-id	path	Evet	String	Azure OpenAI isteği için kullanılacak video oluşturma görevinin kimliği.

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

Yanıtlar

Durum Kodu: 204

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

Durum Kodu: varsayılan

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

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

Video nesilleri - Elde et

GET {endpoint}/openai/v1/video/generations/{generation-id}?api-version=preview

Kimliğine göre bir video oluşturma işlemi alır.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm Modelleri API sürümü. v1 aksi belirtilmediyse.
generation-id	path	Evet	String	Azure OpenAI isteğinde kullanılacak video oluşturma kimliği.

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

Yanıtlar

Durum Kodu: 200

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

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

Durum Kodu: varsayılan

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

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

Örnekler

Örnek dosya bulunamadı: ./examples/get_video_generation.json

Video oluşturma - Küçük resmi alma

GET {endpoint}/openai/v1/video/generations/{generation-id}/content/thumbnail?api-version=preview

Oluşturulan video içeriğinin küçük resmini alır.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm Modelleri API sürümü. v1 aksi belirtilmediyse.
generation-id	path	Evet	String	Azure OpenAI isteğinde kullanılacak video oluşturma kimliği.

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

Yanıtlar

Durum Kodu: 200

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

İçerik Türü	Türü	Açıklama
image/jpg	String

Durum Kodu: varsayılan

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

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

Video nesilleri - Video içeriğini alma

GET {endpoint}/openai/v1/video/generations/{generation-id}/content/video?api-version=preview

Oluşturulan video içeriğini alır.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm Modelleri API sürümü. v1 aksi belirtilmediyse.
generation-id	path	Evet	String	Azure OpenAI isteğinde kullanılacak video oluşturma kimliği.
nitelik	soru	Hayı

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

Yanıtlar

Durum Kodu: 200

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

İçerik Türü	Türü	Açıklama
video/mp4	String

Durum Kodu: varsayılan

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

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

Video nesilleri - Yalnızca videocontent üst bilgilerini alma

HEAD {endpoint}/openai/v1/video/generations/{generation-id}/content/video?api-version=preview

Oluşturulan video içeriği için üst bilgileri alır.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	Desteklenen Azure OpenAI 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ı		Bu istek için kullanılacak açık Döküm Modelleri API sürümü. v1 aksi belirtilmediyse.
generation-id	path	Evet	String	Azure OpenAI isteğinde kullanılacak video oluşturma kimliği.
nitelik	soru	Hayı

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

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

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	AzureOpenAIVideoGenerationErrorResponse

Components

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	Varsayılan
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 sonraki bir zamanı temsil etmese de, segmentin başlangıcı segmentin ilişkili arama konumundan çok daha sonraki bir zamanı temsil edebilir.	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	dizi	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	Varsayılan
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	dizi	İşlenen her ses kesiminin zamanlaması, olasılıkları ve diğer ayrıntıları hakkında bilgi koleksiyonu.	Hayı
görev	nesne	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	dizi	İş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	Varsayılan
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	dizi	İşlenen her ses kesiminin zamanlaması, olasılıkları ve diğer ayrıntıları hakkında bilgi koleksiyonu.	Hayı
görev	nesne	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

AzureChatCompletionResponseMessage

Azure OpenAI hizmetinde sohbet tamamlama yanıt iletileri için genişletilmiş yanıt modeli bileşeni. Bu model, amaca yönelik olarak yapılan geriye dönük artırılmış üretimle ilgili niyet, alıntılar ve diğer bilgiler için "Verilerinizde" özelliği tarafından kullanılan sohbet mesajı bağlamı desteği ekler.

İsim	Türü	Description	Gerekli	Varsayılan
Açıklamalar	dizi	Web arama aracını kullanırken olduğu gibi, uygun olduğunda ileti için ek açıklamalar.	Hayı
audio	nesne	Ses çıkış modu istenirse, bu nesne modelin ses yanıtıyla ilgili verileri içerir.	Hayı
└─ veri	String	Model tarafından oluşturulan ve istekte belirtilen biçimde Base64 ile kodlanmış ses baytları.	Hayı
└─ sona_erme_tarihi	tamsayı	Unix zaman damgası (saniye olarak), bu ses yanıtının çok aşamalı konuşmalarda kullanılmak üzere artık sunucuda erişilebilir olmayacağı zamanı belirtir.	Hayı
└─ kimlik	String	Bu ses yanıtı için benzersiz tanımlayıcı.	Hayı
└─ transkript	String	Model tarafından oluşturulan sesin dökümü.	Hayı
içerik	String	İletinin içeriği.	Evet
context	nesne	Uzantı davranışı kullanılırken Azure OpenAI hizmeti tarafından oluşturulan, sohbet tamamlama yanıt iletilerine eklenen ek bir özellik. Bu, Verilerinizde özelliğinden amaç ve alıntı bilgilerini içerir.	Hayı
└─ tüm_getirilen_dokümanlar	nesne	Veri alma işlemi tarafından alınan belgeler hakkındaki özet bilgiler.	Hayı
└─ chunk_id	String	Alıntının parça kimliği.	Hayı
└─ içerik	String	Alıntının içeriği.	Hayı
└─ veri_kaynağı_indeksi	tamsayı	Alma için kullanılan veri kaynağının dizini.	Hayı
└─ dosya yolu	String	Alıntının dosya yolu.	Hayı
└─ filtre_sebebi	enum	Varsa, belgenin neden filtrelendiğini gösteren bir gösterge. Olası değerler: score, rerank	Hayı
└─ orijinal arama puanı	Numara	Getirme işlemine ait orijinal arama puanı.	Hayı
└─ yeniden sıralama puanı	Numara	Getirme için yeniden sıralama puanı.	Hayı
└─ arama_sorguları	dizi	Belgeleri almak için yürütülen arama sorguları.	Hayı
└─ başlığı	String	Alıntının başlığı.	Hayı
└─ web adresi	String	Alıntının URL'si.	Hayı
└─ alıntılar	dizi	Veri alma tarafından oluşturulan alıntılar.	Hayı
└─ niyet	String	Etkileşimler arasında konuşma bağlamı taşımak için kullanılan sohbet geçmişinden algılanan amaç	Hayı
function_call	nesne	kullanım dışı bırakıldı ve tarafından tool_callsdeğiştirildi. Model tarafından oluşturulduğu gibi çağrılması gereken bir işlevin adı ve bağımsız değişkenleri.	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'a özgü bir uzantı özelliği.	Hayı
Ret	String	Model tarafından oluşturulan reddetme iletisi.	Evet
role	enum	Bu iletinin yazarının rolü. Olası değerler: assistant	Evet
tool_calls	ChatCompletionMessageToolCallsItem	Araç, işlev çağrıları gibi model tarafından oluşturulan çağrılar.	Hayı

AzureChatCompletionStreamResponseDelta

Azure OpenAI hizmetindeki bir akış sohbeti yanıt iletisi için genişletilmiş yanıt modeli. Bu model, amaca yönelik olarak yapılan geriye dönük artırılmış üretimle ilgili niyet, alıntılar ve diğer bilgiler için "Verilerinizde" özelliği tarafından kullanılan sohbet mesajı bağlamı desteği ekler.

İsim	Türü	Description	Gerekli	Varsayılan
audio	nesne		Hayı
└─ veri	String		Hayı
└─ sona_erme_tarihi	tamsayı		Hayı
└─ kimlik	String		Hayı
└─ transkript	String		Hayı
içerik	String	Öbek iletisinin içeriği.	Hayı
context	nesne	Uzantı davranışı kullanılırken Azure OpenAI hizmeti tarafından oluşturulan, sohbet tamamlama yanıt iletilerine eklenen ek bir özellik. Bu, Verilerinizde özelliğinden amaç ve alıntı bilgilerini içerir.	Hayı
└─ tüm_getirilen_dokümanlar	nesne	Veri alma işlemi tarafından alınan belgeler hakkındaki özet bilgiler.	Hayı
└─ chunk_id	String	Alıntının parça kimliği.	Hayı
└─ içerik	String	Alıntının içeriği.	Hayı
└─ veri_kaynağı_indeksi	tamsayı	Alma için kullanılan veri kaynağının dizini.	Hayı
└─ dosya yolu	String	Alıntının dosya yolu.	Hayı
└─ filtre_sebebi	enum	Varsa, belgenin neden filtrelendiğini gösteren bir gösterge. Olası değerler: score, rerank	Hayı
└─ orijinal arama puanı	Numara	Getirme işlemine ait orijinal arama puanı.	Hayı
└─ yeniden sıralama puanı	Numara	Getirme için yeniden sıralama puanı.	Hayı
└─ arama_sorguları	dizi	Belgeleri almak için yürütülen arama sorguları.	Hayı
└─ başlığı	String	Alıntının başlığı.	Hayı
└─ web adresi	String	Alıntının URL'si.	Hayı
└─ alıntılar	dizi	Veri alma tarafından oluşturulan alıntılar.	Hayı
└─ niyet	String	Etkileşimler arasında konuşma bağlamı taşımak için kullanılan sohbet geçmişinden algılanan amaç	Hayı
function_call	nesne	kullanım dışı bırakıldı ve tarafından tool_callsdeğiştirildi. Model tarafından oluşturulduğu gibi çağrılması gereken bir işlevin adı ve bağımsız değişkenleri.	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'a özgü bir uzantı özelliği.	Hayı
Ret	String	Model tarafından oluşturulan reddetme iletisi.	Hayı
role	nesne	İletinin yazarının rolü	Hayı
tool_calls	dizi		Hayı

AzureChatDataSource

Tek bir Azure OpenAI sohbet veri kaynağı için yapılandırma verilerinin gösterimi. Bu, yanıt davranışını artırmak için Azure OpenAI sohbet uzantılarını kullanması gereken bir sohbet tamamlama isteği tarafından kullanılır. Bu yapılandırmanın kullanımı yalnızca Azure OpenAI ile uyumludur.

AzureChatDataSource için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
azure_search	AzureSearchChatDataSource
azure_cosmos_db	AzureCosmosDBChatDataSource
elasticsearch	ElasticsearchChatDataSource
pinecone	PineconeChatDataSource
mongo_db	MongoDBChatDataSource

İsim	Türü	Description	Gerekli	Varsayılan
type	nesne		Evet

AzureChatDataSourceAccessTokenAuthenticationOptions

İsim	Türü	Description	Gerekli	Varsayılan
access_token	String		Evet
type	enum	Olası değerler: access_token	Evet

AzureChatDataSourceApiKeyAuthenticationOptions

İsim	Türü	Description	Gerekli	Varsayılan
key	String		Evet
type	enum	Olası değerler: api_key	Evet

AzureChatDataSourceAuthenticationOptions

AzureChatDataSourceAuthenticationOptions için Ayırt Edici Parametre

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
system_assigned_managed_identity	AzureChatDataSourceSystemAssignedManagedIdentityAuthenticationOptions
user_assigned_managed_identity	AzureChatDataSourceUserAssignedManagedIdentityAuthenticationOptions
access_token	AzureChatDataSourceAccessTokenAuthenticationOptions
connection_string	AzureChatDataSourceConnectionStringAuthenticationOptions
key_and_key_id	AzureChatDataSourceKeyAndKeyIdAuthenticationOptions
encoded_api_key	AzureChatDataSourceEncodedApiKeyAuthenticationOptions
username_and_password	AzureChatDataSourceUsernameAndPasswordAuthenticationOptions

İsim	Türü	Description	Gerekli	Varsayılan
type	AzureChatDataSourceAuthenticationOptionsType		Evet

AzureChatDataSourceAuthenticationOptionsType

Mülkiyet	Değer
Türü	String
Değerler	api_key username_and_password connection_string key_and_key_id encoded_api_key access_token system_assigned_managed_identity user_assigned_managed_identity

AzureChatDataSourceConnectionStringAuthenticationOptions

İsim	Türü	Description	Gerekli	Varsayılan
connection_string	String		Evet
type	enum	Olası değerler: connection_string	Evet

AzureChatDataSourceDeploymentNameVectorizationSource

Azure OpenAI ekleme modeli dağıtımına karşı iç hizmet çağrıları yapan vektörleştirme kaynağını temsil eder. Uç nokta tabanlı vektörleştirme kaynağının aksine, dağıtım adı tabanlı vektörleştirme kaynağı aynı Azure OpenAI kaynağının parçası olmalıdır, ancak özel ağlarda bile kullanılabilir.

İsim	Türü	Description	Gerekli	Varsayılan
dağıtım_adı	String	Vektörleştirme için kullanılacak gömme modeli dağıtımı. Bu dağıtım, sohbet tamamlamaları için kullanılan model dağıtımıyla aynı Azure OpenAI kaynağı içinde bulunmalıdır.	Evet
dimensions	tamsayı	Eklemeler için istenecek boyut sayısı. Yalnızca 'text-embedding-3' ve sonraki modellerde desteklenir.	Hayı
type	enum	Bu vektörleştirme kaynak türü için tür tanımlayıcısı her zaman 'deployment_name' olur. Olası değerler: deployment_name	Evet

AzureChatDataSourceEncodedApiKeyAuthenticationOptions

İsim	Türü	Description	Gerekli	Varsayılan
encoded_api_key	String		Evet
type	enum	Olası değerler: encoded_api_key	Evet

AzureChatDataSourceEndpointVectorizationSource

Azure OpenAI gömme modeli dağıtımına karşı genel hizmet çağrıları yapan vektörleştirme kaynağını temsil eder.

İsim	Türü	Description	Gerekli	Varsayılan
kimlik doğrulama	nesne		Evet
└─ erişim belirteci	String		Hayı
└─ anahtar	String		Hayı
└─ türü	enum	Olası değerler: access_token	Hayı
dimensions	tamsayı	Eklemeler için istenecek boyut sayısı. Yalnızca 'text-embedding-3' ve sonraki modellerde desteklenir.	Hayı
endpoint	String	Eklemelerin alınması gereken kaynak uç noktası URL'sini belirtir. Şu biçimde olmalıdır: https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings. Api sürümü sorgu parametresine izin verilmiyor.	Evet
type	enum	Bu vektörleştirme kaynak türü için tür tanımlayıcısı her zaman 'uç nokta'dır. Olası değerler: endpoint	Evet

AzureChatDataSourceIntegratedVectorizationSource

Destekleyici arama kaynağında tanımlandığı gibi tümleşik bir vektörleştirme kaynağını temsil eder.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Bu vektörleştirme kaynak türü için tür tanımlayıcı, her zaman 'entegre' olur. Olası değerler: integrated	Evet

AzureChatDataSourceKeyAndKeyIdAuthenticationOptions

İsim	Türü	Description	Gerekli	Varsayılan
key	String		Evet
key_id	String		Evet
type	enum	Olası değerler: key_and_key_id	Evet

AzureChatDataSourceModelIdVectorizationSource

Arama hizmeti modeli kimliğine göre hizmet çağrıları yapan vektörleştirme kaynağını temsil eder. Bu kaynak türü şu anda yalnızca Elasticsearch tarafından desteklenmektedir.

İsim	Türü	Description	Gerekli	Varsayılan
model_id	String	Vektörleştirme için kullanılacak gömme modelin derleme kimliği.	Evet
type	enum	Bu vektörleştirme kaynak türü için tür tanımlayıcı her zaman 'model_id' olur. Olası değerler: model_id	Evet

AzureChatDataSourceSystemAssignedManagedIdentityAuthenticationOptions

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olası değerler: system_assigned_managed_identity	Evet

AzureChatDataSourceType

Mülkiyet	Değer
Türü	String
Değerler	azure_search azure_cosmos_db elasticsearch pinecone mongo_db

AzureChatDataSourceUserAssignedManagedIdentityAuthenticationOptions

İsim	Türü	Description	Gerekli	Varsayılan
managed_identity_resource_id	String		Evet
type	enum	Olası değerler: user_assigned_managed_identity	Evet

AzureChatDataSourceUsernameAndPasswordAuthenticationOptions

İsim	Türü	Description	Gerekli	Varsayılan
şifre	String		Evet
type	enum	Olası değerler: username_and_password	Evet
kullanıcı adı	String		Evet

AzureChatDataSourceVectorizationSource

Veri kaynağı ile ekleme kaynağı olarak kullanılabilen bir veri vektörleştirme kaynağının gösterimi.

AzureChatDataSourceVectorizationSource için Sınıflandı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
deployment_name	AzureChatDataSourceDeploymentNameVectorizationSource
integrated	AzureChatDataSourceIntegratedVectorizationSource
model_id	AzureChatDataSourceModelIdVectorizationSource

İsim	Türü	Description	Gerekli	Varsayılan
type	nesne		Evet

AzureChatDataSourceVectorizationSourceType

Mülkiyet	Değer
Türü	String
Değerler	endpoint deployment_name model_id integrated

AzureChatMessageContext

Uzantı davranışı kullanılırken Azure OpenAI hizmeti tarafından oluşturulan, sohbet tamamlama yanıt iletilerine eklenen ek bir özellik. Bu, Verilerinizde özelliğinden amaç ve alıntı bilgilerini içerir.

İsim	Türü	Description	Gerekli	Varsayılan
all_retrieved_documents	nesne	Veri alma işlemi tarafından alınan belgeler hakkındaki özet bilgiler.	Hayı
└─ chunk_id	String	Alıntının parça kimliği.	Hayı
└─ içerik	String	Alıntının içeriği.	Hayı
└─ veri_kaynağı_indeksi	tamsayı	Alma için kullanılan veri kaynağının dizini.	Hayı
└─ dosya yolu	String	Alıntının dosya yolu.	Hayı
└─ filtre_sebebi	enum	Varsa, belgenin neden filtrelendiğini gösteren bir gösterge. Olası değerler: score, rerank	Hayı
└─ orijinal arama puanı	Numara	Getirme işlemine ait orijinal arama puanı.	Hayı
└─ yeniden sıralama puanı	Numara	Getirme için yeniden sıralama puanı.	Hayı
└─ arama_sorguları	dizi	Belgeleri almak için yürütülen arama sorguları.	Hayı
└─ başlığı	String	Alıntının başlığı.	Hayı
└─ web adresi	String	Alıntının URL'si.	Hayı
citations	dizi	Veri alma tarafından oluşturulan alıntılar.	Hayı
intent	String	Etkileşimler arasında konuşma bağlamı taşımak için kullanılan sohbet geçmişinden algılanan amaç	Hayı

AzureContentFilterBlocklistResult

Yapılandırılmış özel blok listeleri için true/false filtreleme sonuçları koleksiyonu.

İsim	Türü	Description	Gerekli	Varsayılan
details	dizi	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 tamamlanma metni aralığının gösterimi.

İsim	Türü	Description	Gerekli	Varsayılan
completion_end_offset	tamsayı	İlk UTF32 kod noktasının yayılma alanından dışlanan uzaklığı. Bu alan her zaman boş aralıklar için completion_start_offset 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	Varsayılan
details	dizi	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

AzureContentFilterCustomTopicResult

Yapılandırılmış özel konular için doğru/yanlış filtreleme sonuçları koleksiyonu.

İsim	Türü	Description	Gerekli	Varsayılan
details	dizi	Tek tek konu kimliklerinin çiftleri ve algılanıp algılanmadıkları.	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

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	Varsayılan
custom_blocklists	nesne	Yapılandırılmış özel blok listeleri için true/false filtreleme sonuçları koleksiyonu.	Hayı
└─ ayrıntılar	dizi	Bireysel blok listesi kimlik çiftleri ve bunların filtreleme işlemine yol açıp açmadığı.	Hayı
└─ filtrelenmiş	Boolean	Ayrıntılı blok listelerinden herhangi birinin filtreleme eylemiyle sonuçlanıp sonuçlanmadığını gösteren değer.	Hayı
custom_topics	nesne	Yapılandırılmış özel konular için doğru/yanlış filtreleme sonuçları koleksiyonu.	Hayı
└─ ayrıntılar	dizi	Tek tek konu kimliklerinin çiftleri ve algılanıp algılanmadıkları.	Hayı
└─ filtrelenmiş	Boolean	Ayrıntılı konu başlıklarından herhangi birinin filtreleme eylemiyle sonuçlanıp sonuçlanmadığını gösteren değer.	Hayı
jailbreak	nesne	İçeriğin algılanıp algılandığını ve içeriğin filtrelenip filtrelenmediğini gösteren etiketli bir içerik filtresi sonuç öğesi.	Evet
└─ algılandı	Boolean	Etiketli içerik kategorisinin içerikte algılanıp algılanmadığını.	Hayı
└─ filtrelenmiş	Boolean	İçerik algılamanın bir içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Hayı
profanity	nesne	İçeriğin algılanıp algılandığını ve içeriğin filtrelenip filtrelenmediğini gösteren etiketli bir içerik filtresi sonuç öğesi.	Hayı
└─ algılandı	Boolean	Etiketli içerik kategorisinin içerikte algılanıp algılanmadığını.	Hayı
└─ filtrelenmiş	Boolean	İçerik algılamanın bir içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Hayı

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	Varsayılan
hate	nesne	İç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.	Hayı
└─ filtrelenmiş	Boolean	İçerik önem derecesinin içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Hayı
└─ önem derecesi	enum	İçeriğin etiketli önem derecesi. Olası değerler: safe, low, medium, high	Hayı
self_harm	nesne	İç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.	Hayı
└─ filtrelenmiş	Boolean	İçerik önem derecesinin içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Hayı
└─ önem derecesi	enum	İçeriğin etiketli önem derecesi. Olası değerler: safe, low, medium, high	Hayı
sexual	nesne	İç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.	Hayı
└─ filtrelenmiş	Boolean	İçerik önem derecesinin içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Hayı
└─ önem derecesi	enum	İçeriğin etiketli önem derecesi. Olası değerler: safe, low, medium, high	Hayı
violence	nesne	İç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.	Hayı
└─ filtrelenmiş	Boolean	İçerik önem derecesinin içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Hayı
└─ önem derecesi	enum	İçeriğin etiketli önem derecesi. Olası değerler: safe, low, medium, high	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	Varsayılan
custom_blocklists	nesne	Yapılandırılmış özel blok listeleri için true/false filtreleme sonuçları koleksiyonu.	Hayı
└─ ayrıntılar	dizi	Bireysel blok listesi kimlik çiftleri ve bunların filtreleme işlemine yol açıp açmadığı.	Hayı
└─ filtrelenmiş	Boolean	Ayrıntılı blok listelerinden herhangi birinin filtreleme eylemiyle sonuçlanıp sonuçlanmadığını gösteren değer.	Hayı
custom_topics	nesne	Yapılandırılmış özel konular için doğru/yanlış filtreleme sonuçları koleksiyonu.	Hayı
└─ ayrıntılar	dizi	Tek tek konu kimliklerinin çiftleri ve algılanıp algılanmadıkları.	Hayı
└─ filtrelenmiş	Boolean	Ayrıntılı konu başlıklarından herhangi birinin filtreleme eylemiyle sonuçlanıp sonuçlanmadığını gösteren değer.	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.	Hayı
└─ ileti	String	Hata ile ilişkili insan tarafından okunabilir bir mesaj.	Hayı
hate	nesne	İç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.	Hayı
└─ filtrelenmiş	Boolean	İçerik önem derecesinin içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Hayı
└─ önem derecesi	enum	İçeriğin etiketli önem derecesi. Olası değerler: safe, low, medium, high	Hayı
profanity	nesne	İçeriğin algılanıp algılandığını ve içeriğin filtrelenip filtrelenmediğini gösteren etiketli bir içerik filtresi sonuç öğesi.	Hayı
└─ algılandı	Boolean	Etiketli içerik kategorisinin içerikte algılanıp algılanmadığını.	Hayı
└─ filtrelenmiş	Boolean	İçerik algılamanın bir içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	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ı.	Hayı
└─ filtrelenmiş	Boolean	İçerik algılamanın bir içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Hayı
protected_material_text	nesne	İçeriğin algılanıp algılandığını ve içeriğin filtrelenip filtrelenmediğini gösteren etiketli bir içerik filtresi sonuç öğesi.	Hayı
└─ algılandı	Boolean	Etiketli içerik kategorisinin içerikte algılanıp algılanmadığını.	Hayı
└─ filtrelenmiş	Boolean	İçerik algılamanın bir içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Hayı
self_harm	nesne	İç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.	Hayı
└─ filtrelenmiş	Boolean	İçerik önem derecesinin içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Hayı
└─ önem derecesi	enum	İçeriğin etiketli önem derecesi. Olası değerler: safe, low, medium, high	Hayı
sexual	nesne	İç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.	Hayı
└─ filtrelenmiş	Boolean	İçerik önem derecesinin içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Hayı
└─ önem derecesi	enum	İçeriğin etiketli önem derecesi. Olası değerler: safe, low, medium, high	Hayı
ungrounded_material	AzureContentFilterCompletionTextSpanDetectionResult		Hayı
violence	nesne	İç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.	Hayı
└─ filtrelenmiş	Boolean	İçerik önem derecesinin içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Hayı
└─ önem derecesi	enum	İçeriğin etiketli önem derecesi. Olası değerler: safe, low, medium, high	Hayı

AzureContentFilterResultForPrompt

Üretken bir yapay zeka sistemine tek bir giriş istemi öğesiyle ilişkilendirilmiş içerik filtresi sonucu.

İsim	Türü	Description	Gerekli	Varsayılan
content_filter_results	nesne	Sonuç için içerik filtresi kategori ayrıntıları.	Hayı
└─ özel blok listeleri	nesne	Yapılandırılmış özel blok listeleri için true/false filtreleme sonuçları koleksiyonu.	Hayı
└─ ayrıntılar	dizi	Bireysel blok listesi kimlik çiftleri ve bunların filtreleme işlemine yol açıp açmadığı.	Hayı
└─ filtrelenmiş	Boolean	Ayrıntılı blok listelerinden herhangi birinin filtreleme eylemiyle sonuçlanıp sonuçlanmadığını gösteren değer.	Hayı
└─ özelleştirilmiş_konular	nesne	Yapılandırılmış özel konular için doğru/yanlış filtreleme sonuçları koleksiyonu.	Hayı
└─ ayrıntılar	dizi	Tek tek konu kimliklerinin çiftleri ve algılanıp algılanmadıkları.	Hayı
└─ filtrelenmiş	Boolean	Ayrıntılı konu başlıklarından herhangi birinin filtreleme eylemiyle sonuçlanıp sonuçlanmadığını gösteren değer.	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.	Hayı
└─ ileti	String	Hata ile ilişkili insan tarafından okunabilir bir mesaj.	Hayı
└─ nefret	nesne	İç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.	Hayı
└─ filtrelenmiş	Boolean	İçerik önem derecesinin içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Hayı
└─ önem derecesi	enum	İçeriğin etiketli önem derecesi. Olası değerler: safe, low, medium, high	Hayı
└─ dolaylı_saldırı	nesne	İçeriğin algılanıp algılandığını ve içeriğin filtrelenip filtrelenmediğini gösteren etiketli bir içerik filtresi sonuç öğesi.	Hayı
└─ algılandı	Boolean	Etiketli içerik kategorisinin içerikte algılanıp algılanmadığını.	Hayı
└─ filtrelenmiş	Boolean	İçerik algılamanın bir içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Hayı
└─ jailbreak (cihazdaki kısıtlamaların kaldırılması)	nesne	İçeriğin algılanıp algılandığını ve içeriğin filtrelenip filtrelenmediğini gösteren etiketli bir içerik filtresi sonuç öğesi.	Hayı
└─ algılandı	Boolean	Etiketli içerik kategorisinin içerikte algılanıp algılanmadığını.	Hayı
└─ filtrelenmiş	Boolean	İçerik algılamanın bir içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Hayı
└─ küfür	nesne	İçeriğin algılanıp algılandığını ve içeriğin filtrelenip filtrelenmediğini gösteren etiketli bir içerik filtresi sonuç öğesi.	Hayı
└─ algılandı	Boolean	Etiketli içerik kategorisinin içerikte algılanıp algılanmadığını.	Hayı
└─ filtrelenmiş	Boolean	İçerik algılamanın bir içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Hayı
└─ kendine zarar verme	nesne	İç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.	Hayı
└─ filtrelenmiş	Boolean	İçerik önem derecesinin içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Hayı
└─ önem derecesi	enum	İçeriğin etiketli önem derecesi. Olası değerler: safe, low, medium, high	Hayı
└─ cinsel	nesne	İç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.	Hayı
└─ filtrelenmiş	Boolean	İçerik önem derecesinin içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Hayı
└─ önem derecesi	enum	İçeriğin etiketli önem derecesi. Olası değerler: safe, low, medium, high	Hayı
└─ şiddet	nesne	İç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.	Hayı
└─ filtrelenmiş	Boolean	İçerik önem derecesinin içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı.	Hayı
└─ önem derecesi	enum	İçeriğin etiketli önem derecesi. Olası değerler: safe, low, medium, high	Hayı
prompt_index	tamsayı	Eşlik eden içerik filtresi sonuç kategorileri ile ilişkili giriş isteminin dizini.	Hayı

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

AzureCosmosDBChatDataSource

Azure CosmosDB kaynağı kullanacak bir veri kaynağı yapılandırmasını temsil eder.

İsim	Türü	Description	Gerekli	Varsayılan
parameters	nesne	Azure CosmosDB veri kaynağının kullanımını denetlemek için parametre bilgileri.	Evet
└─ kısmi_sonuç_izin_ver	Boolean	True olarak ayarlanırsa, sistem kısmi arama sonuçlarının kullanılmasına izin verir ve tüm kısmi sorgular başarısız olursa istek başarısız olur. Belirtilmezse veya false olarak belirtilmezse, herhangi bir arama sorgusu başarısız olursa istek başarısız olur.	Hayı	Yanlış
└─ kimlik doğrulaması	AzureChatDataSourceConnectionStringAuthenticationOptions		Hayı
└─ konteyner_adı	String		Hayı
└─ veri_tabani_adi	String		Hayı
└─ gömme_bağımlılığı	AzureChatDataSourceVectorizationSource	Veri kaynağı ile ekleme kaynağı olarak kullanılabilen bir veri vektörleştirme kaynağının gösterimi.	Hayı
└─ alanlar_haritalama	nesne		Hayı
└─ içerik_alanları	dizi		Hayı
└─ içerik_alanları_ayırıcı	String		Hayı
└─ dosyayolu_alani	String		Hayı
└─ başlık_alanı	String		Hayı
└─ url_alanı	String		Hayı
└─ vektör_alanları	dizi		Hayı
└─ in_scope	Boolean	Sorguların dizine alınan verilerin kullanımıyla sınırlandırılıp kısıtlanmaması gerektiği.	Hayı
└─ kapsamları_dahil_et	dizi	Yanıta dahil edilecek çıktı bağlamı özellikleri. Varsayılan olarak, alıntılar ve amaç istenir.	Hayı	['alıntılar', 'amaç']
└─ indeks_adı	String		Hayı
└─ max_search_queries (maksimum arama sorguları)	tamsayı	Tek bir kullanıcı iletisi için arama sağlayıcısına gönderilmesi gereken en fazla yeniden yazılan sorgu sayısı. Varsayılan olarak, sistem otomatik bir belirleme yapar.	Hayı
└─ katılık	tamsayı	Arama ilgi filtresinin yapılandırılmış katılığı. Daha yüksek katılık, yanıtın doğruluğunu artırır ancak geri çağırma oranını düşürür.	Hayı
└─ top_n_documents	tamsayı	Sorguda öne çıkması için yapılandırılan belge sayısı.	Hayı
type	enum	Her zaman 'azure_cosmos_db' olarak belirtilen ayrımcı tür tanımlayıcısı. Olası değerler: azure_cosmos_db	Evet

AzureCreateChatCompletionRequest

Azure OpenAI hizmetine yönelik sohbet tamamlamaları için genişletilmiş istek modeli. Bu, Verilerinizde özelliği için veri kaynakları sağlama özelliğini ekler.

İsim	Türü	Description	Gerekli	Varsayılan
audio	nesne	Ses çıkışı parametreleri. ile modalities: ["audio"]ses çıkışı istendiğinde gereklidir.	Hayı
└─ biçimi	enum	Çıkış ses biçimini belirtir. wav, mp3, flac, opus veya pcm16'den biri olmalıdır. Olası değerler: wav, aac, mp3, flac, , opus, pcm16	Hayı
└─ ses	nesne		Hayı
data_sources	dizi	Azure OpenAI'ye özel olarak Verilerinizde özelliği için kullanılacak veri kaynakları.	Hayı
frekans cezası	Numara	-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.	Hayı	0
function_call	enum	aracılığıyla {"name": "my_function"} belirli bir işlevin belirtilmesi, modeli bu işlevi çağırmaya zorlar. Olası değerler: none, auto	Hayı
functions	dizi	yerine toolskullanım dışı bırakıldı. Modelin JSON girişleri oluşturabileceği işlevlerin listesi.	Hayı
logit önyargısı	nesne	Belirtilen belirteçlerin tamamlanmada görünme olasılığını değiştirin. Belirteçleri (belirteç oluşturucudaki 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.	Hayı	Hiç kimse
logprobs	Boolean	Çıkış belirteçlerinin günlük olasılıklarının döndürülmesi veya döndürülmemesi. True ise, içinde döndürülen contentmessageher çıkış belirtecinin günlük olasılıklarını döndürür.	Hayı	Yanlış
max_completion_tokens	tamsayı	Görünür çıkış belirteçleri ve muhakeme belirteçleri de dahil olmak üzere tamamlanmak üzere oluşturulabilecek belirteç sayısı için üst sınır.	Hayı
maksimum_token	tamsayı	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 artık max_completion_tokens lehine kullanım dışı bırakılmıştır ve o1 serisi modelleriyle uyumlu değildir.	Hayı
Mesajlar	dizi	Şu ana kadarki konuşmayı içeren iletilerin listesi. Kullandığınız modele bağlı olarak metin, resim ve ses gibi farklı ileti türleri (kalıcılıklar) desteklenir.	Evet
metadata	nesne	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.	Hayı
kalıcılıklar	nesne	Modelin oluşturmasını istediğiniz çıkış türleri. Çoğu model, varsayılan olan metin oluşturabilir: ["text"] Model gpt-4o-audio-preview ses 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"]	Hayı
model	String	Sohbet tamamlama isteği için kullanılacak model dağıtım tanımlayıcısı.	Evet
n	tamsayı	Her giriş iletisi için oluşturulacak sohbet tamamlama seçenekleri. Tüm seçeneklerde oluşturulan belirteç sayısına göre ücretlendirileceğini unutmayın. Maliyetleri en aza indirmek için farklı n tutun1.	Hayı	1
paralel araç çağrıları	nesne	Araç kullanımı sırasında paralel işlev çağrısının etkinleştirilip etkinleştirilmeyileceği.	Hayı
prediction	nesne	Modelden tahmin edilen çıkışın temel gösterimi.	Hayı
└─ türü	OpenAI.ChatOutputPredictionType		Hayı
varlık cezası	Numara	-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.	Hayı	0
akıl yürütme çabası	nesne	yalnızca o serisi modeller Mantıp modelleri için mantık yürütme çabasını kısıtlar. Şu anda desteklenen değerler , lowve medium'tirhigh. Muhakeme çabasının azaltılması, yanıtta daha hızlı yanıtlar ve daha az belirteç kullanılmasına neden olabilir.	Hayı
yanıt formatı	nesne		Hayı
└─ türü	enum	Olası değerler: text, json_object, json_schema	Hayı
seed	tamsayı	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	nesne	En son mantık modelleri o3 ve o4-miniile desteklenmez. API'nin başka belirteçler üretmeyi durduracağı en fazla 4 dizi. Döndürülen metin durdurma sırasını içermez.	Hayı
store	Boolean	Bu sohbet tamamlama isteğinin çıkışını model damıtma veya değerlendirme ürünlerinde kullanmak üzere depolamak isteyip istemediğiniz.	Hayı	Yanlış
veri akışı	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.	Hayı	Yanlış
stream_options	nesne	Akış yanıtı seçenekleri. Bunu yalnızca ayarladığınızda ayarlayın stream: true.	Hayı
└─ kullanım_dahil_et	Boolean	Ayarlanırsa, iletiden önce data: [DONE] ek bir öbek akışı oluşturulur. usage Bu öbek üzerindeki alan, isteğin tamamı için belirteç kullanım istatistiklerini gösterir ve choices alan her zaman boş bir dizi olur. Diğer tüm öbekler de null değer içeren bir usage alan içerir. NOT: Akış kesintiye uğrarsa, istek için toplam belirteç kullanımını içeren son kullanım öbeği almayabilirsiniz.	Hayı
sıcaklık	Numara	0 ile 2 arasında hangi örnekleme sıcaklığının kullanılacağı. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir. Genellikle bunu değiştirmenizi öneririz top_p ancak ikisini birden değiştirmemenizi öneririz.	Hayı	1
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	dizi	Modelin çağırabileceği araçların listesi. Şu anda araç olarak yalnızca işlevler desteklenmektedir. Modelin JSON girişleri oluşturabileceği işlevlerin listesini sağlamak için bunu kullanın. En fazla 128 işlev desteklenir.	Hayı
top_logprobs	tamsayı	Her biri ilişkili günlük olasılığına sahip her belirteç konumunda döndürülecek en olası belirteç sayısını belirten 0 ile 20 arasında bir tamsayı.	Hayı
top_p	Numara	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ı	1
user	String	Kötüye kullanımı izlemenize ve algılamanıza yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı.	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. Bulut için Microsoft Defender kullanarak yapay zeka uygulamalarını koruma hakkında daha fazla bilgi edinin.	Hayı

AzureCreateChatCompletionResponse

Azure OpenAI hizmeti için genişletilmiş üst düzey sohbet tamamlama yanıt modeli. Bu model, istem girişi için Sorumlu yapay zeka içerik filtresi ek açıklamaları ekler.

İsim	Türü	Description	Gerekli	Varsayılan
choices	dizi		Evet
created	tamsayı	Sohbet tamamlamanın oluşturulduğu Unix zaman damgası (saniye olarak).	Evet
kimlik	String	Sohbetin tamamlanması için benzersiz bir tanımlayıcı.	Evet
model	String	Sohbetin tamamlanması için kullanılan model.	Evet
nesne	enum	Her zaman chat.completionolan nesne türü. Olası değerler: chat.completion	Evet
prompt_filter_results	dizi	Sorumlu yapay zeka içerik filtresi ek açıklamaları, sohbet tamamlamalarına yönelik istem girişleri ile ilişkilidir.	Hayı
system_fingerprint	String	Bu parmak izi, modelin birlikte çalıştığı arka uç yapılandırmasını temsil eder. Determinizmi etkileyebilecek arka uç değişikliklerinin ne zaman yapıldığını anlamak için istek parametresiyle seed birlikte kullanılabilir.	Hayı
usage	OpenAI.CompletionUsage	Tamamlanma isteği için kullanım istatistikleri.	Hayı

AzureCreateChatCompletionStreamResponse

İsim	Türü	Description	Gerekli	Varsayılan
choices	dizi	Sohbet tamamlama seçeneklerinin listesi. 1'den büyükse n birden fazla öğe içerebilir. ayarlarsanız, stream_options: {"include_usage": true} son öbek için de boş olabilir.	Evet
content_filter_results	AzureContentFilterResultForChoice	Üretken bir yapay zeka sistemi tarafından üretilen tek bir yanıt öğesi için içerik filtresi sonucu.	Hayı
created	tamsayı	Sohbet tamamlamanın oluşturulduğu Unix zaman damgası (saniye olarak). Her öbek aynı zaman damgasına sahiptir.	Evet
delta	AzureChatCompletionStreamResponseDelta	Azure OpenAI hizmetindeki bir akış sohbeti yanıt iletisi için genişletilmiş yanıt modeli. Bu model, amaca yönelik olarak yapılan geriye dönük artırılmış üretimle ilgili niyet, alıntılar ve diğer bilgiler için "Verilerinizde" özelliği tarafından kullanılan sohbet mesajı bağlamı desteği ekler.	Hayı
kimlik	String	Sohbetin tamamlanması için benzersiz bir tanımlayıcı. Her öbek aynı kimliktedir.	Evet
model	String	Tamamlanmayı oluşturmak için model.	Evet
nesne	enum	Her zaman chat.completion.chunkolan nesne türü. Olası değerler: chat.completion.chunk	Evet
system_fingerprint	String	Bu parmak izi, modelin birlikte çalıştığı arka uç yapılandırmasını temsil eder. Determinizmi etkileyebilecek arka uç değişikliklerinin ne zaman yapıldığını anlamak için istek parametresiyle seed birlikte kullanılabilir.	Hayı
usage	nesne	Tamamlanma isteği için kullanım istatistikleri.	Hayı
└─ tamamlama_tokenleri	tamsayı	Oluşturulan tamamlamadaki belirteçlerin sayısı.	Hayı	0
└─ tamamlama_jetonları_detayları	nesne	Tamamlanmada kullanılan belirteçlerin dökümü.	Hayı
└─ kabul edilen tahmin belirteçleri	tamsayı	Tahmin Edilen Çıkışlar kullanılırken, tahmindeki tamamlanmada görünen belirteç sayısı.	Hayı	0
└─ ses_öğeleri	tamsayı	Model tarafından oluşturulan ses giriş belirteçleri.	Hayı	0
└─ akıl yürütme_tokenlar	tamsayı	Model tarafından mantık yürütme için oluşturulan belirteçler.	Hayı	0
└─ reddedilen_tahmin_tokenları	tamsayı	Tahmin Edilen Çıkışlar kullanılırken, tahmindeki tamamlanmada görünmeyen belirteçlerin sayısı. Ancak, akıl yürütme belirteçleri gibi bu belirteçler de faturalama, çıkış ve bağlam penceresi sınırları için toplam tamamlanma belirteçlerinde sayılır.	Hayı	0
└─ istem_belirteçleri	tamsayı	İstemdeki belirteç sayısı.	Hayı	0
└─ istem_jeton_detayları	nesne	İstemde kullanılan belirteçlerin dökümü.	Hayı
└─ ses_öğeleri	tamsayı	İstemde ses giriş belirteçleri bulunur.	Hayı	0
└─ önbelleğe alınmış jetonlar	tamsayı	İstemde önbelleğe alınmış belirteçler bulunmaktadır.	Hayı	0
└─ toplam_jetonlar	tamsayı	İstekte kullanılan toplam belirteç sayısı (istem + tamamlama).	Hayı	0

AzureCreateEmbeddingRequest

İsim	Türü	Description	Gerekli	Varsayılan
dimensions	tamsayı	Sonuçta elde edilen çıktı eklemelerinin sahip olması gereken boyut sayısı. Yalnızca ve sonraki modellerde text-embedding-3 desteklenir.	Hayı
encoding_format	enum	Eklemelerin döndürüleceği biçim. veya floatolabilirbase64. Olası değerler: float, base64	Hayı
girdi	dize veya dizi		Evet
model	String	Ekleme isteği için kullanılacak model.	Evet
user	String	OpenAI'nin kötüye kullanımı izlemesine ve algılamasına yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı.	Hayı

AzureCreateFileRequestMultiPart

İsim	Türü	Description	Gerekli	Varsayılan
sona_erdikten_sonra	nesne		Evet
└─ tutturucu	AzureFileExpiryAnchor		Hayı
└─ saniye	tamsayı		Hayı
dosya	String		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

AzureCreateImageEditRequestMultiPart

İsim	Türü	Description	Gerekli	Varsayılan
arka plan	enum	Oluşturulan görüntülerin arka planı için saydamlık ayarlamaya olanak tanır. Bu parametre yalnızca gpt-image-1-serisi modeller için desteklenir. transparent, opaque veya auto'den biri olmalıdır (varsayılan değer). Kullanıldığında auto , model görüntü için en iyi arka planı otomatik olarak belirler. isetransparent, çıkış biçiminin saydamlığı desteklemesi gerektiğinden (varsayılan değer) veya pngolarak webp ayarlanmalıdır. Olası değerler: transparent, opaque, auto	Hayı
image	dize veya dizi		Evet
mask	String		Hayı
model	String	Görüntü düzenleme işlemi için kullanılacak modelin dağıtımı.	Evet
n	tamsayı	Oluşturulacak görüntü sayısı. 1 ile 10 arasında olmalıdır.	Hayı	1
çıktı sıkıştırma	tamsayı	Oluşturulan görüntüler için sıkıştırma düzeyi (0-100%). Bu parametre yalnızca gpt-image-1 serisi modeller için webp veya jpeg çıkış biçimlerine sahip olduğunda desteklenir ve varsayılan olarak 100'dür.	Hayı	100
çıkış formatı	enum	Oluşturulan görüntülerin döndürüldiği biçim. Bu parametre yalnızca gpt-image-1-serisi modeller için desteklenir. png, jpeg veya webp'den biri olmalıdır. Varsayılan değer png değeridir. Olası değerler: png, jpeg, webp	Hayı
prompt	String	İstenen resimlerin metin açıklaması. Maksimum uzunluk dall-e-2 için 1000 karakter ve gpt-image-1 serisi modeller için 32000 karakterdir.	Evet
nitelik	enum	Oluşturulacak görüntünün kalitesi. high, medium ve low yalnızca gpt-image-1 serisi modellerde desteklenir. dall-e-2 yalnızca kaliteyi destekler standard . Varsayılan olarak auto değerini alır. Olası değerler: standard, low, medium, high, auto	Hayı
yanıt formatı	enum	Oluşturulan görüntülerin döndürüldiği biçim. url veya b64_jsonbiri olmalıdır. URL'ler, görüntü oluşturulduktan sonra yalnızca 60 dakika boyunca geçerlidir. Bu parametre yalnızca dall-e-2 için desteklenir, çünkü gpt-image-1-serisi modeller her zaman base64 ile kodlanmış görüntüler döndürecektir. Olası değerler: url, b64_json	Hayı
boyut	enum	Oluşturulan görüntülerin boyutu. 1024x1024-serisi modeller için, 1536x1024, 1024x1536 (yatay), auto (dikey) veya gpt-image-1 (varsayılan değer) değerlerinden biri olmalıdır ve 256x256 için 512x512, 1024x1024 veya dall-e-2 değerlerinden biri olmalıdır. Olası değerler: 256x256, 512x512, 1024x1024, 1536x1024, , 1024x1536, auto	Hayı
user	String	OpenAI'nin kötüye kullanımı izlemesine ve algılamasına yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı.	Hayı

AzureCreateImageRequest

İsim	Türü	Description	Gerekli	Varsayılan
arka plan	enum	Oluşturulan görüntülerin arka planı için saydamlık ayarlamaya olanak tanır. Bu parametre yalnızca gpt-image-1-serisi modeller için desteklenir. transparent, opaque veya auto'den biri olmalıdır (varsayılan değer). Kullanıldığında auto , model görüntü için en iyi arka planı otomatik olarak belirler. isetransparent, çıkış biçiminin saydamlığı desteklemesi gerektiğinden (varsayılan değer) veya pngolarak webp ayarlanmalıdır. Olası değerler: transparent, opaque, auto	Hayı
model	String	Görüntü oluşturma için kullanılacak dağıtım modeli.	Evet
moderation	enum	-series modelleri tarafından gpt-image-1oluşturulan görüntüler için içerik denetim düzeyini denetleyin. Ya low daha az kısıtlayıcı filtreleme için ya da auto (varsayılan değer) olmalıdır. Olası değerler: low, auto	Hayı
n	tamsayı	Oluşturulacak görüntü sayısı. 1 ile 10 arasında olmalıdır. için dall-e-3yalnızca n=1 desteklenir.	Hayı	1
çıktı sıkıştırma	tamsayı	Oluşturulan görüntüler için sıkıştırma düzeyi (0-100%). Bu parametre yalnızca gpt-image-1 serisi modeller için webp veya jpeg çıkış biçimlerine sahip olduğunda desteklenir ve varsayılan olarak 100'dür.	Hayı	100
çıkış formatı	enum	Oluşturulan görüntülerin döndürüldiği biçim. Bu parametre yalnızca gpt-image-1-serisi modeller için desteklenir. png, jpeg veya webp'den biri olmalıdır. Olası değerler: png, jpeg, webp	Hayı
prompt	String	İstenen resimlerin metin açıklaması. En fazla uzunluk, -serisi modelleri için gpt-image-132000 karakter, için dall-e-2 1000 karakter ve için dall-e-34000 karakterdir.	Evet
nitelik	enum	Oluşturulacak görüntünün kalitesi. - auto (varsayılan değer), verilen model için en iyi kaliteyi otomatik olarak seçer. - high, medium ve lowgpt-image-1-series modellerinde desteklenir. - hd ve standard için dall-e-3desteklenir. - standard için tek seçenektir dall-e-2. Olası değerler: standard, hd, low, medium, , high, auto	Hayı
yanıt formatı	enum	dall-e-2 ve dall-e-3 ile oluşturulan görüntülerin geri döndürüldüğü format. url veya b64_jsonbiri olmalıdır. URL'ler, görüntü oluşturulduktan sonra yalnızca 60 dakika boyunca geçerlidir. Bu parametre, her zaman base64 ile kodlanmış görüntüler döndürecek olan -series modellerinde desteklenmez gpt-image-1. Olası değerler: url, b64_json	Hayı
boyut	enum	Oluşturulan görüntülerin boyutu. 1024x1024-serisi modelleri için 1536x1024, 1024x1536 (yatay), auto (dikey) veya gpt-image-1 (varsayılan değer) olmalıdır; 256x256 için 512x512, 1024x1024 veya dall-e-2; ve 1024x1024 için 1792x1024, 1024x1792 veya dall-e-3 olmalıdır. Olası değerler: auto, 1024x1024, 1536x1024, 1024x1536, 256x256, 512x512, 1792x1024, 1024x1792	Hayı
style	enum	Oluşturulan görüntülerin stili. Bu parametre yalnızca için dall-e-3desteklenir. vivid veya naturalbiri olmalıdır. Canlı, modelin hiper-gerçek ve dramatik görüntüler üretmeye yönelmesine neden olur. Doğal, modelin daha doğal, daha az hiper gerçek görünümlü görüntüler üretmesine neden olur. Olası değerler: vivid, natural	Hayı
user	String	OpenAI'nin kötüye kullanımı izlemesine ve algılamasına yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı.	Hayı

AzureCreateResponse

İsim	Türü	Description	Gerekli	Varsayılan
arka plan	Boolean	Model yanıtının arka planda çalıştırılıp çalıştırılmayacağı.	Hayı	Yanlış
include	dizi	Model yanıtına eklenecek ek çıktı verilerini belirtin. Şu anda desteklenen değerler şunlardır: - code_interpreter_call.outputs: Kod yorumlayıcı aracı çağrı öğelerinde python kod yürütme çıktılarını içerir. - computer_call_output.output.image_url: Bilgisayar çağrısı çıkışından görüntü URL'lerini ekleyin. - file_search_call.results: Dosya arama aracı çağrısının arama sonuçlarını ekleyin. - message.input_image.image_url: Giriş iletisinden görüntü URL'lerini ekleyin. - message.output_text.logprobs: Yardımcı iletilerine logprobs ekleyin. - reasoning.encrypted_content: Akıl yürütme öğesi çıkışlarında akıl yürütme belirteçlerinin şifrelenmiş bir sürümünü içerir. Bu, Yanıtlar API'sini durum bilgisi olmadan kullanırken (örneğin, store parametresi false olarak ayarlandığında veya bir kuruluş sıfır veri saklama programına kaydedildiğinde) akıl yürütme öğelerinin çok aşamalı konuşmalarda kullanılmasını sağlar.	Hayı
girdi	dize veya dizi		Hayı
instructions	String	Modelin bağlamı içine eklenen bir sistem (veya geliştirici) iletisi. ile previous_response_idbirlikte kullanıldığında, önceki yanıttan alınan yönergeler sonraki yanıta taşınmaz. Bu, sistem (veya geliştirici) iletilerini yeni yanıtlarda değiştirme işlemini basitleştirir.	Hayı
max_output_tokens	tamsayı	Görünür çıkış belirteçleri ve muhakeme belirteçleri de dahil olmak üzere yanıt için oluşturulabilecek belirteç sayısı için üst sınır	Hayı
max_tool_calls	tamsayı	Bir yanıtta işlenebilen yerleşik araçlara yapılan toplam çağrı sayısı üst sınırı. Bu maksimum sayı, tek tek araç başına değil, tüm yerleşik araç çağrıları için geçerlidir. Model tarafından bir aracı çağırmaya yönelik diğer girişimler yoksayılır.	Hayı
metadata	nesne	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, 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.	Hayı
model	String	Bu yanıtın oluşturulması için kullanılacak model dağıtımı.	Evet
paralel araç çağrıları	Boolean	Modelin araç çağrılarını paralel olarak çalıştırmasına izin verilip verilmeyeceği.	Hayı	Doğru
previous_response_id	String	Modele önceki yanıtın benzersiz kimliği. Çok aşamalı konuşmalar oluşturmak için bunu kullanın.	Hayı
prompt	nesne	bir istem şablonuna ve değişkenlerine başvuru.	Hayı
└─ kimlik	String	Kullanılacak istem şablonunun benzersiz tanımlayıcısı.	Hayı
└─ değişkenler	OpenAI.ResponsePromptVariables	İsteminizde değişkenlerin yerine kullanılacak isteğe bağlı değer eşlemesi. Değiştirme değerleri dizeler veya görüntüler veya dosyalar gibi diğer Yanıt giriş türleri olabilir.	Hayı
└─ sürümü	String	İstem şablonunun isteğe bağlı sürümü.	Hayı
reasoning	nesne	yalnızca o serisi modeller Mantık modelleri için yapılandırma seçenekleri.	Hayı
└─ çaba	OpenAI.ReasoningEffort	yalnızca o serisi modeller Mantıp modelleri için mantık yürütme çabasını kısıtlar. Şu anda desteklenen değerler , lowve medium'tirhigh. Muhakeme çabasının azaltılması, yanıtta daha hızlı yanıtlar ve daha az belirteç kullanılmasına neden olabilir.	Hayı
└─ özet oluştur	enum	Kullanım dışı: bunun yerine kullanın summary . Model tarafından gerçekleştirilen mantığın özeti. Bu, hata ayıklama ve modelin akıl yürütme işlemini anlamak için yararlı olabilir. auto, conciseveya detailed. Olası değerler: auto, concise, detailed	Hayı
└─ özeti	enum	Model tarafından gerçekleştirilen mantığın özeti. Bu, hata ayıklama ve modelin akıl yürütme işlemini anlamak için yararlı olabilir. auto, conciseveya detailed. Olası değerler: auto, concise, detailed	Hayı
store	Boolean	Oluşturulan model yanıtının daha sonra API ile alınabilmesi için depolanıp depolanmayacağı.	Hayı	Doğru
veri akışı	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.	Hayı	Yanlış
sıcaklık	Numara	0 ile 2 arasında hangi örnekleme sıcaklığının kullanılacağı. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir. Genellikle bunu değiştirmenizi öneririz top_p ancak ikisini birden değiştirmemenizi öneririz.	Hayı	1
text	nesne	Modelden metin yanıtı için yapılandırma seçenekleri. Düz metin veya yapılandırılmış JSON verileri olabilir.	Hayı
└─ biçimi	OpenAI.ResponseTextFormatConfiguration		Hayı
tool_choice	nesne	Model tarafından çağrılan aracı (varsa) denetler. none modelin herhangi bir aracı çağırmayacağı ve bunun yerine bir ileti oluşturduğu anlamına gelir. auto modelin 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.	Hayı
└─ türü	OpenAI.ToolChoiceObjectType	Modelin bir yanıt oluşturmak için yerleşik bir araç kullanması gerektiğini gösterir.	Hayı
araçlar	dizi	Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Parametresini ayarlayarak tool_choice hangi aracın kullanılacağını belirtebilirsiniz. Modeli sağlayabileceğiniz iki araç kategorisi şunlardır: - Yerleşik araçlar: OpenAI tarafından sağlanan ve dosya arama gibi modelin özelliklerini genişleten araçlar. - İşlev çağrıları (özel araçlar): Sizin tanımladığınız ve modelin kendi kodunuzu çağırmasını sağlayan işlevler.	Hayı
top_logprobs	tamsayı	Her biri ilişkili günlük olasılığına sahip her belirteç konumunda döndürülecek en olası belirteç sayısını belirten 0 ile 20 arasında bir tamsayı.	Hayı
top_p	Numara	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ı	1
truncation	enum	Model yanıtı için kullanılacak kesme stratejisi. - auto: Bu yanıtın bağlamı ve öncekiler modelin bağlam penceresi boyutunu aşarsa, model konuşmanın ortasına giriş öğelerini bırakarak yanıtı bağlam penceresine uyacak şekilde kesecektir. - disabled (varsayılan): Model yanıtı bir modelin bağlam penceresi boyutunu aşarsa istek 400 hatasıyla başarısız olur. Olası değerler: auto, disabled	Hayı
user	String	OpenAI'nin kötüye kullanımı izlemesine ve algılamasına yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı.	Hayı

AzureCreateSpeechRequestMultiPart

Metin okuma işleminin davranışını denetleen istek seçeneklerinin gösterimi.

İsim	Türü	Description	Gerekli	Varsayılan
girdi	String	Ses oluşturulacak metin. Uzunluk üst sınırı 4096 karakterdir.	Evet
instructions	String	Ek yönergelerle oluşturulan sesinizin sesini kontrol edin. tts-1 veya tts-1-hd ile çalışmaz.	Hayı
model	String	Bu metin okuma isteği için kullanılacak model.	Evet
yanıt formatı	nesne	Metin okuma için desteklenen ses çıkış biçimleri.	Hayı
speed	Numara	Oluşturulan ses için konuşma hızı. Değerler 0,25 ile 4,0 aralığında geçerlidir; varsayılan değer 1,0 ve daha hızlı konuşmaya karşılık gelen daha yüksek değerlerdir.	Hayı	1
stream_format	enum	Ses akışı için biçim. Desteklenen biçimler sse ve audio'dir. sseveya tts-1için tts-1-hd desteklenmez. Olası değerler: sse, audio	Hayı
voice	nesne		Evet

AzureCreateTranscriptionRequestMultiPart

Ses transkripsiyonu isteğinin yapılandırma bilgileri.

İsim	Türü	Description	Gerekli	Varsayılan
chunking_strategy	nesne		Hayı
└─ ön_ek_yastıklama_ms	tamsayı	VAD konuşma algılamadan önce eklenecek ses miktarı (milisaniye cinsinden).	Hayı	300
└─ sessizlik_süresi_ms	tamsayı	Konuşma durdurmayı algılamak için sessizlik süresi (milisaniye cinsinden). Daha kısa değerlerle model daha hızlı yanıt verir, ancak kullanıcı kısa durakladığında araya girebilir.	Hayı	200
└─ eşik	Numara	Ses etkinliği algılama için duyarlılık eşiği (0,0 - 1,0). Daha yüksek bir eşik, modeli etkinleştirmek için daha yüksek ses gerektirir ve bu nedenle gürültülü ortamlarda daha iyi performans gösterebilir.	Hayı	0,5
└─ türü	enum	Manuel parçalamayı sunucu tarafı VAD kullanarak etkinleştirmek için server_vad olarak ayarlanmalıdır. Olası değerler: server_vad	Hayı
dosya	String		Evet
filename	String	Ses verileriyle ilişkilendirilecek isteğe bağlı dosya adı veya açıklayıcı tanımlayıcı.	Hayı
include[]	dizi	Transkripsiyon yanıtına eklenecek ek bilgiler. logprobs , modelin transkripsiyona olan güvenini anlamak için yanıttaki belirteçlerin günlük olasılıklarını döndürür. logprobs yalnızca json olarak ayarlandığında ve yalnızca gpt-4o-transcribe, gpt-4o-transcribe-diarize, gpt-4o-mini-transcribe ve gpt-4o-mini-transcribe-2025-12-15 modelleriyle çalışır.	Hayı
language	String	Giriş sesinin dili. Giriş dilini ISO-639-1 (ör. en) biçiminde sağlamak doğruluğu ve gecikme süresini artırır.	Hayı
model	String	Bu transkripsiyon isteği için kullanılacak model.	Hayı
prompt	String	Modelin stiline kılavuzluk etmek veya önceki bir ses kesimine devam etmek için isteğe bağlı bir metin. İstem, ses diliyle eşleşmelidir.	Hayı
yanıt formatı	nesne		Hayı
veri akışı	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. Not: whisper-1 modeli için streaming desteklenmez ve yoksayılır.	Hayı	Yanlış
sıcaklık	Numara	Örnekleme sıcaklığı, 0 ile 1 arasında. 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. 0 olarak ayarlanırsa model, belirli eşiklere isabet edene kadar sıcaklığı otomatik olarak artırmak için günlük olasılığını kullanır.	Hayı	0
timestamp_granularities[]	dizi	Bu transkripsiyon için doldurulacak zaman damgası tanecikleri. response_format zaman damgası taneciklerini kullanacak şekilde ayarlanmalıdır verbose_json . Bu seçeneklerden biri veya her ikisi de desteklenir: word, veya segment. Not: Segment zaman damgaları için ek gecikme süresi yoktur, ancak sözcük zaman damgaları oluşturmak ek gecikmeye neden olur.	Hayı	['segment']

AzureCreateTranslationRequestMultiPart

Ses transkripsiyonu isteğinin yapılandırma bilgileri.

İsim	Türü	Description	Gerekli	Varsayılan
dosya	String		Evet
filename	String	Ses verileriyle ilişkilendirilecek isteğe bağlı dosya adı veya açıklayıcı tanımlayıcı	Hayı
model	String	Bu çeviri isteği için kullanılacak model.	Hayı
prompt	String	Modelin stiline kılavuzluk etmek veya önceki bir ses kesimine devam etmek için isteğe bağlı bir metin. İstem İngilizce olmalıdır.	Hayı
yanıt formatı	nesne		Hayı
sıcaklık	Numara	Örnekleme sıcaklığı, 0 ile 1 arasında. 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. 0 olarak ayarlanırsa model, belirli eşiklere isabet edene kadar sıcaklığı otomatik olarak artırmak için günlük olasılığını kullanır.	Hayı	0

Azure Hata Yanıtı

İsim	Türü	Description	Gerekli	Varsayılan
hata	nesne	Hata ayrıntıları.	Hayı
└─ kod	String	Hata için makine tarafından oluşturulan benzersiz tanımlayıcı.	Hayı
└─ iç_hata			Hayı
└─ ileti	String	Hata ile ilişkili insan tarafından okunabilir bir mesaj.	Hayı
└─ parametre	String	Varsa, hatayla ilişkili istek giriş parametresi	Hayı
└─ türü	enum	Nesne türü, her zaman 'hata'. Olası değerler: error	Hayı

AzureEvalAPICompletionsSamplingParams

İsim	Türü	Description	Gerekli	Varsayılan
paralel araç çağrıları	Boolean		Hayı
yanıt formatı	OpenAI.ResponseTextFormatConfiguration		Hayı
araçlar	dizi		Hayı

AzureEvalAPIModelSamplingParams

İ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ı	enum	Oluşturma sırasında uygulanan akıl yürütme çabasının düzeyini denetler. Olası değerler: low, medium, high	Hayı
seed	tamsayı	Örnekleme sırasında rastgeleliği başlatmak için bir tohum değeri.	Hayı
sıcaklık	Numara	Daha yüksek bir sıcaklık çıkışlardaki rastgeleliği artırır.	Hayı
top_p	Numara	Çekirdek örneklemesi için sıcaklığa bir alternatif; 1.0 tüm belirteçleri içerir.	Hayı

AzureEvalAPIResponseSamplingParams

İsim	Türü	Description	Gerekli	Varsayılan
paralel araç çağrıları	Boolean		Hayı
yanıt formatı	OpenAI.ResponseTextFormatConfiguration		Hayı
araçlar	dizi		Hayı

AzureFileExpiryAnchor

Mülkiyet	Değer
Türü	String
Değerler	created_at

AzureFineTuneReinforcementMethod

İsim	Türü	Description	Gerekli	Varsayılan
Greyder	nesne	Belirtilen işlemi kullanarak giriş ve başvuru arasında dize karşılaştırması gerçekleştiren bir StringCheckGrader nesnesi.	Evet
└─ çıktıyı_hesapla	String	Not veren sonuçlarına göre çıkışı hesaplamak için bir formül.	Hayı
└─ değerlendirme_metriği	enum	Kullanılacak değerlendirme ölçümü. fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5 veya rouge_l. Olası değerler: fuzzy_match, bleu, gleu, , meteor, rouge_1, , rouge_2, rouge_3rouge_4, rouge_5,rouge_l	Hayı
└─ greyderler	nesne		Hayı
└─ giriş	dizi	Giriş metni. Bu, şablon dizelerini içerebilir.	Hayı
└─ modeli	String	Değerlendirme için kullanılacak model.	Hayı
└─ ad	String	Değerlendiricinin adı.	Hayı
└─ işlem	enum	Gerçekleştirilecek dize denetimi işlemi. eq, ne, like veya ilike. Olası değerler: eq, ne, like, ilike	Hayı
└─ aralığı	dizi	Puan aralığı. Varsayılan olarak [0, 1] değerini alır.	Hayı
└─ başvuru	String	Değerlendirmenin yapıldığı metin.	Hayı
└─ örnekleme_parametreleri		Modelin örnekleme parametreleri.	Hayı
└─ türü	enum	Her zaman multiolan nesne türü. Olası değerler: multi	Hayı
hiper parametreler	OpenAI.FineTuneReinforcementHyperparameters	Pekiştirici ince ayarlama işi için kullanılan hiper parametreler.	Hayı
yanıt formatı	nesne		Hayı
└─ json_schema	nesne	Yanıt biçimi için JSON Şeması	Hayı
└─ türü	enum	Yanıt biçimi türü. Olası değerler: json_schema	Hayı

AzureImage

İsim	Türü	Description	Gerekli	Varsayılan
b64_json	String	Oluşturulan görüntünün base64 kodlanmış JSON değeri. gpt-image-1-serisi modeller için varsayılan değerdir ve yalnızca response_format, b64_json ve dall-e-2 için dall-e-3 olarak ayarlanmışsa mevcuttur.	Hayı
content_filter_results	AzureContentFilterImageResponseResults	Görüntü oluşturma işleminin çıkış yanıtı içeriği için içerik filtresi sonucu.	Evet
prompt_filter_results	AzureContentFilterImagePromptResults	Görüntü oluşturma işleminin giriş isteği içeriği için içerik filtresi sonucu.	Evet
düzeltilmiş_yazı	String	Yalnızca dall-e-3 , görüntüyü oluşturmak için kullanılan düzeltilmiş istem.	Hayı
url	String	veya dall-e-2kullanırkendall-e-3, (varsayılan değer) olarak ayarlanırsa response_formaturl , oluşturulan görüntünün URL'si. gpt-image-1-serisi modelleri için desteklenmez.	Hayı

AzureImagesResponse

İsim	Türü	Description	Gerekli	Varsayılan
arka plan	enum	Görüntü oluşturma için kullanılan arka plan parametresi. transparent veya opaque. Olası değerler: transparent, opaque	Hayı
created	tamsayı	Görüntünün oluşturulduğu unix zaman damgası (saniye olarak).	Evet
veriler	dizi		Hayı
çıkış formatı	enum	Görüntü oluşturmanın çıkış biçimi. , pngwebpveya jpeg. Olası değerler: png, webp, jpeg	Hayı
nitelik	enum	Oluşturulan görüntünün kalitesi. , lowmediumveya high. Olası değerler: low, medium, high	Hayı
boyut	enum	Oluşturulan görüntünün boyutu. , 1024x10241024x1536veya 1536x1024. Olası değerler: 1024x1024, 1024x1536, 1536x1024	Hayı
usage	nesne	Yalnızca gpt-image-1-series modelleri için, görüntü oluşturma için belirteç kullanım bilgileri.	Hayı
└─ girdi_simgeleri	tamsayı	Giriş istemindeki belirteçlerin (görüntüler ve metin) sayısı.	Hayı
└─ giriş_jeton_detayları	nesne	Giriş belirteçleri, görüntü oluşturma için ayrıntılı bilgiler sağlar.	Hayı
└─ resim_jetonları	tamsayı	Giriş istemindeki görüntü belirteçlerinin sayısı.	Hayı
└─ metin_tokenleri	tamsayı	Giriş istemindeki metin belirteçlerinin sayısı.	Hayı
└─ çıkış_birimleri	tamsayı	Çıkış görüntüsündeki görüntü belirteçlerinin sayısı.	Hayı
└─ toplam_jetonlar	tamsayı	Görüntü oluşturma için kullanılan toplam belirteç sayısı (görüntüler ve metin).	Hayı

AzureListFilesResponse

İsim	Türü	Description	Gerekli	Varsayılan
veriler	dizi		Evet
ilk_kimlik	String		Evet
daha_fazla	Boolean		Evet
son_kimlik	String		Evet
nesne	enum	Olası değerler: list	Evet

AzureOpenAIFile

İsim	Türü	Description	Gerekli	Varsayılan
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 fileolan nesne türü. Olası değerler: file	Evet
purpose	enum	Dosyanın amaçlanan amacı. Desteklenen değerler , , assistantsassistants_output, batchbatch_output ve fine-tunedeğerleridirfine-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ı	String	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 erroralanına bakınfine_tuning.job.	Hayı

AzureOpenAIVideoGenerationErrorResponse

İsim	Türü	Description	Gerekli	Varsayılan
kod	String	Hata için makine tarafından oluşturulan benzersiz tanımlayıcı.	Hayı
inner_error	nesne	Varsa, bu hatayı oluşturan bir yukarı akış hatası.	Hayı
└─ kod	enum	İç hatayla ilişkili kod. Olası değerler: ResponsibleAIPolicyViolation	Hayı
└─ hata_detayları		İç hatayla ilişkili içerik filtresi sonuç ayrıntıları.	Hayı
gözden geçirilmiş_istem	String	Eğer uygunsa, üretim için kullanılan değiştirilmiş istem.	Hayı
mesaj	String	Hata ile ilişkili insan tarafından okunabilir bir mesaj.	Hayı
param	String	Varsa, hatayla ilişkili istek giriş parametresi	Hayı
type	String	Varsa, hatayla ilişkili giriş satırı numarası.	Hayı

AzureResponse

İsim	Türü	Description	Gerekli	Varsayılan
arka plan	Boolean	Model yanıtının arka planda çalıştırılıp çalıştırılmayacağı.	Hayı	Yanlış
oluşturulma_tarihi	tamsayı	Bu Yanıtın oluşturulduğu unix zaman damgası (saniye).	Evet
hata	nesne	Model yanıt oluşturamadığında döndürülen bir hata nesnesi.	Evet
└─ kod	OpenAI.ResponseErrorCode	Yanıtın hata kodu.	Hayı
└─ ileti	String	Hatanın insan tarafından okunabilen açıklaması.	Hayı
kimlik	String	Bu Yanıt için benzersiz tanımlayıcı.	Evet
incomplete_details	nesne	Yanıtın neden eksik olduğuna ilişkin ayrıntılar.	Evet
└─ neden	enum	Yanıtın tamamlanmamış olmasının nedeni. Olası değerler: max_output_tokens, content_filter	Hayı
instructions	dize veya dizi		Evet
max_output_tokens	tamsayı	Görünür çıkış belirteçleri ve muhakeme belirteçleri de dahil olmak üzere yanıt için oluşturulabilecek belirteç sayısı için üst sınır	Hayı
max_tool_calls	tamsayı	Bir yanıtta işlenebilen yerleşik araçlara yapılan toplam çağrı sayısı üst sınırı. Bu maksimum sayı, tek tek araç başına değil, tüm yerleşik araç çağrıları için geçerlidir. Model tarafından bir aracı çağırmaya yönelik diğer girişimler yoksayılır.	Hayı
metadata	nesne	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, 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
model	String	Bu yanıtı oluşturmak için kullanılan model.	Evet
nesne	enum	Bu kaynağın nesne türü - her zaman response olarak ayarlanır. Olası değerler: response	Evet
çıktı	dizi	Model tarafından oluşturulan içerik öğeleri dizisi. - Dizideki output öğelerin uzunluğu ve sırası modelin yanıtına bağlıdır. - Dizideki output ilk öğeye erişmek ve bunun model tarafından oluşturulan içeriğe sahip bir assistant ileti olduğunu varsaymak yerine SDK'larda desteklenen özelliğini kullanmayı output_text düşünebilirsiniz.	Evet
output_text	String	SDK özellikli yalnızca kolaylık sağlayan bir özellik olan, varsa dizideki tüm output_text öğelerinin metin çıktılarını bir araya getiren output içeren özellik. Python ve JavaScript SDK'larında desteklenir.	Hayı
paralel araç çağrıları	Boolean	Modelin araç çağrılarını paralel olarak çalıştırmasına izin verilip verilmeyeceği.	Evet	Doğru
previous_response_id	String	Modele önceki yanıtın benzersiz kimliği. Çok aşamalı konuşmalar oluşturmak için bunu kullanın.	Hayı
prompt	nesne	bir istem şablonuna ve değişkenlerine başvuru.	Hayı
└─ kimlik	String	Kullanılacak istem şablonunun benzersiz tanımlayıcısı.	Hayı
└─ değişkenler	OpenAI.ResponsePromptVariables	İsteminizde değişkenlerin yerine kullanılacak isteğe bağlı değer eşlemesi. Değiştirme değerleri dizeler veya görüntüler veya dosyalar gibi diğer Yanıt giriş türleri olabilir.	Hayı
└─ sürümü	String	İstem şablonunun isteğe bağlı sürümü.	Hayı
reasoning	nesne	yalnızca o serisi modeller Mantık modelleri için yapılandırma seçenekleri.	Hayı
└─ çaba	OpenAI.ReasoningEffort	yalnızca o serisi modeller Mantıp modelleri için mantık yürütme çabasını kısıtlar. Şu anda desteklenen değerler , lowve medium'tirhigh. Muhakeme çabasının azaltılması, yanıtta daha hızlı yanıtlar ve daha az belirteç kullanılmasına neden olabilir.	Hayı
└─ özet oluştur	enum	Kullanım dışı: bunun yerine kullanın summary . Model tarafından gerçekleştirilen mantığın özeti. Bu, hata ayıklama ve modelin akıl yürütme işlemini anlamak için yararlı olabilir. auto, conciseveya detailed. Olası değerler: auto, concise, detailed	Hayı
└─ özeti	enum	Model tarafından gerçekleştirilen mantığın özeti. Bu, hata ayıklama ve modelin akıl yürütme işlemini anlamak için yararlı olabilir. auto, conciseveya detailed. Olası değerler: auto, concise, detailed	Hayı
durum	enum	Yanıt oluşturma durumu. completed, failed, in_progress, cancelled, queued veya incomplete. Olası değerler: completed, failed, in_progress, cancelled, , queued, incomplete	Hayı
sıcaklık	Numara	0 ile 2 arasında hangi örnekleme sıcaklığının kullanılacağı. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir. Genellikle bunu değiştirmenizi öneririz top_p ancak ikisini birden değiştirmemenizi öneririz.	Evet
text	nesne	Modelden metin yanıtı için yapılandırma seçenekleri. Düz metin veya yapılandırılmış JSON verileri olabilir.	Hayı
└─ biçimi	OpenAI.ResponseTextFormatConfiguration		Hayı
tool_choice	nesne	Model tarafından çağrılan aracı (varsa) denetler. none modelin herhangi bir aracı çağırmayacağı ve bunun yerine bir ileti oluşturduğu anlamına gelir. auto modelin 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.	Hayı
└─ türü	OpenAI.ToolChoiceObjectType	Modelin bir yanıt oluşturmak için yerleşik bir araç kullanması gerektiğini gösterir.	Hayı
araçlar	dizi	Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Parametresini ayarlayarak tool_choice hangi aracın kullanılacağını belirtebilirsiniz. Modeli sağlayabileceğiniz iki araç kategorisi şunlardır: - Yerleşik araçlar: OpenAI tarafından sağlanan ve modelin özelliklerini genişleten araçlar.	Hayı
top_logprobs	tamsayı	Her biri ilişkili günlük olasılığına sahip her belirteç konumunda döndürülecek en olası belirteç sayısını belirten 0 ile 20 arasında bir tamsayı.	Hayı
top_p	Numara	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.	Evet
truncation	enum	Model yanıtı için kullanılacak kesme stratejisi. - auto: Bu yanıtın bağlamı ve öncekiler modelin bağlam penceresi boyutunu aşarsa, model konuşmanın ortasına giriş öğelerini bırakarak yanıtı bağlam penceresine uyacak şekilde kesecektir. - disabled (varsayılan): Model yanıtı bir modelin bağlam penceresi boyutunu aşarsa istek 400 hatasıyla başarısız olur. Olası değerler: auto, disabled	Hayı
usage	OpenAI.ResponseUsage	Giriş belirteçleri, çıkış belirteçleri, çıkış belirteçlerinin dökümü ve kullanılan toplam belirteçler dahil olmak üzere belirteç kullanım ayrıntılarını temsil eder.	Hayı
user	String	OpenAI'nin kötüye kullanımı izlemesine ve algılamasına yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı.	Evet

AzureSearchChatDataSource

Azure Search kaynağı kullanacak bir veri kaynağı yapılandırmasını temsil eder.

İsim	Türü	Description	Gerekli	Varsayılan
parameters	nesne	Azure Search veri kaynağının kullanımını denetlemek için parametre bilgileri.	Evet
└─ kısmi_sonuç_izin_ver	Boolean	True olarak ayarlanırsa, sistem kısmi arama sonuçlarının kullanılmasına izin verir ve tüm kısmi sorgular başarısız olursa istek başarısız olur. Belirtilmezse veya false olarak belirtilmezse, herhangi bir arama sorgusu başarısız olursa istek başarısız olur.	Hayı	Yanlış
└─ kimlik doğrulaması	nesne		Hayı
└─ erişim belirteci	String		Hayı
└─ anahtar	String		Hayı
└─ yönetilen_kimlik_kaynak_kimliği	String		Hayı
└─ türü	enum	Olası değerler: access_token	Hayı
└─ gömme_bağımlılığı	nesne	Azure OpenAI gömme modeli dağıtımına karşı genel hizmet çağrıları yapan vektörleştirme kaynağını temsil eder.	Hayı
└─ kimlik doğrulaması	AzureChatDataSourceApiKeyAuthenticationOptions veya AzureChatDataSourceAccessTokenAuthenticationOptions	Uç nokta tabanlı vektörleştirme kaynağıyla kullanılacak kimlik doğrulama mekanizması. Uç nokta kimlik doğrulaması API anahtarı ve erişim belirteci mekanizmalarını destekler.	Hayı
└─ dağıtım_adı	String	Vektörleştirme için kullanılacak gömme modeli dağıtımı. Bu dağıtım, sohbet tamamlamaları için kullanılan model dağıtımıyla aynı Azure OpenAI kaynağı içinde bulunmalıdır.	Hayı
└─ boyutları	tamsayı	Eklemeler için istenecek boyut sayısı. Yalnızca 'text-embedding-3' ve sonraki modellerde desteklenir.	Hayı
└─ uç nokta	String	Eklemelerin alınması gereken kaynak uç noktası URL'sini belirtir. Şu biçimde olmalıdır: https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings. Api sürümü sorgu parametresine izin verilmiyor.	Hayı
└─ türü	enum	Bu vektörleştirme kaynak türü için tür tanımlayıcı, her zaman 'entegre' olur. Olası değerler: integrated	Hayı
└─ uç nokta	String	Kullanılacak Azure Search kaynağının mutlak uç nokta yolu.	Hayı
└─ alanlar_haritalama	nesne	Azure Search kaynağıyla kullanılacak alan eşlemeleri.	Hayı
└─ içerik_alanları	dizi	İçerik olarak ele alınması gereken dizin alanlarının adları.	Hayı
└─ içerik_alanları_ayırıcı	String	İçerik alanlarının kullanması gereken ayırıcı desen.	Hayı
└─ dosyayolu_alani	String	Dosya yolu olarak kullanılacak dizin alanının adı.	Hayı
└─ görüntü_vektör_alanları	dizi	Görüntü vektör verilerini temsil eden alanların adları.	Hayı
└─ başlık_alanı	String	Başlık olarak kullanılacak dizin alanının adı.	Hayı
└─ url_alanı	String	URL olarak kullanılacak dizin alanının adı.	Hayı
└─ vektör_alanları	dizi	Vektör verilerini temsil eden alanların adları.	Hayı
└─ filtre	String	Aramaya uygulanacak filtre.	Hayı
└─ in_scope	Boolean	Sorguların dizine alınan verilerin kullanımıyla sınırlandırılıp kısıtlanmaması gerektiği.	Hayı
└─ kapsamları_dahil_et	dizi	Yanıta dahil edilecek çıktı bağlamı özellikleri. Varsayılan olarak, alıntılar ve amaç istenir.	Hayı	['alıntılar', 'amaç']
└─ indeks_adı	String	Azure Search kaynağında belirtildiği gibi kullanılacak dizinin adı.	Hayı
└─ max_search_queries (maksimum arama sorguları)	tamsayı	Tek bir kullanıcı iletisi için arama sağlayıcısına gönderilmesi gereken en fazla yeniden yazılan sorgu sayısı. Varsayılan olarak, sistem otomatik bir belirleme yapar.	Hayı
└─ sorgu_türü	enum	Kullanılacak Azure Search kaynağının sorgu türü. Olası değerler: simple, semantic, vector, vector_simple_hybrid, vector_semantic_hybrid	Hayı
└─ anlamsal_konfigürasyon	String	Sorgu için ek anlamsal yapılandırma.	Hayı
└─ katılık	tamsayı	Arama ilgi filtresinin yapılandırılmış katılığı. Daha yüksek katılık, yanıtın doğruluğunu artırır ancak geri çağırma oranını düşürür.	Hayı
└─ top_n_documents	tamsayı	Sorguda öne çıkması için yapılandırılan belge sayısı.	Hayı
type	enum	Her zaman 'azure_search' olarak geçen ayrımcı tür tanımlayıcısı. Olası değerler: azure_search	Evet

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. Bulut için Microsoft Defender kullanarak yapay zeka uygulamalarını koruma hakkında daha fazla bilgi edinin.

İsim	Türü	Description	Gerekli	Varsayılan
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ı nesnesi 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ı

ChatCompletionMessageToolCallsItem

Araç, işlev çağrıları gibi model tarafından oluşturulan çağrılar.

Dizisi: OpenAI.ChatCompletionMessageToolCall

CreateVideoGenerationRequest

İsim	Türü	Description	Gerekli	Varsayılan
height	tamsayı	Videonun yüksekliği. Aşağıdaki boyutlar desteklenir: 480x480, 854x480, 720x720, 1280x720, 1080x1080 ve 1920x1080 hem yatay hem de dikey yönlerde.	Evet
model	String	Bu istek için kullanılacak dağıtımın adı.	Evet
n_seconds	tamsayı	Video oluşturma işinin süresi. 1 ile 20 saniye arasında olmalıdır.	Hayı	5
n_variants	tamsayı	Bu iş için değişken olarak oluşturulacak video sayısı. 1 ile 5 arasında olmalıdır. Daha küçük boyutlar daha fazla değişken sağlar.	Hayı	1
prompt	String	Bu video oluşturma işinin istemi.	Evet
width	tamsayı	Videonun genişliği. Aşağıdaki boyutlar desteklenir: 480x480, 854x480, 720x720, 1280x720, 1080x1080 ve 1920x1080 hem yatay hem de dikey yönlerde.	Evet

CreateVideoGenerationWithMediaRequestMultiPart

Medya dosyalarıyla bir video oluşturma işi isteğinin özellikleri.

İsim	Türü	Description	Gerekli	Varsayılan
files	dizi		Evet
height	tamsayı	Videonun yüksekliği. Aşağıdaki boyutlar desteklenir: 480x480, 854x480, 720x720, 1280x720, 1080x1080 ve 1920x1080 hem yatay hem de dikey yönlerde.	Evet
inpaint_items	dizi	Bu video oluşturma işi için isteğe bağlı renklendirme öğeleri.	Hayı
model	String	Bu istek için kullanılacak dağıtımın adı.	Evet
n_seconds	tamsayı	Video oluşturma işinin süresi. 1 ile 20 saniye arasında olmalıdır.	Hayı	5
n_variants	tamsayı	Bu iş için değişken olarak oluşturulacak video sayısı. 1 ile 5 arasında olmalıdır. Daha küçük boyutlar daha fazla değişken sağlar.	Hayı	1
prompt	String	Bu video oluşturma işinin istemi.	Evet
width	tamsayı	Videonun genişliği. Aşağıdaki boyutlar desteklenir: 480x480, 854x480, 720x720, 1280x720, 1080x1080 ve 1920x1080 hem yatay hem de dikey yönlerde.	Evet

CropBounds

Kırpma sınırları, boyanan bir öğenin sınırlarıdır. Bu, boyanması için kullanılması gereken medya öğesinin alanını belirtir.

İsim	Türü	Description	Gerekli	Varsayılan
bottom_fraction	Numara	Özgün medya öğesinin yüksekliğinin kesri olarak belirtilen kırpma kutusunun alt sınırı. 0,0 ile 1,0 arasında olmalıdır. Özgün medya öğesinin yüksekliğinin yarısı için 0,5 gibi bir değer kullanın.	Hayı	1
left_fraction	Numara	Özgün medya öğesinin genişliğinin kesri olarak belirtilen kırpma kutusunun sol sınırı. 0,0 ile 1,0 arasında olmalıdır. Özgün medya öğesinin genişliğinin yarısı için 0,5 gibi bir değer kullanın.	Hayı	0
right_fraction	Numara	Özgün medya öğesinin genişliğinin kesri olarak belirtilen kırpma kutusunun sağ sınırı. 0,0 ile 1,0 arasında olmalıdır. Özgün medya öğesinin genişliğinin yarısı için 0,5 gibi bir değer kullanın.	Hayı	1
top_fraction	Numara	Özgün medya öğesinin yüksekliğinin kesri olarak belirtilen kırpma kutusunun üst sınırı. 0,0 ile 1,0 arasında olmalıdır. Özgün medya öğesinin yüksekliğinin yarısı için 0,5 gibi bir değer kullanın.	Hayı	0

ElasticsearchChatDataSource

İsim	Türü	Description	Gerekli	Varsayılan
parameters	nesne	Elasticsearch veri kaynağının kullanımını denetlemek için parametre bilgileri.	Evet
└─ kısmi_sonuç_izin_ver	Boolean	True olarak ayarlanırsa, sistem kısmi arama sonuçlarının kullanılmasına izin verir ve tüm kısmi sorgular başarısız olursa istek başarısız olur. Belirtilmezse veya false olarak belirtilmezse, herhangi bir arama sorgusu başarısız olursa istek başarısız olur.	Hayı	Yanlış
└─ kimlik doğrulaması	nesne		Hayı
└─ encoded_api_key	String		Hayı
└─ anahtar	String		Hayı
└─ key_id	String		Hayı
└─ türü	enum	Olası değerler: encoded_api_key	Hayı
└─ gömme_bağımlılığı	AzureChatDataSourceVectorizationSource	Veri kaynağı ile ekleme kaynağı olarak kullanılabilen bir veri vektörleştirme kaynağının gösterimi.	Hayı
└─ uç nokta	String		Hayı
└─ alanlar_haritalama	nesne		Hayı
└─ içerik_alanları	dizi		Hayı
└─ içerik_alanları_ayırıcı	String		Hayı
└─ dosyayolu_alani	String		Hayı
└─ başlık_alanı	String		Hayı
└─ url_alanı	String		Hayı
└─ vektör_alanları	dizi		Hayı
└─ in_scope	Boolean	Sorguların dizine alınan verilerin kullanımıyla sınırlandırılıp kısıtlanmaması gerektiği.	Hayı
└─ kapsamları_dahil_et	dizi	Yanıta dahil edilecek çıktı bağlamı özellikleri. Varsayılan olarak, alıntılar ve amaç istenir.	Hayı	['alıntılar', 'amaç']
└─ indeks_adı	String		Hayı
└─ max_search_queries (maksimum arama sorguları)	tamsayı	Tek bir kullanıcı iletisi için arama sağlayıcısına gönderilmesi gereken en fazla yeniden yazılan sorgu sayısı. Varsayılan olarak, sistem otomatik bir belirleme yapar.	Hayı
└─ sorgu_türü	enum	Olası değerler: simple, vector	Hayı
└─ katılık	tamsayı	Arama ilgi filtresinin yapılandırılmış katılığı. Daha yüksek katılık, yanıtın doğruluğunu artırır ancak geri çağırma oranını düşürür.	Hayı
└─ top_n_documents	tamsayı	Sorguda öne çıkması için yapılandırılan belge sayısı.	Hayı
type	enum	Ayrımcı türün tanımlayıcısı her zaman 'elasticsearch' olarak geçer. Olası değerler: elasticsearch	Evet

InpaintItem

Video oluşturma işi için renklendirme öğesi. Bu, video oluşturma işleminde boyanması için kullanılması gereken medya öğesini belirtir.

İsim	Türü	Description	Gerekli	Varsayılan
crop_bounds	nesne	Kırpma sınırları, boyanan bir öğenin sınırlarıdır. Bu, boyanması için kullanılması gereken medya öğesinin alanını belirtir.	Hayı
└─ bottom_fraction	Numara	Özgün medya öğesinin yüksekliğinin kesri olarak belirtilen kırpma kutusunun alt sınırı. 0,0 ile 1,0 arasında olmalıdır. Özgün medya öğesinin yüksekliğinin yarısı için 0,5 gibi bir değer kullanın.	Hayı	1
└─ sol_kesir	Numara	Özgün medya öğesinin genişliğinin kesri olarak belirtilen kırpma kutusunun sol sınırı. 0,0 ile 1,0 arasında olmalıdır. Özgün medya öğesinin genişliğinin yarısı için 0,5 gibi bir değer kullanın.	Hayı	0
└─ right_fraction	Numara	Özgün medya öğesinin genişliğinin kesri olarak belirtilen kırpma kutusunun sağ sınırı. 0,0 ile 1,0 arasında olmalıdır. Özgün medya öğesinin genişliğinin yarısı için 0,5 gibi bir değer kullanın.	Hayı	1
└─ top_fraction	Numara	Özgün medya öğesinin yüksekliğinin kesri olarak belirtilen kırpma kutusunun üst sınırı. 0,0 ile 1,0 arasında olmalıdır. Özgün medya öğesinin yüksekliğinin yarısı için 0,5 gibi bir değer kullanın.	Hayı	0
dosya_adı	String	Medya öğesinin dosya adı. Bu istekteki bir dosya ekinin dosya adıyla eşleşmelidir.	Evet
frame_index	tamsayı	Bu medya öğesinin çerçeve dizini. Bu, bu renklendirme öğesi için oluşturulan videonun başlangıç çerçevesini belirtir.	Evet	0
type	nesne	Boyanan öğenin türü.	Evet

İş Durumu

Video oluşturma işinin durumu.

Mülkiyet	Değer
Açıklama	Video oluşturma işinin durumu.
Türü	String
Değerler	preprocessing queued running processing cancelled succeeded failed

MediaItemType

Boyanan öğenin türü.

Mülkiyet	Değer
Açıklama	Boyanan öğenin türü.
Türü	String
Değerler	image

MongoDBChatDataSource

İsim	Türü	Description	Gerekli	Varsayılan
parameters	nesne	MongoDB veri kaynağının kullanımını denetlemek için parametre bilgileri.	Evet
└─ kısmi_sonuç_izin_ver	Boolean	True olarak ayarlanırsa, sistem kısmi arama sonuçlarının kullanılmasına izin verir ve tüm kısmi sorgular başarısız olursa istek başarısız olur. Belirtilmezse veya false olarak belirtilmezse, herhangi bir arama sorgusu başarısız olursa istek başarısız olur.	Hayı	Yanlış
└─ uygulama_adı	String	MongoDB uygulamasının adı.	Hayı
└─ kimlik doğrulaması	nesne		Hayı
└─ parola	String		Hayı
└─ türü	enum	Olası değerler: username_and_password	Hayı
└─ kullanıcı adı	String		Hayı
└─ koleksiyon_adı	String	MongoDB koleksiyonunun adı.	Hayı
└─ veri_tabani_adi	String	MongoDB veritabanının adı.	Hayı
└─ gömme_bağımlılığı	nesne	Azure OpenAI gömme modeli dağıtımına karşı genel hizmet çağrıları yapan vektörleştirme kaynağını temsil eder.	Hayı
└─ kimlik doğrulaması	AzureChatDataSourceApiKeyAuthenticationOptions veya AzureChatDataSourceAccessTokenAuthenticationOptions	Uç nokta tabanlı vektörleştirme kaynağıyla kullanılacak kimlik doğrulama mekanizması. Uç nokta kimlik doğrulaması API anahtarı ve erişim belirteci mekanizmalarını destekler.	Hayı
└─ dağıtım_adı	String	Vektörleştirme için kullanılacak gömme modeli dağıtımı. Bu dağıtım, sohbet tamamlamaları için kullanılan model dağıtımıyla aynı Azure OpenAI kaynağı içinde bulunmalıdır.	Hayı
└─ boyutları	tamsayı	Eklemeler için istenecek boyut sayısı. Yalnızca 'text-embedding-3' ve sonraki modellerde desteklenir.	Hayı
└─ uç nokta	String	Eklemelerin alınması gereken kaynak uç noktası URL'sini belirtir. Şu biçimde olmalıdır: https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings. Api sürümü sorgu parametresine izin verilmiyor.	Hayı
└─ türü	enum	Bu vektörleştirme kaynak türü için tür tanımlayıcısı her zaman 'deployment_name' olur. Olası değerler: deployment_name	Hayı
└─ uç nokta	String	MongoDB küme uç noktasının adı.	Hayı
└─ alanlar_haritalama	nesne	MongoDB veri kaynağı tarafından kullanılan verilere uygulanacak alan eşlemeleri. MongoDB için içerik ve vektör alanı eşlemelerinin gerekli olduğunu unutmayın.	Hayı
└─ içerik_alanları	dizi		Hayı
└─ içerik_alanları_ayırıcı	String		Hayı
└─ dosyayolu_alani	String		Hayı
└─ başlık_alanı	String		Hayı
└─ url_alanı	String		Hayı
└─ vektör_alanları	dizi		Hayı
└─ in_scope	Boolean	Sorguların dizine alınan verilerin kullanımıyla sınırlandırılıp kısıtlanmaması gerektiği.	Hayı
└─ kapsamları_dahil_et	dizi	Yanıta dahil edilecek çıktı bağlamı özellikleri. Varsayılan olarak, alıntılar ve amaç istenir.	Hayı	['alıntılar', 'amaç']
└─ indeks_adı	String	MongoDB dizininin adı.	Hayı
└─ max_search_queries (maksimum arama sorguları)	tamsayı	Tek bir kullanıcı iletisi için arama sağlayıcısına gönderilmesi gereken en fazla yeniden yazılan sorgu sayısı. Varsayılan olarak, sistem otomatik bir belirleme yapar.	Hayı
└─ katılık	tamsayı	Arama ilgi filtresinin yapılandırılmış katılığı. Daha yüksek katılık, yanıtın doğruluğunu artırır ancak geri çağırma oranını düşürür.	Hayı
└─ top_n_documents	tamsayı	Sorguda öne çıkması için yapılandırılan belge sayısı.	Hayı
type	enum	Her zaman 'mongo_db' olan ayrımcı tür tanımlayıcısı. Olası değerler: mongo_db	Evet

OpenAI.Annotation

OpenAI.Annotation için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
file_citation	OpenAI.AnnotationFileCitation
url_citation	OpenAI.AnnotationUrlCitation
file_path	OpenAI.AnnotationFilePath

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.AnnotationType		Evet

OpenAI.AnnotationFileCitation

Bir dosyaya referans.

İsim	Türü	Description	Gerekli	Varsayılan
dosya_kimlik	String	Dosyanın kimliği.	Evet
filename	String	Belirtilen dosyanın dosya adı.	Evet
indeks	tamsayı	Dosya listesindeki dosyanın dizini.	Evet
type	enum	Dosya alıntısının türü. Her zaman file_citation. Olası değerler: file_citation	Evet

OpenAI.AnnotationFilePath

Bir dosyaya giden yol.

İsim	Türü	Description	Gerekli	Varsayılan
dosya_kimlik	String	Dosyanın kimliği.	Evet
indeks	tamsayı	Dosya listesindeki dosyanın dizini.	Evet
type	enum	Dosya yolunun türü. Her zaman file_path. Olası değerler: file_path	Evet

OpenAI.AnnotationType

Mülkiyet	Değer
Türü	String
Değerler	file_citation url_citation file_path container_file_citation

OpenAI.AnnotationUrlCitation

Model yanıtı oluşturmak için kullanılan bir web kaynağı alıntısı.

İsim	Türü	Description	Gerekli	Varsayılan
end_index	tamsayı	İletideki URL alıntısının son karakterinin dizini.	Evet
start_index	tamsayı	İletideki URL alıntısının ilk karakterinin dizini.	Evet
title	String	Web kaynağının başlığı.	Evet
type	enum	URL alıntısının türü. Her zaman url_citation. Olası değerler: url_citation	Evet
url	String	Web kaynağının URL'si.	Evet

OpenAI.YaklaşıkKonum

İsim	Türü	Description	Gerekli	Varsayılan
city	String		Hayı
country	String		Hayı
region	String		Hayı
timezone	String		Hayı
type	enum	Olası değerler: approximate	Evet

OpenAI.AudioResponseFormat

Çıktının biçimi, şu seçeneklerden birindedir: json, text, srt, verbose_jsonveya vtt. için gpt-4o-transcribe, gpt-4o-transcribe-diarize, gpt-4o-mini-transcribe ve gpt-4o-mini-transcribe-2025-12-15. Desteklenen tek biçimdir json.

Mülkiyet	Değer
Açıklama	Çıktının biçimi, şu seçeneklerden birindedir: json, text, srt, verbose_jsonveya vtt. için gpt-4o-transcribe, gpt-4o-transcribe-diarize, gpt-4o-mini-transcribe ve gpt-4o-mini-transcribe-2025-12-15. Desteklenen tek biçimdir json.
Türü	String
Değerler	json text srt verbose_json vtt

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.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	Varsayılan
açıklama	String	İşlevin ne zaman ve nasıl çağrıldığını seçmek için model tarafından kullanılan işlevin ne yaptığının açıklaması.	Hayı
name	String	Çağrılacak işlevin adı. En fazla uzunluğu 64 olan a-z, A-Z, 0-9 veya alt çizgi ve kısa çizgi içermelidir.	Evet
parameters		İşlevlerin kabullediği, JSON Şeması nesnesi olarak tanımlanan parametreler. Biçimle ilgili belgeler için JSON Şeması başvurusuna bakın. Atlama parameters , boş parametre listesi olan bir işlevi tanımlar.	Hayı

OpenAI.ChatCompletionMessageAudioChunk

İsim	Türü	Description	Gerekli	Varsayılan
veriler	String		Hayı
sona_erdigi_tarih	tamsayı		Hayı
kimlik	String		Hayı
transcript	String		Hayı

OpenAI.ChatCompletionMessageToolCall

İsim	Türü	Description	Gerekli	Varsayılan
function	nesne	Modelin çağırdığını işlev.	Evet
└─ argümanlar	String	JSON biçiminde model tarafından oluşturulan işlevi çağırmak için bağımsız değişkenler. Modelin her zaman geçerli JSON oluşturmadığını ve işlev şemanız tarafından tanımlanmayan parametrelerin halüsinasyona neden olabileceğini unutmayın. İşlevinizi çağırmadan önce kodunuzdaki bağımsız değişkenleri doğrulayın.	Hayı
└─ ad	String	Çağrılacak işlevin adı.	Hayı
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	Varsayılan
function	nesne		Hayı
└─ argümanlar	String	JSON biçiminde model tarafından oluşturulan işlevi çağırmak için bağımsız değişkenler. Modelin her zaman geçerli JSON oluşturmadığını ve işlev şemanız tarafından tanımlanmayan parametrelerin halüsinasyona neden olabileceğini unutmayın. İşlevinizi çağırmadan önce kodunuzdaki bağımsız değişkenleri doğrulayın.	Hayı
└─ ad	String	Çağrılacak işlevin adı.	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.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	nesne		Evet
└─ ad	String	Çağrılacak işlevin adı.	Hayı
type	enum	Aracın türü. Şu anda yalnızca function desteklenmektedir. Olası değerler: function	Evet

OpenAI.ChatCompletionRequestAssistantMessage

Model tarafından kullanıcı iletilerine yanıt olarak gönderilen iletiler.

İsim	Türü	Description	Gerekli	Varsayılan
audio	nesne	Modelin daha önceki bir ses yanıtına ilişkin veriler.	Hayı
└─ kimlik	String	Modelin önceki bir ses yanıtı için benzersiz bir tanımlayıcı.	Hayı
içerik	dize veya dizi		Hayı
function_call	nesne	kullanım dışı bırakıldı ve tarafından tool_callsdeğiştirildi. Model tarafından oluşturulduğu gibi çağrılması gereken bir işlevin adı ve bağımsız değişkenleri.	Hayı
└─ argümanlar	String		Hayı
└─ ad	String		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	String	Asistanın reddetme mesajı.	Hayı
role	enum	İleti yazarının rolü( bu örnekte assistant). Olası değerler: assistant	Evet
tool_calls	ChatCompletionMessageToolCallsItem	Araç, işlev çağrıları gibi model tarafından oluşturulan çağrılar.	Hayı

OpenAI.ChatCompletionRequestAssistantMessageContentPart

İsim	Türü	Description	Gerekli	Varsayılan
Ret	String	Model tarafından oluşturulan reddetme iletisi.	Evet
text	String	Metin içeriği.	Evet
type	enum	İçerik bölümünün türü. Olası değerler: refusal	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	Varsayılan
içerik	dize veya dizi		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	Varsayılan
içerik	String	İşlev iletisinin içeriği.	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
system	OpenAI.ChatCompletionRequestSystemMessage
developer	OpenAI.ChatCompletionRequestDeveloperMessage
user	OpenAI.ChatCompletionRequestUserMessage
assistant	OpenAI.ChatCompletionRequestAssistantMessage
tool	OpenAI.ChatCompletionRequestToolMessage
function	OpenAI.ChatCompletionRequestFunctionMessage

İsim	Türü	Description	Gerekli	Varsayılan
içerik	dize veya dizi		Hayı
role	nesne	İletinin yazarının rolü	Evet

OpenAI.ChatCompletionRequestMessageContentPart

OpenAI.ChatCompletionRequestMessageContentPart için Ayrıştırıcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
text	OpenAI.ChatCompletionRequestMessageContentPartText
image_url	OpenAI.ChatCompletionRequestMessageContentPartImage
refusal	OpenAI.ChatCompletionRequestMessageContentPartRefusal
file	OpenAI.ChatCompletionRequestMessageContentPartFile
input_audio	OpenAI.ChatCompletionRequestMessageContentPartAudio

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.ChatCompletionRequestMessageContentPartType		Evet

OpenAI.ChatCompletionRequestMessageContentPartAudio

İsim	Türü	Description	Gerekli	Varsayılan
input_audio	nesne		Evet
└─ veri	String	Base64 ile kodlanmış ses verileri.	Hayı
└─ biçimi	enum	Kodlanmış ses verilerinin biçimi. Şu anda "wav" ve "mp3" desteklemektedir. Olası değerler: wav, mp3	Hayı
type	enum	İçerik bölümünün türü. Her zaman input_audio. Olası değerler: input_audio	Evet

OpenAI.ChatCompletionRequestMessageContentPartFile

İsim	Türü	Description	Gerekli	Varsayılan
dosya	nesne		Evet
└─ dosya_verisi	String	Base64 kodlanmış dosya verileri, dosyayı modele dize olarak geçirirken kullanılır.	Hayı
└─ dosya_kimliği	String	Giriş olarak kullanılacak karşıya yüklenen dosyanın kimliği.	Hayı
└─ dosya adı	String	Dosyayı modele dize olarak geçirirken kullanılan dosyanın adı.	Hayı
type	enum	İçerik bölümünün türü. Her zaman file. Olası değerler: file	Evet

OpenAI.ChatCompletionRequestMessageContentPartImage

İsim	Türü	Description	Gerekli	Varsayılan
image_url	nesne		Evet
└─ ayrıntı	enum	Görüntünün ayrıntı düzeyini belirtir. Olası değerler: auto, low, high	Hayı
└─ web adresi	String	Görüntünün URL'si veya base64 kodlanmış görüntü verileri.	Hayı
type	enum	İçerik bölümünün türü. Olası değerler: image_url	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.ChatCompletionRequestMessageContentPartType

Mülkiyet	Değer
Türü	String
Değerler	text file input_audio image_url refusal

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	Varsayılan
içerik	dize veya dizi		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	Varsayılan
içerik	dize veya dizi		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ç çağrısı.	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	Varsayılan
içerik	dize veya dizi		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

İsim	Türü	Description	Gerekli	Varsayılan
dosya	nesne		Evet
└─ dosya_verisi	String	Base64 kodlanmış dosya verileri, dosyayı modele dize olarak geçirirken kullanılır.	Hayı
└─ dosya_kimliği	String	Giriş olarak kullanılacak karşıya yüklenen dosyanın kimliği.	Hayı
└─ dosya adı	String	Dosyayı modele dize olarak geçirirken kullanılan dosyanın adı.	Hayı
image_url	nesne		Evet
└─ ayrıntı	enum	Görüntünün ayrıntı düzeyini belirtir. Olası değerler: auto, low, high	Hayı
└─ web adresi	String	Görüntünün URL'si veya base64 kodlanmış görüntü verileri.	Hayı
input_audio	nesne		Evet
└─ veri	String	Base64 ile kodlanmış ses verileri.	Hayı
└─ biçimi	enum	Kodlanmış ses verilerinin biçimi. Şu anda "wav" ve "mp3" desteklemektedir. Olası değerler: wav, mp3	Hayı
text	String	Metin içeriği.	Evet
type	enum	İçerik bölümünün türü. Her zaman file. Olası değerler: file	Evet

OpenAI.ChatCompletionRole

İletinin yazarının rolü

Mülkiyet	Değer
Açıklama	İletinin yazarının rolü
Türü	String
Değerler	system developer user assistant tool function

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_usage	Boolean	Ayarlanırsa, iletiden önce data: [DONE] ek bir öbek akışı oluşturulur. usage Bu öbek üzerindeki alan, isteğin tamamı için belirteç kullanım istatistiklerini gösterir ve choices alan her zaman boş bir dizi olur. Diğer tüm öbekler de null değer içeren bir usage alan içerir. NOT: Akış kesintiye uğrarsa, istek için toplam belirteç kullanımını içeren son kullanım öbeği almayabilirsiniz.	Hayı

OpenAI.ChatCompletionStreamResponseDelta

Akışlı model yanıtları tarafından oluşturulan bir sohbet tamamlama deltası.

İsim	Türü	Description	Gerekli	Varsayılan
audio	nesne		Hayı
└─ veri	String		Hayı
└─ sona_erme_tarihi	tamsayı		Hayı
└─ kimlik	String		Hayı
└─ transkript	String		Hayı
içerik	String	Öbek iletisinin içeriği.	Hayı
function_call	nesne	kullanım dışı bırakıldı ve tarafından tool_callsdeğiştirildi. Model tarafından oluşturulduğu gibi çağrılması gereken bir işlevin adı ve bağımsız değişkenleri.	Hayı
└─ argümanlar	String		Hayı
└─ ad	String		Hayı
Ret	String	Model tarafından oluşturulan reddetme iletisi.	Hayı
role	nesne	İletinin yazarının rolü	Hayı
tool_calls	dizi		Hayı

OpenAI.ChatCompletionTokenLogprob

İsim	Türü	Description	Gerekli	Varsayılan
bytes	dizi	Belirtecin UTF-8 bayt gösterimini temsil eden tamsayıların listesi. Karakterlerin birden çok belirteçle temsil edildiği ve bayt gösterimlerinin doğru metin gösterimini oluşturmak için birleştirildiği durumlarda kullanışlıdır. Belirtecin bayt gösterimi yoksa olabilir null .	Evet
logprob	Numara	En olası ilk 20 belirtecin içindeyse, bu belirtecin günlük 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	Belirteç.	Evet
top_logprobs	dizi	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 Sohbet Tamamlama 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.

İsim	Türü	Description	Gerekli	Varsayılan
function	nesne		Evet
└─ ad	String	Çağrılacak işlevin adı.	Hayı
type	enum	Aracın türü. Şu anda yalnızca function desteklenmektedir. Olası değerler: function	Evet

OpenAI.ChatOutputPrediction

Modelden tahmin edilen çıkışın temel gösterimi.

OpenAI.ChatOutputPrediction için Ayırt Edici

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
content	OpenAI.ChatOutputPredictionContent

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.ChatOutputPredictionType		Evet

OpenAI.ChatOutputPredictionContent

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	dize veya dizi		Evet
type	enum	Sağlamak istediğiniz tahmin edilen içeriğin türü. Bu tür şu anda her zaman contentşeklindedir. Olası değerler: content	Evet

OpenAI.ChatOutputPredictionType

Mülkiyet	Değer
Türü	String
Değerler	content

OpenAI.ChunkingStrategyRequestParam

Dosyaları öbekleme için kullanılan öbekleme stratejisi. Ayarlanmadıysa, stratejiyi auto kullanır.

OpenAI.ChunkingStrategyRequestParam 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.StaticChunkingStrategyRequestParam

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Öbekleme stratejisinin türü. Olası değerler: auto, static	Evet

OpenAI.ChunkingStrategyResponseParam

OpenAI.ChunkingStrategyResponseParam 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
other	OpenAI.OtherChunkingStrategyResponseParam
static	OpenAI.StaticChunkingStrategyResponseParam

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olası değerler: static, other	Evet

OpenAI.CodeInterpreterOutput

OpenAI.CodeInterpreterOutput için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
image	OpenAI.CodeInterpreterOutputImage
logs	OpenAI.CodeInterpreterOutputLogs

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.CodeInterpreterOutputType		Evet

OpenAI.CodeInterpreterOutputImage

Kod yorumlayıcıdan görüntü çıkışı.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Çıktının türü. Her zaman 'resim'. Olası değerler: image	Evet
url	String	Kod yorumlayıcıdan görüntü çıkışının URL'si.	Evet

OpenAI.CodeInterpreterOutputLogs

Günlükler kod yorumlayıcıdan çıkar.

İsim	Türü	Description	Gerekli	Varsayılan
logs	String	Günlükler kod yorumlayıcıdan çıkar.	Evet
type	enum	Çıktının türü. Her zaman 'günlükler'. Olası değerler: logs	Evet

OpenAI.CodeInterpreterOutputType

Mülkiyet	Değer
Türü	String
Değerler	logs image

OpenAI.CodeInterpreterTool

Bir istem için yanıt oluşturmaya yardımcı olmak için Python kodu çalıştıran bir araç.

İsim	Türü	Description	Gerekli	Varsayılan
container	nesne	Kod yorumlayıcı kapsayıcısı için yapılandırma. İsteğe bağlı olarak kodun çalıştırıldığı dosyaların kimliklerini belirtin.	Evet
└─ dosya_kimlikleri	dizi	Kodunuz için kullanılabilir hale getirmek üzere yüklenen dosyaların isteğe bağlı bir listesi.	Hayı
└─ türü	enum	Her zaman auto. Olası değerler: auto	Hayı
type	enum	Kod yorumlayıcı aracının türü. Her zaman code_interpreter. Olası değerler: code_interpreter	Evet

OpenAI.CodeInterpreterToolAuto

Kod yorumlayıcı kapsayıcısı için yapılandırma. İsteğe bağlı olarak kodun çalıştırıldığı dosyaların kimliklerini belirtin.

İsim	Türü	Description	Gerekli	Varsayılan
dosya_kimlikleri	dizi	Kodunuz için kullanılabilir hale getirmek üzere yüklenen dosyaların isteğe bağlı bir listesi.	Hayı
type	enum	Her zaman auto. Olası değerler: auto	Evet

OpenAI.CodeInterpreterToolCallItemParam

Kodu çalıştırmak için bir araç çağrısı.

İsim	Türü	Description	Gerekli	Varsayılan
kod	String	Çalıştırılacak kod veya kullanılamıyorsa null.	Evet
container_id	String	Kodu çalıştırmak için kullanılan kapsayıcının kimliği.	Evet
Çıktılar	dizi	Günlükler veya görüntüler gibi kod yorumlayıcı tarafından oluşturulan çıkışlar. Kullanılabilir çıkış yoksa null olabilir.	Evet
type	enum	Olası değerler: code_interpreter_call	Evet

OpenAI.CodeInterpreterToolCallItemResource

Kodu çalıştırmak için bir araç çağrısı.

İsim	Türü	Description	Gerekli	Varsayılan
kod	String	Çalıştırılacak kod veya kullanılamıyorsa null.	Evet
container_id	String	Kodu çalıştırmak için kullanılan kapsayıcının kimliği.	Evet
Çıktılar	dizi	Günlükler veya görüntüler gibi kod yorumlayıcı tarafından oluşturulan çıkışlar. Kullanılabilir çıkış yoksa null olabilir.	Evet
durum	enum	Olası değerler: in_progress, completed, incomplete, interpreting, failed	Evet
type	enum	Olası değerler: code_interpreter_call	Evet

OpenAI.KıyaslamaFiltresi

Tanımlı bir karşılaştırma işlemi kullanarak belirtilen öznitelik anahtarını belirli bir değerle karşılaştırmak için kullanılan filtre.

İsim	Türü	Description	Gerekli	Varsayılan
key	String	Değerle karşılaştırmak için anahtar.	Evet
type	enum	Karşılaştırma işlecini belirtir: eq, ne, gt, gte, lt, lte. - 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. Olası değerler: eq, ne, gt, gte, , lt, lte	Evet
değer	dize veya sayı ya da boole değeri		Evet

OpenAI.CompletionUsage

Tamamlanma isteği için kullanım istatistikleri.

İsim	Türü	Description	Gerekli	Varsayılan
completion_tokens	tamsayı	Oluşturulan tamamlamadaki belirteçlerin sayısı.	Evet	0
completion_tokens_details	nesne	Tamamlanmada kullanılan belirteçlerin dökümü.	Hayı
└─ kabul edilen tahmin belirteçleri	tamsayı	Tahmin Edilen Çıkışlar kullanılırken, tahmindeki tamamlanmada görünen belirteç sayısı.	Hayı	0
└─ ses_öğeleri	tamsayı	Model tarafından oluşturulan ses giriş belirteçleri.	Hayı	0
└─ akıl yürütme_tokenlar	tamsayı	Model tarafından mantık yürütme için oluşturulan belirteçler.	Hayı	0
└─ reddedilen_tahmin_tokenları	tamsayı	Tahmin Edilen Çıkışlar kullanılırken, tahmindeki tamamlanmada görünmeyen belirteçlerin sayısı. Ancak, akıl yürütme belirteçleri gibi bu belirteçler de faturalama, çıkış ve bağlam penceresi sınırları için toplam tamamlanma belirteçlerinde sayılır.	Hayı	0
prompt_tokens	tamsayı	İstemdeki belirteç sayısı.	Evet	0
prompt_tokens_details	nesne	İstemde kullanılan belirteçlerin dökümü.	Hayı
└─ ses_öğeleri	tamsayı	İstemde ses giriş belirteçleri bulunur.	Hayı	0
└─ önbelleğe alınmış jetonlar	tamsayı	İstemde önbelleğe alınmış belirteçler bulunmaktadır.	Hayı	0
total_tokens	tamsayı	İstekte kullanılan toplam belirteç sayısı (istem + tamamlama).	Evet	0

OpenAI.CompoundFilter

and veya or kullanarak birden çok filtreyi birleştirin.

İsim	Türü	Description	Gerekli	Varsayılan
filters	dizi	Birleştirilecek filtreler dizisi. Öğeler ComparisonFilter veya CompoundFilter olabilir.	Evet
type	enum	İşlem türü: and veya or. Olası değerler: and, or	Evet

OpenAI.ComputerAction

OpenAI.ComputerAction için Ayrıştırıcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
click	OpenAI.ComputerActionClick
double_click	OpenAI.ComputerActionDoubleClick
drag	OpenAI.ComputerActionDrag
move	OpenAI.ComputerActionMove
screenshot	OpenAI.ComputerActionScreenshot
scroll	OpenAI.ComputerActionScroll
type	OpenAI.ComputerActionTypeKeys
wait	OpenAI.ComputerActionWait
keypress	OpenAI.ComputerActionKeyPress

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.ComputerActionType		Evet

OpenAI.ComputerActionClick

Tıklama eylemi.

İsim	Türü	Description	Gerekli	Varsayılan
düğme	enum	Tıklama sırasında hangi fare düğmesine basıldığını gösterir. left, right, wheel, back veya forward. Olası değerler: left, right, wheel, back, forward	Evet
type	enum	Olay türünü belirtir. Tıklama eylemi için bu özellik her zaman olarak clickayarlanır. Olası değerler: click	Evet
x	tamsayı	Tıklamanın gerçekleştiği x koordinatı.	Evet
y	tamsayı	Tıklamanın gerçekleştiği y koordinatı.	Evet

OpenAI.ComputerActionDoubleClick

Çift tıklama eylemi.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olay türünü belirtir. Çift tıklama eylemi için bu özellik her zaman olarak double_clickayarlanır. Olası değerler: double_click	Evet
x	tamsayı	Çift tıklamanın gerçekleştiği x koordinatı.	Evet
y	tamsayı	Çift tıklamanın gerçekleştiği y koordinatı.	Evet

OpenAI.ComputerActionDrag

Sürükleme eylemi.

İsim	Türü	Description	Gerekli	Varsayılan
path	dizi	Sürükleme eyleminin yolunu temsil eden koordinat dizisi. Koordinatlar bir nesne dizisi olarak görünür, örneğin{ x: 100, y: 200 }, { x: 200, y: 300 }	Evet
type	enum	Olay türünü belirtir. Sürükleme eylemi için bu özellik her zaman olarak dragayarlanır. Olası değerler: drag	Evet

OpenAI.ComputerActionKeyPress

Modelin gerçekleştirmek istediği tuş baskıları koleksiyonu.

İsim	Türü	Description	Gerekli	Varsayılan
keys	dizi	Modelin basılmasını istediği tuş kombinasyonu. Bu, her biri bir anahtarı temsil eden bir dize dizisidir.	Evet
type	enum	Olay türünü belirtir. Bir tuşa basma eylemi için bu özellik her zaman olarak keypressayarlanır. Olası değerler: keypress	Evet

OpenAI.ComputerActionMove

Fare hareket ettirme eylemi.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olay türünü belirtir. Taşıma eylemi için bu özellik her zaman move olarak ayarlanır. Olası değerler: move	Evet
x	tamsayı	Taşınacak x koordinatı.	Evet
y	tamsayı	Taşınması gereken y koordinatı.	Evet

OpenAI.ComputerActionScreenshot

Ekran görüntüsü alma işlemi.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olay türünü belirtir. Ekran görüntüsü eylemi için bu özellik her zaman olarak screenshotayarlanır. Olası değerler: screenshot	Evet

OpenAI.ComputerActionScroll

Kaydırma eylemi.

İsim	Türü	Description	Gerekli	Varsayılan
scroll_x	tamsayı	Yatay kaydırma uzaklığı.	Evet
scroll_y	tamsayı	Dikey kaydırma uzaklığı.	Evet
type	enum	Olay türünü belirtir. Kaydırma eylemi için bu özellik her zaman olarak scrollayarlanır. Olası değerler: scroll	Evet
x	tamsayı	Kaydırmanın gerçekleştiği x koordinatı.	Evet
y	tamsayı	Kaydırmanın gerçekleştiği y koordinatı.	Evet

OpenAI.ComputerActionType

Mülkiyet	Değer
Türü	String
Değerler	screenshot click double_click scroll type wait keypress drag move

OpenAI.ComputerActionTypeKeys

Metin yazmak için bir eylem.

İsim	Türü	Description	Gerekli	Varsayılan
text	String	Yazılacak metin.	Evet
type	enum	Olay türünü belirtir. Tür eylemi için bu özellik her zaman olarak typeayarlanır. Olası değerler: type	Evet

OpenAI.ComputerActionWait

Bir bekleme eylemi.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olay türünü belirtir. Bir bekleme eylemi için bu özellik her zaman olarak waitayarlanır. Olası değerler: wait	Evet

OpenAI.ComputerToolCallItemParam

Bilgisayar kullanım araçlarına bir araç komutu verme.

İsim	Türü	Description	Gerekli	Varsayılan
hareket	OpenAI.ComputerAction		Evet
call_id	String	Çıkış verisi ile araç çağrısına yanıt verirken kullanılan tanımlayıcı.	Evet
pending_safety_checks	dizi	Bilgisayar çağrısı için bekleyen güvenlik denetimleri.	Evet
type	enum	Olası değerler: computer_call	Evet

OpenAI.ComputerToolCallItemResource

Bilgisayar kullanım araçlarına bir araç komutu verme.

İsim	Türü	Description	Gerekli	Varsayılan
hareket	OpenAI.ComputerAction		Evet
call_id	String	Çıkış verisi ile araç çağrısına yanıt verirken kullanılan tanımlayıcı.	Evet
pending_safety_checks	dizi	Bilgisayar çağrısı için bekleyen güvenlik denetimleri.	Evet
durum	enum	Öğenin durumu. in_progress, completedveya incomplete. Öğeler API aracılığıyla döndürülürken doldurulur. Olası değerler: in_progress, completed, incomplete	Evet
type	enum	Olası değerler: computer_call	Evet

OpenAI.ComputerToolCallOutputItemOutput

OpenAI.ComputerToolCallOutputItemOutput için Ayırıcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
computer_screenshot	OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.ComputerToolCallOutputItemOutputType	Bilgisayar kullanım aracıyla kullanılan bir bilgisayar ekran görüntüsü.	Evet

OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot

İsim	Türü	Description	Gerekli	Varsayılan
dosya_kimlik	String		Hayı
image_url	String		Hayı
type	enum	Olası değerler: computer_screenshot	Evet

OpenAI.ComputerToolCallOutputItemOutputType

Bilgisayar kullanım aracıyla kullanılan bir bilgisayar ekran görüntüsü.

Mülkiyet	Değer
Açıklama	Bilgisayar kullanım aracıyla kullanılan bir bilgisayar ekran görüntüsü.
Türü	String
Değerler	computer_screenshot

OpenAI.ComputerToolCallOutputItemParam

Bir bilgisayar aracı çağrısının çıktısı.

İsim	Türü	Description	Gerekli	Varsayılan
acknowledged_safety_checks	dizi	API tarafından bildirilen ve geliştirici tarafından onaylanan güvenlik denetimleri.	Hayı
call_id	String	Çıktı üreten bilgisayar aracı çağrısının kimliği.	Evet
çıktı	OpenAI.ComputerToolCallOutputItemOutput		Evet
type	enum	Olası değerler: computer_call_output	Evet

OpenAI.ComputerToolCallOutputItemResource

Bir bilgisayar aracı çağrısının çıktısı.

İsim	Türü	Description	Gerekli	Varsayılan
acknowledged_safety_checks	dizi	API tarafından bildirilen ve geliştirici tarafından onaylanan güvenlik denetimleri.	Hayı
call_id	String	Çıktı üreten bilgisayar aracı çağrısının kimliği.	Evet
çıktı	OpenAI.ComputerToolCallOutputItemOutput		Evet
durum	enum	Öğenin durumu. in_progress, completedveya incomplete. Öğeler API aracılığıyla döndürülürken doldurulur. Olası değerler: in_progress, completed, incomplete	Evet
type	enum	Olası değerler: computer_call_output	Evet

OpenAI.ComputerToolCallSafetyCheck

Bilgisayar çağrısı için bekleyen bir güvenlik denetimi.

İsim	Türü	Description	Gerekli	Varsayılan
kod	String	Bekleyen güvenlik denetiminin türü.	Evet
kimlik	String	Bekleyen güvenlik denetiminin kimliği.	Evet
mesaj	String	Henüz gerçekleştirilmemiş güvenlik denetimi hakkındaki ayrıntılar.	Evet

OpenAI Bilgisayar Kullanımı Önizleme Aracı

Sanal bilgisayarı denetleyebilen bir araç.

İsim	Türü	Description	Gerekli	Varsayılan
görüntü yüksekliği	tamsayı	Bilgisayar ekranının yüksekliği.	Evet
görüntü genişliği	tamsayı	Bilgisayar ekranının genişliği.	Evet
environment	enum	Denetlenecek bilgisayar ortamının türü. Olası değerler: windows, mac, linux, ubuntu, browser	Evet
type	enum	Bilgisayar kullanım aracının türü. Her zaman computer_use_preview. Olası değerler: computer_use_preview	Evet

OpenAI.Coordinate

X/y koordinat çifti, örneğin. { x: 100, y: 200 }

İsim	Türü	Description	Gerekli	Varsayılan
x	tamsayı	X koordinatı.	Evet
y	tamsayı	Y koordinatı.	Evet

OpenAI.CreateEmbeddingResponse

İsim	Türü	Description	Gerekli	Varsayılan
veriler	dizi	Model tarafından oluşturulan eklemelerin listesi.	Evet
model	String	Eklemeyi oluşturmak için kullanılan modelin adı.	Evet
nesne	enum	Her zaman "list" olan nesne türü. Olası değerler: list	Evet
usage	nesne	İsteğin kullanım bilgileri.	Evet
└─ istem_belirteçleri	tamsayı	İstem tarafından kullanılan belirteç sayısı.	Hayı
└─ toplam_jetonlar	tamsayı	İstek tarafından kullanılan toplam belirteç sayısı.	Hayı

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 veya OpenAI.EvalItemContent	Modele metin girişleri - şablon dizeleri içerebilir.	Evet
role	enum	İleti girişinin rolü. user, assistant, system veya 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.CreateEvalRunRequest

İsim	Türü	Description	Gerekli	Varsayılan
veri_kaynağı	nesne		Evet
└─ türü	OpenAI.EvalRunDataSourceType		Hayı
metadata	nesne	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.	Hayı
name	String	Koşunun adı.	Hayı

OpenAI.CreateFineTuningJobRequest

Geçerli modeller:

babbage-002
davinci-002
gpt-3.5-turbo
gpt-4o-mini

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

OpenAI.CreateFineTuningJobRequestIntegration

OpenAI.CreateFineTuningJobRequestIntegration için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
wandb	OpenAI.CreateFineTuningJobRequestWandbIntegration

İsim	Türü	Description	Gerekli	Varsayılan
type	dize (aşağıdaki geçerli modellere bakın)		Evet

OpenAI.CreateFineTuningJobRequestWandbIntegration

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olası değerler: wandb	Evet
wandb	nesne		Evet
└─ varlık	String		Hayı
└─ ad	String		Hayı
└─ projesi	String		Hayı
└─ etiketleri	dizi		Hayı

OpenAI.CreateVectorStoreFileBatchRequest

İsim	Türü	Description	Gerekli	Varsayılan
attributes	nesne	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, nesne hakkında ek bilgileri yapılandırılmış biçimde depolamak ve API veya pano aracılığıyla nesneleri sorgulamak için yararlı olabilir. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler, uzunluğu en fazla 512 karakter, boole veya sayı olan dizelerdir.	Hayı
chunking_strategy	OpenAI.ChunkingStrategyRequestParam	Dosyaları öbekleme için kullanılan öbekleme stratejisi. Ayarlanmadıysa, stratejiyi auto kullanır.	Hayı
dosya_kimlikleri	dizi	Vektör deposunun kullanması gereken dosya kimliklerinin listesi. Dosyalara erişebilecek gibi file_search araçlar için kullanışlıdır.	Evet

OpenAI.CreateVectorStoreFileRequest

İsim	Türü	Description	Gerekli	Varsayılan
attributes	nesne	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, nesne hakkında ek bilgileri yapılandırılmış biçimde depolamak ve API veya pano aracılığıyla nesneleri sorgulamak için yararlı olabilir. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler, uzunluğu en fazla 512 karakter, boole veya sayı olan dizelerdir.	Hayı
chunking_strategy	OpenAI.ChunkingStrategyRequestParam	Dosyaları öbekleme için kullanılan öbekleme stratejisi. Ayarlanmadıysa, stratejiyi auto kullanır.	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	Varsayılan
chunking_strategy	nesne	Varsayılan strateji. Bu strateji şu anda ve'nin max_chunk_size_tokens bir 800 sürümünü chunk_overlap_tokens400kullanır.	Hayı
└─ statik	OpenAI.StaticChunkingStrategy		Hayı
└─ türü	enum	Her zaman static. Olası değerler: static	Hayı
sona_erdikten_sonra	OpenAI.VectorStoreExpirationAfter	Vektör deposu için süre sonu ilkesi.	Hayı
dosya_kimlikleri	dizi	Vektör deposunun kullanması gereken dosya kimliklerinin listesi. Dosyalara erişebilecek gibi file_search araçlar için kullanışlıdır.	Hayı
metadata	nesne	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.	Hayı
name	String	Vektör deposunun adı.	Hayı

OpenAI.DeleteFileResponse

İsim	Türü	Description	Gerekli	Varsayılan
silindi	Boolean		Evet
kimlik	String		Evet
nesne	enum	Olası değerler: file	Evet

OpenAI.DeleteVectorStoreFileResponse

İsim	Türü	Description	Gerekli	Varsayılan
silindi	Boolean		Evet
kimlik	String		Evet
nesne	enum	Olası değerler: vector_store.file.deleted	Evet

OpenAI.DeleteVectorStoreResponse

İsim	Türü	Description	Gerekli	Varsayılan
silindi	Boolean		Evet
kimlik	String		Evet
nesne	enum	Olası değerler: vector_store.deleted	Evet

OpenAI.Embedding

Ekleme uç noktası tarafından döndürülen ekleme vektörlerini temsil eder.

İsim	Türü	Description	Gerekli	Varsayılan
embedding	dizi veya dize		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. Gibi:

• Sohbet botlarımın kalitesini artırma
• Sohbet botlarımın müşteri desteğini ne kadar iyi işlediğini görün
• O4-mini'nin benim kullanım alanımda gpt-4o'dan daha iyi olup olmadığını denetleyin

İsim	Türü	Description	Gerekli	Varsayılan
oluşturulma_tarihi	tamsayı	Değerlendirmenin oluşturulduğu zaman için Unix zaman damgası (saniye olarak).	Evet
veri_kaynağı_yapılandırması	nesne		Evet
└─ türü	OpenAI.EvalDataSourceConfigType		Hayı
kimlik	String	Değerlendirme için benzersiz tanımlayıcı.	Evet
metadata	nesne	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
name	String	Değerlendirmenin adı.	Evet
nesne	enum	Nesne türü. Olası değerler: eval	Evet
test kriterleri	dizi	Test ölçütlerinin listesi.	Evet	Hiç kimse

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

Model örnekleme yapılandırmasını açıklayan CompletionsRunDataSource nesnesi.

İsim	Türü	Description	Gerekli	Varsayılan
input_mesajları	nesne		Hayı
└─ öğe_referansı	String	Ad alanında bir değişkene item başvuru. Yani, "item.input_trajectory"	Hayı
└─ şablon	dizi	İstemi veya bağlamı oluşturan sohbet iletilerinin listesi. {{item.name}} gibi ad alanına değişken başvuruları item içerebilir.	Hayı
└─ türü	enum	Giriş iletilerinin türü. Her zaman item_reference. Olası değerler: item_reference	Hayı
model	String	Tamamlanmaları oluşturmak için kullanılacak modelin adı (örneğin, "o3-mini").	Hayı
Örnekleme_Parametreleri	AzureEvalAPICompletionsSamplingParams		Hayı
kaynak	nesne		Evet
└─ içerik	dizi	jsonl dosyasının içeriği.	Hayı
sonra_oluşturuldu	tamsayı	Bu süreden sonra oluşturulan öğeleri filtrelemek için isteğe bağlı bir Unix zaman damgası.	Hayı
└─ önce oluşturulmuş	tamsayı	Bu süreden önce oluşturulan öğeleri filtrelemek için isteğe bağlı bir Unix zaman damgası.	Hayı
└─ kimlik	String	Dosyanın tanımlayıcısı.	Hayı
└─ sınırı	tamsayı	döndürülecek isteğe bağlı en fazla öğe sayısı.	Hayı
└─ meta veriler	nesne	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.	Hayı
└─ modeli	String	Filtreleme ölçütü olarak isteğe bağlı bir model (örneğin, 'gpt-4o').	Hayı
└─ türü	enum	Kaynak türü. Her zaman stored_completions. Olası değerler: stored_completions	Hayı
type	enum	Çalıştırma veri kaynağının türü. Her zaman completions. Olası değerler: completions	Evet

OpenAI.EvalCustomDataSourceConfigParams

Değerlendirme çalıştırmaları için kullanılan veri kaynağının şemasını tanımlayan customDataSourceConfig nesnesi. Bu şema, aşağıdaki verilerin şeklini tanımlamak için kullanılır:

• Test ölçütlerinizi tanımlamak için kullanılır ve
• Çalıştırma oluştururken hangi veriler gereklidir?

İsim	Türü	Description	Gerekli	Varsayılan
örnek_şema_dahil_et	Boolean	Değerlendirmenin örnek ad alanını doldurmanızı beklemesi gerekip gerekmediği (örneğin, veri kaynağınızdan yanıt oluşturarak)	Hayı	Yanlış
öğ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.EvalCustomDataSourceConfigResource

"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.EvalDataSourceConfigParams

OpenAI.EvalDataSourceConfigParams 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
custom	OpenAI.EvalCustomDataSourceConfigParams
logs	OpenAI.EvalLogsDataSourceConfigParams
stored_completions	OpenAI.EvalStoredCompletionsDataSourceConfigParams

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.EvalDataSourceConfigType		Evet

OpenAI.EvalDataSourceConfigResource

OpenAI.EvalDataSourceConfigResource 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
custom	OpenAI.EvalCustomDataSourceConfigResource
stored_completions	OpenAI.EvalStoredCompletionsDataSourceConfigResource
logs	OpenAI.EvalLogsDataSourceConfigResource

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.EvalDataSourceConfigType		Evet

OpenAI.EvalDataSourceConfigType

Mülkiyet	Değer
Türü	String
Değerler	custom logs stored_completions

OpenAI.EvalGraderLabelModelParams

Değerlendirmedeki her öğeye etiket atamak için model kullanan bir LabelModelGrader nesnesi.

İsim	Türü	Description	Gerekli	Varsayılan
girdi	dizi	İ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	dizi	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	dizi	Geçen sonucu belirten etiketler. Etiketlerin bir alt kümesi olmalıdır.	Evet
type	enum	Her zaman label_modelolan nesne türü. Olası değerler: label_model	Evet

OpenAI.EvalGraderLabelModelResource

İsim	Türü	Description	Gerekli	Varsayılan
girdi	dizi		Evet
labels	dizi	Değerlendirmedeki her öğeye atanacak etiketler.	Evet
model	String	Değerlendirme için kullanılacak model. Yapılandırılmış çıktıları destekleme zorunluluğu vardır.	Evet
name	String	Değerlendiricinin adı.	Evet
geçen etiketler	dizi	Geçen sonucu belirten etiketler. Etiketlerin bir alt kümesi olmalıdır.	Evet
type	enum	Her zaman label_modelolan nesne türü. Olası değerler: label_model	Evet

OpenAI.EvalGraderParams

OpenAI.EvalGraderParams 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
label_model	OpenAI.EvalGraderLabelModelParams
string_check	OpenAI.EvalGraderStringCheckParams
text_similarity	OpenAI.EvalGraderTextSimilarityParams
python	OpenAI.EvalGraderPythonParams
score_model	OpenAI.EvalGraderScoreModelParams

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.GraderType		Evet

OpenAI.EvalGraderPythonParams

İsim	Türü	Description	Gerekli	Varsayılan
image_tag	String	Python betiği için kullanılacak görüntü etiketi.	Hayı
name	String	Değerlendiricinin adı.	Evet
eşik_geçiş	Numara	Puan eşiği.	Hayı
kaynak	String	Python betiğinin kaynak kodu.	Evet
type	enum	Her zaman pythonolan nesne türü. Olası değerler: python	Evet

OpenAI.EvalGraderPythonResource

İsim	Türü	Description	Gerekli	Varsayılan
image_tag	String	Python betiği için kullanılacak görüntü etiketi.	Hayı
name	String	Değerlendiricinin adı.	Evet
eşik_geçiş	Numara	Puan eşiği.	Hayı
kaynak	String	Python betiğinin kaynak kodu.	Evet
type	enum	Her zaman pythonolan nesne türü. Olası değerler: python	Evet

OpenAI.EvalGraderResource

OpenAI.EvalGraderResource 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
label_model	OpenAI.EvalGraderLabelModelResource
text_similarity	OpenAI.EvalGraderTextSimilarityResource
python	OpenAI.EvalGraderPythonResource
score_model	OpenAI.EvalGraderScoreModelResource

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.GraderType		Evet

OpenAI.EvalGraderScoreModelParams

İsim	Türü	Description	Gerekli	Varsayılan
girdi	dizi	Giriş metni. Bu, şablon dizelerini içerebilir.	Evet
model	String	Değerlendirme için kullanılacak model.	Evet
name	String	Değerlendiricinin adı.	Evet
eşik_geçiş	Numara	Puan eşiği.	Hayı
menzil	dizi	Puan aralığı. Varsayılan olarak [0, 1] değerini alır.	Hayı
Örnekleme_Parametreleri		Modelin örnekleme parametreleri.	Hayı
type	enum	Her zaman score_modelolan nesne türü. Olası değerler: score_model	Evet

OpenAI.EvalGraderScoreModelResource

İsim	Türü	Description	Gerekli	Varsayılan
girdi	dizi	Giriş metni. Bu, şablon dizelerini içerebilir.	Evet
model	String	Değerlendirme için kullanılacak model.	Evet
name	String	Değerlendiricinin adı.	Evet
eşik_geçiş	Numara	Puan eşiği.	Hayı
menzil	dizi	Puan aralığı. Varsayılan olarak [0, 1] değerini alır.	Hayı
Örnekleme_Parametreleri		Modelin örnekleme parametreleri.	Hayı
type	enum	Her zaman score_modelolan nesne türü. Olası değerler: score_model	Evet

OpenAI.EvalGraderStringCheckParams

İsim	Türü	Description	Gerekli	Varsayılan
girdi	String	Giriş metni. Bu, şablon dizelerini içerebilir.	Evet
name	String	Değerlendiricinin adı.	Evet
Operasyon	enum	Gerçekleştirilecek dize denetimi işlemi. eq, ne, like veya ilike. Olası değerler: eq, ne, like, ilike	Evet
referans	String	Başvuru metni. Bu, şablon dizelerini içerebilir.	Evet
type	enum	Her zaman string_checkolan nesne türü. Olası değerler: string_check	Evet

OpenAI.EvalGraderTextSimilarityParams

İsim	Türü	Description	Gerekli	Varsayılan
değerlendirme ölçütü	enum	Kullanılacak değerlendirme ölçümü. fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5 veya rouge_l. Olası değerler: fuzzy_match, bleu, gleu, , meteor, rouge_1, , rouge_2, rouge_3rouge_4, rouge_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.EvalGraderTextSimilarityResource

İsim	Türü	Description	Gerekli	Varsayılan
değerlendirme ölçütü	enum	Kullanılacak değerlendirme ölçümü. fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5 veya rouge_l. Olası değerler: fuzzy_match, bleu, gleu, , meteor, rouge_1, , rouge_2, rouge_3rouge_4, rouge_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

Modele, hiyerarşiyi izleyen yönergeyi belirten bir rol içeren bir ileti girişi. developer veya system rolüyle verilen yönergeler, user rolüyle verilen yönergelerden önceliklidir. assistant rolüne sahip iletilerin, önceki etkileşimlerde model tarafından oluşturulduğu varsayılır.

İsim	Türü	Description	Gerekli	Varsayılan
içerik	nesne		Evet
└─ türü	OpenAI.EvalItemContentType		Hayı
role	enum	İleti girişinin rolü. user, assistant, system veya 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

OpenAI.EvalItemContent 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.EvalItemContentInputText
output_text	OpenAI.EvalItemContentOutputText

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.EvalItemContentType		Evet

OpenAI.EvalItemContentInputText

İsim	Türü	Description	Gerekli	Varsayılan
text	String		Evet
type	enum	Olası değerler: input_text	Evet

OpenAI.EvalItemContentOutputText

İsim	Türü	Description	Gerekli	Varsayılan
text	String		Evet
type	enum	Olası değerler: output_text	Evet

OpenAI.EvalItemContentType

Mülkiyet	Değer
Türü	String
Değerler	input_text output_text

OpenAI.EvalJsonlRunDataSourceParams

Değerlendirmeyle eşleşen JSONL dosyasını belirten bir JsonlRunDataSource nesnesi

İsim	Türü	Description	Gerekli	Varsayılan
kaynak	nesne		Evet
└─ içerik	dizi	jsonl dosyasının içeriği.	Hayı
└─ kimlik	String	Dosyanın tanımlayıcısı.	Hayı
└─ türü	enum	Jsonl kaynağının türü. Her zaman file_id. Olası değerler: file_id	Hayı
type	enum	Veri kaynağının türü. Her zaman jsonl. Olası değerler: jsonl	Evet

OpenAI.EvalList

Bir değerlendirme listesini temsil eden bir nesne.

İsim	Türü	Description	Gerekli	Varsayılan
veriler	dizi	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ı belirtir.	Evet
son_kimlik	String	Veri dizisindeki son değerlendirmenin tanımlayıcısı.	Evet
nesne	enum	Bu nesnenin türü. Her zaman "list" olarak ayarlanır. Olası değerler: list	Evet

OpenAI.EvalLogsDataSourceConfigParams

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	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.	Hayı
type	enum	Veri kaynağının türü. Her zaman logs. Olası değerler: logs	Evet

OpenAI.EvalLogsDataSourceConfigResource

Günlükler sorgunuzun meta veri özelliğini belirten LogsDataSourceConfig. Bu genellikle usecase=chatbot, prompt-version=v2 gibi meta verilerdir. Bu veri kaynağı yapılandırmasının döndürdüğü şema, değerlendirmelerinizde hangi değişkenlerin kullanılabilirliğini belirlemek için kullanılır. item ve sample her ikisi de bu veri kaynağı yapılandırması kullanılırken tanımlanır.

İsim	Türü	Description	Gerekli	Varsayılan
metadata	nesne	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
ş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.EvalResponsesRunDataSourceParams

Model örnekleme yapılandırmasını açıklayan Bir ResponsesRunDataSource nesnesi.

İsim	Türü	Description	Gerekli	Varsayılan
input_mesajları	nesne		Hayı
└─ öğe_referansı	String	Ad alanında bir değişkene item başvuru. Yani, "item.name"	Hayı
└─ şablon	dizi	İstemi veya bağlamı oluşturan sohbet iletilerinin listesi. {{item.name}} gibi ad alanına değişken başvuruları item içerebilir.	Hayı
└─ türü	enum	Giriş iletilerinin türü. Her zaman item_reference. Olası değerler: item_reference	Hayı
model	String	Tamamlanmaları oluşturmak için kullanılacak modelin adı (örneğin, "o3-mini").	Hayı
Örnekleme_Parametreleri	AzureEvalAPIResponseSamplingParams		Hayı
kaynak	nesne		Evet
└─ içerik	dizi	jsonl dosyasının içeriği.	Hayı
sonra_oluşturuldu	tamsayı	Yalnızca bu zaman damgası (dahil) sonrasında oluşturulan öğeleri dahil edin. Bu, yanıtları seçmek için kullanılan bir sorgu parametresidir.	Hayı
└─ önce oluşturulmuş	tamsayı	Yalnızca bu zaman damgası (dahil) öncesinde oluşturulan öğeleri dahil edin. Bu, yanıtları seçmek için kullanılan bir sorgu parametresidir.	Hayı
└─ kimlik	String	Dosyanın tanımlayıcısı.	Hayı
└─ talimatlar_arama	String	'yönergeler' alanında arama yapmak için isteğe bağlı dize. Bu, yanıtları seçmek için kullanılan bir sorgu parametresidir.	Hayı
└─ meta veriler	nesne	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.	Hayı
└─ modeli	String	Yanıtlarını bulmak için modelin adı. Bu, yanıtları seçmek için kullanılan bir sorgu parametresidir.	Hayı
└─ akıl yürütme çabası	OpenAI.ReasoningEffort	İsteğe bağlı reasoning effort parametresi. Bu, yanıtları seçmek için kullanılan bir sorgu parametresidir.	Hayı
└─ sıcaklık	Numara	Örnekleme sıcaklığı. Bu, yanıtları seçmek için kullanılan bir sorgu parametresidir.	Hayı
└─ araçları	dizi	Araç adlarının listesi. Bu, yanıtları seçmek için kullanılan bir sorgu parametresidir.	Hayı
└─ top_p	Numara	Çekirdek örnekleme parametresi. Bu, yanıtları seçmek için kullanılan bir sorgu parametresidir.	Hayı
└─ türü	enum	Çalıştırma veri kaynağının türü. Her zaman responses. Olası değerler: responses	Hayı
└─ kullanıcılar	dizi	Kullanıcı tanımlayıcılarının listesi. Bu, yanıtları seçmek için kullanılan bir sorgu parametresidir.	Hayı
type	enum	Çalıştırma veri kaynağının türü. Her zaman responses. Olası değerler: responses	Evet

OpenAI.EvalRun

Değerlendirme oturumunu temsil eden şema.

İsim	Türü	Description	Gerekli	Varsayılan
oluşturulma_tarihi	tamsayı	Değerlendirme çalıştırması oluşturulduğunda Unix zaman damgası (saniye olarak).	Evet
veri_kaynağı	nesne		Evet
└─ türü	OpenAI.EvalRunDataSourceType		Hayı
hata	OpenAI.EvalApiError	Değerlendirme API'sinden bir hata yanıtını temsil eden nesne.	Evet
eval_id	String	İlişkili değerlendirmenin tanımlayıcısı.	Evet
kimlik	String	Değerlendirme çalışması için benzersiz tanımlayıcı.	Evet
metadata	nesne	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
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	dizi	Değerlendirme çalıştırması sırasında her model için kullanım istatistikleri.	Evet
test_kriterlerine_göre_sonuçlar	dizi	Değerlendirme çalıştırması sırasında uygulanan test kriterlerine göre sonuçlar.	Evet
rapor_url	String	kullanıcı arabirimi panosunda görüntülenen değerlendirme raporunun URL'si.	Evet
sonuç_sayıları	nesne	Değerlendirme çalışmasının sonuçlarını özetleyen sayaçlar.	Evet
└─ hata	tamsayı	Hatayla sonuçlanan çıkış öğelerinin sayısı.	Hayı
└─ başarısız oldu	tamsayı	Değerlendirmeyi geçemeyen çıkış öğelerinin sayısı.	Hayı
└─ geçti	tamsayı	Değerlendirmeyi geçen çıkış öğelerinin sayısı.	Hayı
└─ toplam	tamsayı	Yürütülen çıktı öğelerinin toplam sayısı.	Hayı
durum	String	Çalıştırma değerlendirmesinin durumu.	Evet

OpenAI.EvalRunDataContentSource

OpenAI.EvalRunDataContentSource 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_id	OpenAI.EvalRunFileIdDataContentSource
stored_completions	OpenAI.EvalRunStoredCompletionsDataContentSource
responses	OpenAI.EvalRunResponsesDataContentSource

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.EvalRunDataContentSourceType		Evet

OpenAI.EvalRunDataContentSourceType

Mülkiyet	Değer
Türü	String
Değerler	file_id file_content stored_completions responses

OpenAI.EvalRunDataSourceCompletionsResource

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olası değerler: completions	Evet

OpenAI.EvalRunDataSourceJsonlResource

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olası değerler: jsonl	Evet

OpenAI.EvalRunDataSourceParams

OpenAI.EvalRunDataSourceParams 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
jsonl	OpenAI.EvalJsonlRunDataSourceParams
completions	OpenAI.EvalCompletionsRunDataSourceParams
responses	OpenAI.EvalResponsesRunDataSourceParams

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.EvalRunDataSourceType		Evet

OpenAI.EvalRunDataSourceResource

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.EvalRunDataSourceType		Evet

OpenAI.EvalRunDataSourceResponsesResource

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olası değerler: responses	Evet

OpenAI.EvalRunDataSourceType

Mülkiyet	Değer
Türü	String
Değerler	jsonl completions responses

OpenAI.EvalRunFileContentDataContentSource

İsim	Türü	Description	Gerekli	Varsayılan
içerik	dizi	jsonl dosyasının içeriği.	Evet
type	enum	Jsonl kaynağının türü. Her zaman file_content. Olası değerler: file_content	Evet

OpenAI.EvalRunFileIdDataContentSource

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

Değerlendirme için çalıştırma listesini temsil eden nesne.

İsim	Türü	Description	Gerekli	Varsayılan
veriler	dizi	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ı belirtir.	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 "list" 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	Varsayılan
oluşturulma_tarihi	tamsayı	Değerlendirme çalıştırması oluşturulduğunda Unix zaman damgası (saniye olarak).	Evet
veri kaynağı öğesi	nesne	Giriş veri kaynağı öğesinin ayrıntıları.	Evet
veri_kaynağı_öğe_kimliği	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	dizi	Değerlendirme çalıştırmasından alınan sonuçların listesi.	Evet
run_id	String	Bu çıkış öğesiyle ilişkili değerlendirme çalıştırmasının tanımlayıcısı.	Evet
örnek	nesne	Değerlendirme çalıştırmasının giriş ve çıkışını içeren bir örnek.	Evet
└─ hata	OpenAI.EvalApiError	Değerlendirme API'sinden bir hata yanıtını temsil eden nesne.	Hayı
└─ bitiş_nedeni	String	Örnek oluşturma işleminin tamamlandığının nedeni.	Hayı
└─ giriş	dizi	Giriş iletileri dizisi.	Hayı
└─ maksimum_önem_bitim_kodları	tamsayı	Tamamlamaya izin verilen azami belirteç sayısı.	Hayı
└─ modeli	String	Örneği oluşturmak için kullanılan model.	Hayı
└─ çıkış	dizi	Çıkış iletileri dizisi.	Hayı
└─ tohum	tamsayı	Örneği oluşturmak için kullanılan tohum.	Hayı
└─ sıcaklık	Numara	Kullanılan örnekleme sıcaklığı.	Hayı
└─ top_p	Numara	Örnekleme için kullanılan top_p değeri.	Hayı
└─ kullanımı	nesne	Örnek için belirteç kullanımı ayrıntıları.	Hayı
└─ önbelleğe alınmış jetonlar	tamsayı	Önbellekten alınan belirteç sayısı.	Hayı
└─ tamamlama_tokenleri	tamsayı	Oluşturulan tamamlanma belirteçlerinin sayısı.	Hayı
└─ istem_belirteçleri	tamsayı	Kullanılan istem belirteçlerinin sayısı.	Hayı
└─ toplam_jetonlar	tamsayı	Kullanılan toplam belirteç sayısı.	Hayı
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	Varsayılan
veriler	dizi	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 "list" olarak ayarlanır. Olası değerler: list	Evet

OpenAI.EvalRunResponsesDataContentSource

Çalıştırma veri kaynağı yapılandırmasını açıklayan bir EvalResponsesSource nesnesi.

İsim	Türü	Description	Gerekli	Varsayılan
oluşturulma_tarihi_sonrası	tamsayı	Yalnızca bu zaman damgası (dahil) sonrasında oluşturulan öğeleri dahil edin. Bu, yanıtları seçmek için kullanılan bir sorgu parametresidir.	Hayı
önceden oluşturulmuş	tamsayı	Yalnızca bu zaman damgası (dahil) öncesinde oluşturulan öğeleri dahil edin. Bu, yanıtları seçmek için kullanılan bir sorgu parametresidir.	Hayı
instructions_search	String	'yönergeler' alanında arama yapmak için isteğe bağlı dize. Bu, yanıtları seçmek için kullanılan bir sorgu parametresidir.	Hayı
metadata	nesne	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.	Hayı
model	String	Yanıtlarını bulmak için modelin adı. Bu, yanıtları seçmek için kullanılan bir sorgu parametresidir.	Hayı
akıl yürütme çabası	nesne	yalnızca o serisi modeller Mantıp modelleri için mantık yürütme çabasını kısıtlar. Şu anda desteklenen değerler , lowve medium'tirhigh. Muhakeme çabasının azaltılması, yanıtta daha hızlı yanıtlar ve daha az belirteç kullanılmasına neden olabilir.	Hayı
sıcaklık	Numara	Örnekleme sıcaklığı. Bu, yanıtları seçmek için kullanılan bir sorgu parametresidir.	Hayı
araçlar	dizi	Araç adlarının listesi. Bu, yanıtları seçmek için kullanılan bir sorgu parametresidir.	Hayı
top_p	Numara	Çekirdek örnekleme parametresi. Bu, yanıtları seçmek için kullanılan bir sorgu parametresidir.	Hayı
type	enum	Çalıştırma veri kaynağının türü. Her zaman responses. Olası değerler: responses	Evet
users	dizi	Kullanıcı tanımlayıcılarının listesi. Bu, yanıtları seçmek için kullanılan bir sorgu parametresidir.	Hayı

OpenAI.EvalRunStoredCompletionsDataContentSource

Bir filtre kümesini açıklayan StoredCompletionsRunDataSource yapılandırması

İsim	Türü	Description	Gerekli	Varsayılan
oluşturulma_tarihi_sonrası	tamsayı	Bu süreden sonra oluşturulan öğeleri filtrelemek için isteğe bağlı bir Unix zaman damgası.	Hayı
önceden oluşturulmuş	tamsayı	Bu süreden önce oluşturulan öğeleri filtrelemek için isteğe bağlı bir Unix zaman damgası.	Hayı
limit	tamsayı	döndürülecek isteğe bağlı en fazla öğe sayısı.	Hayı
metadata	nesne	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
model	String	Filtreleme ölçütü olarak isteğe bağlı bir model (örneğin, 'gpt-4o').	Hayı
type	enum	Kaynak türü. Her zaman stored_completions. Olası değerler: stored_completions	Evet

OpenAI.EvalStoredCompletionsDataSourceConfigParams

LogsDataSourceConfig yerine kullanım dışı bırakıldı.

İsim	Türü	Description	Gerekli	Varsayılan
metadata	nesne	Depolanan tamamlamalar veri kaynağı için meta veri filtreleri.	Hayı
type	enum	Veri kaynağının türü. Her zaman stored_completions. Olası değerler: stored_completions	Evet

OpenAI.EvalStoredCompletionsDataSourceConfigResource

LogsDataSourceConfig yerine kullanım dışı bırakıldı.

İsim	Türü	Description	Gerekli	Varsayılan
metadata	nesne	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
ş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.FileSearchTool

Yüklenen dosyalardan ilgili içeriği arayan bir araç.

İsim	Türü	Description	Gerekli	Varsayılan
filters	nesne		Hayı
maks_sonuç_sayısı	tamsayı	Döndürülecek en fazla sonuç sayısı. Bu sayı 1 ile 50 (dahil) arasında olmalıdır.	Hayı
Sıralama_seçenekleri	nesne		Hayı
└─ sıralama yapıcı	enum	Dosya araması için kullanılacak dereceleyici. Olası değerler: auto, default-2024-11-15	Hayı
└─ skor_eşiği	Numara	Dosya araması için puan eşiği, 0 ile 1 arasında bir sayı. 1'e yakın sayılar yalnızca en uygun sonuçları döndürmeye çalışır, ancak daha az sonuç döndürebilir.	Hayı
type	enum	Dosya arama aracının türü. Her zaman file_search. Olası değerler: file_search	Evet
vector_store_ids	dizi	Aranacak vektör depolarının kimlikleri.	Evet

OpenAI.FileSearchToolCallItemParam

Dosya arama aracı çağrısının sonuçları.

İsim	Türü	Description	Gerekli	Varsayılan
queries	dizi	Dosyaları aramak için kullanılan sorgular.	Evet
results	dizi	Dosya arama aracı çağrısının sonuçları.	Hayı
type	enum	Olası değerler: file_search_call	Evet

OpenAI.FileSearchToolCallItemResource

Dosya arama aracı çağrısının sonuçları.

İsim	Türü	Description	Gerekli	Varsayılan
queries	dizi	Dosyaları aramak için kullanılan sorgular.	Evet
results	dizi	Dosya arama aracı çağrısının sonuçları.	Hayı
durum	enum	Dosya arama aracı çağrısının durumu. in_progress, searchingveya incompletefailed. Olası değerler: in_progress, searching, completed, incomplete, failed	Evet
type	enum	Olası değerler: file_search_call	Evet

OpenAI.Filters

İsim	Türü	Description	Gerekli	Varsayılan
filters	dizi	Birleştirilecek filtreler dizisi. Öğeler ComparisonFilter veya CompoundFilter olabilir.	Evet
key	String	Değerle karşılaştırmak için anahtar.	Evet
type	enum	İşlem türü: and veya or. Olası değerler: and, or	Evet
değer	dize veya sayı ya da boole değeri	Öznitelik anahtarıyla karşılaştıracak değer; dize, sayı veya boole türlerini destekler.	Evet

OpenAI.FineTuneDPOHyperparameters

DPO hassas ayarlama işi için kullanılan hiper parametreler.

İsim	Türü	Description	Gerekli	Varsayılan
küme_boyutu	enum	Olası değerler: auto	Hayı
beta	enum	Olası değerler: auto	Hayı
öğrenme oranı çarpanı	enum	Olası değerler: auto	Hayı
n_devir	enum	Olası değerler: auto	Hayı

OpenAI.FineTuneDPOMethod

DPO ince ayarlama yöntemi için yapılandırma.

İsim	Türü	Description	Gerekli	Varsayılan
hiper parametreler	OpenAI.FineTuneDPOHyperparameters	DPO hassas ayarlama işi için kullanılan hiper parametreler.	Hayı

OpenAI.FineTuneMethod

İnce ayar için kullanılan yöntem.

İsim	Türü	Description	Gerekli	Varsayılan
dpo	OpenAI.FineTuneDPOMethod	DPO ince ayarlama yöntemi için yapılandırma.	Hayı
Takviye	AzureFineTuneReinforcementMethod		Hayı
Denetimli	OpenAI.FineTuneSupervisedMethod	Denetimli ince ayar yöntemi için yapılandırma.	Hayı
type	enum	Yöntemin türü. supervised, dpoveya reinforcementşeklindedir. Olası değerler: supervised, dpo, reinforcement	Evet

OpenAI.FineTuneReinforcementHyperparameters

Pekiştirici ince ayarlama işi için kullanılan hiper parametreler.

İsim	Türü	Description	Gerekli	Varsayılan
küme_boyutu	enum	Olası değerler: auto	Hayı
compute_multiplier	enum	Olası değerler: auto	Hayı
eval_interval	enum	Olası değerler: auto	Hayı
eval_samples	enum	Olası değerler: auto	Hayı
öğrenme oranı çarpanı	enum	Olası değerler: auto	Hayı
n_devir	enum	Olası değerler: auto	Hayı
akıl yürütme çabası	enum	Akıl yürütme çabası düzeyi. Olası değerler: default, low, medium, high	Hayı

OpenAI.FineTuneSupervisedHyperparameters

İnce ayar işi için kullanılan hiper parametreler.

İsim	Türü	Description	Gerekli	Varsayılan
küme_boyutu	enum	Olası değerler: auto	Hayı
öğrenme oranı çarpanı	enum	Olası değerler: auto	Hayı
n_devir	enum	Olası değerler: auto	Hayı

OpenAI.FineTuneSupervisedMethod

Denetimli ince ayar yöntemi için yapılandırma.

İsim	Türü	Description	Gerekli	Varsayılan
hiper parametreler	OpenAI.FineTuneSupervisedHyperparameters	İnce ayar işi için kullanılan hiper parametreler.	Hayı

OpenAI.FineTuningIntegration

OpenAI.FineTuningIntegration için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
wandb	OpenAI.FineTuningIntegrationWandb

İsim	Türü	Description	Gerekli	Varsayılan
type	dize (aşağıdaki geçerli modellere bakın)		Evet

OpenAI.FineTuningIntegrationWandb

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	İnce ayar görevine etkinleştirilen entegrasyon türü. Olası değerler: wandb	Evet
wandb	nesne	Weights ve Biases ile tümleştirme ayarları. Bu yük, ölçümlerin gönderileceği projeyi belirtir. İsteğe bağlı olarak, çalıştırmanız için açık bir görünen ad ayarlayabilir, çalıştırmanıza etiketler ekleyebilir ve çalıştırmanızla ilişkilendirilecek varsayılan varlığı (ekip, kullanıcı adı vb.) ayarlayabilirsiniz.	Evet
└─ varlık	String	Çalıştırma için kullanılacak varlık. Bu, WandB kullanıcısının ekibini veya kullanıcı adını çalıştırmayla ilişkilendirmek istediğiniz şekilde ayarlamanıza olanak tanır. Ayarlanmadıysa, kayıtlı WandB API anahtarı için varsayılan varlık kullanılır.	Hayı
└─ ad	String	Çalıştırma için ayarlanacağı görünen ad. Ayarlanmadıysa, ad olarak İş Kimliği'ni kullanacağız.	Hayı
└─ projesi	String	Yeni çalıştırmanın oluşturulacağı projenin adı.	Hayı
└─ etiketleri	dizi	Yeni oluşturulan çalıştırmaya eklenecek etiketlerin listesi. Bu etiketler doğrudan WandB'ye geçirilir. Bazı varsayılan etiketler OpenAI tarafından oluşturulur: "openai/finetune", "openai/{base-model}", "openai/{ftjob-abcdef}".	Hayı

OpenAI.FineTuningJob

nesnesi, fine_tuning.job API aracılığıyla oluşturulmuş bir ince ayar işini temsil eder.

İsim	Türü	Description	Gerekli	Varsayılan
oluşturulma_tarihi	tamsayı	hassas ayarlama işinin oluşturulduğu zaman için Unix zaman damgası (saniye olarak).	Evet
hata	nesne	olan failedişlerde ince ayar yapmak için bu, hatanın nedeni hakkında daha fazla bilgi içerir.	Evet
└─ kod	String	Makine tarafından okunabilir bir hata kodu.	Hayı
└─ ileti	String	İnsan tarafından okunabilir bir hata iletisi.	Hayı
└─ parametre	String	Genellikle veya training_filegeçersiz validation_file olan parametre. Hata parametreye özgü değilse bu alan null olur.	Hayı
tahmini_bitiş	tamsayı	unix zaman damgası (saniye cinsinden) için ince ayarlama işinin ne zaman bitmek üzere tahmin edilir. İnce ayar işi çalışmıyorsa değer null olur.	Hayı
fine_tuned_model	String	Oluşturulan ince ayarlı modelin adı. İnce ayar işi hala çalışıyorsa değer null olur.	Evet
tamamlandı	tamsayı	hassas ayarlama işinin ne zaman bittiğine ilişkin Unix zaman damgası (saniye olarak). İnce ayar işi hala çalışıyorsa değer null olur.	Evet
hiper parametreler	nesne	İnce ayar işi için kullanılan hiper parametreler. Bu değer yalnızca işler çalıştırılırken supervised döndürülür.	Evet
└─ yığın boyutu	enum	Olası değerler: auto	Hayı
└─ öğrenme oranı çarpanı	enum	Olası değerler: auto	Hayı
└─ n_epochs	enum	Olası değerler: auto	Hayı
kimlik	String	API uç noktalarına başvurulabilen nesne tanımlayıcısı.	Evet
Entegrasyonlar	dizi	Bu ince ayar işi için etkinleştirecek tümleştirmelerin listesi.	Hayı
metadata	nesne	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, 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
method	OpenAI.FineTuneMethod	İnce ayar için kullanılan yöntem.	Hayı
model	String	İnce ayar yapılan temel model.	Evet
nesne	enum	Her zaman "fine_tuning.job" olan nesne türü. Olası değerler: fine_tuning.job	Evet
organization_id	String	İnce ayar işinin sahibi olan kuruluş.	Evet
sonuç_dosyaları	dizi	İnce ayar işi için derlenmiş sonuç dosyası kimlikleri. Sonuçları Dosyalar API'siyle alabilirsiniz.	Evet
seed	tamsayı	İnce ayar işi için kullanılan tohum.	Evet
durum	enum	, veya validating_filesolabilirqueuedrunningsucceededfailed, ince ayarlama işinin cancelledgeçerli durumu. Olası değerler: validating_files, queued, running, succeeded, , failed, cancelled	Evet
eğitilmiş_jetonlar	tamsayı	Bu ince ayar işi tarafından işlenen faturalanabilir belirteçlerin toplam sayısı. İnce ayar işi hala çalışıyorsa değer null olur.	Evet
eğitim_dosyası	String	Eğitim için kullanılan dosya kimliği. Eğitim verilerini Dosyalar API'siyle alabilirsiniz.	Evet
user_provided_suffix	String	İş oluşturma isteğinde belirtildiği gibi işe uygulanan açıklayıcı sonek.	Hayı
doğrulama_dosyası	String	Doğrulama için kullanılan dosya kimliği. Doğrulama sonuçlarını Dosyalar API'siyle alabilirsiniz.	Evet

OpenAI.FineTuningJobCheckpoint

fine_tuning.job.checkpoint nesnesi, kullanıma hazır bir ince ayar işi için model denetim noktasını temsil eder.

İsim	Türü	Description	Gerekli	Varsayılan
oluşturulma_tarihi	tamsayı	Denetim noktasının oluşturulduğu zaman için Unix zaman damgası (saniye olarak).	Evet
ince_ayarlı_model_kontrol_noktası	String	Oluşturulan hassas denetim noktası modelinin adı.	Evet
ince_ayarlama_iş_id	String	Bu denetim noktasının oluşturulduğu ince ayar işinin adı.	Evet
kimlik	String	API uç noktalarında başvurulabilen denetim noktası tanımlayıcısı.	Evet
metrics	nesne	İnce ayar işi sırasında adım numarasındaki ölçümler.	Evet
tam doğrulama kaybı (full_valid_loss)	Numara		Hayı
└─ tam_geçerli_ortalama_token_doğruluğu	Numara		Hayı
└─ adım	Numara		Hayı
└─ eğitim kaybı	Numara		Hayı
└─ eğitim_ortalama_token_dogrulugu	Numara		Hayı
└─ doğrulama_kaybı	Numara		Hayı
└─ geçerli_ortalama_öğe_doğruluğu	Numara		Hayı
nesne	enum	Her zaman "fine_tuning.job.checkpoint" olan nesne türü. Olası değerler: fine_tuning.job.checkpoint	Evet
adım_numarası	tamsayı	Denetim noktasının oluşturulduğu adım numarası.	Evet

OpenAI.FineTuningJobEvent

İş olayı nesnesine ince ayar

İsim	Türü	Description	Gerekli	Varsayılan
oluşturulma_tarihi	tamsayı	hassas ayarlama işinin oluşturulduğu zaman için Unix zaman damgası (saniye olarak).	Evet
veriler		Olayla ilişkili veriler.	Hayı
kimlik	String	Nesne tanımlayıcısı.	Evet
seviye	enum	Olayın günlük düzeyi. Olası değerler: info, warn, error	Evet
mesaj	String	Olayın iletisi.	Evet
nesne	enum	Her zaman "fine_tuning.job.event" olan nesne türü. Olası değerler: fine_tuning.job.event	Evet
type	enum	Olayın türü. Olası değerler: message, metrics	Hayı

OpenAI.FunctionObject

İsim	Türü	Description	Gerekli	Varsayılan
açıklama	String	İşlevin ne zaman ve nasıl çağrıldığını seçmek için model tarafından kullanılan işlevin ne yaptığının açıklaması.	Hayı
name	String	Çağrılacak işlevin adı. En fazla uzunluğu 64 olan a-z, A-Z, 0-9 veya alt çizgi ve kısa çizgi içermelidir.	Evet
parameters		İşlevlerin kabullediği, JSON Şeması nesnesi olarak tanımlanan parametreler.	Hayı
Sıkı	Boolean	İşlev çağrısı oluşturulurken sıkı şemaya bağlı kalınmasının etkinleştirilip etkinleştirilmeyileceği. True olarak ayarlanırsa, model alanda tanımlanan şemayı parameters tam olarak izler. strict trueolduğunda yalnızca bir JSON Şeması alt kümesi desteklenir.	Hayı	Yanlış

OpenAI.FunctionTool

Modelin çağırmayı seçebileceği kendi kodunuzda bir işlev tanımlar.

İsim	Türü	Description	Gerekli	Varsayılan
açıklama	String	İşlevin açıklaması. İşlevin çağrılıp çağrılmayacağını belirlemek için model tarafından kullanılır.	Hayı
name	String	Çağrılacak işlevin adı.	Evet
parameters		İşlevin parametrelerini açıklayan bir JSON şema nesnesi.	Evet
Sıkı	Boolean	Katı parametre doğrulamasının zorunlu kılınıp uygulanmayacağı. Varsayılan true.	Evet
type	enum	İşlev aracının türü. Her zaman function. Olası değerler: function	Evet

OpenAI.FunctionToolCallItemParam

Bir fonksiyonu çalıştırmak için bir araç çağrısı.

İsim	Türü	Description	Gerekli	Varsayılan
arguments	String	İşleve geçirecek bağımsız değişkenlerin JSON dizesi.	Evet
call_id	String	Model tarafından oluşturulan işlev aracı çağrısının benzersiz kimliği.	Evet
name	String	Çalıştırılacak işlevin adı.	Evet
type	enum	Olası değerler: function_call	Evet

OpenAI.FunctionToolCallItemResource

Bir fonksiyonu çalıştırmak için bir araç çağrısı.

İsim	Türü	Description	Gerekli	Varsayılan
arguments	String	İşleve geçirecek bağımsız değişkenlerin JSON dizesi.	Evet
call_id	String	Model tarafından oluşturulan işlev aracı çağrısının benzersiz kimliği.	Evet
name	String	Çalıştırılacak işlevin adı.	Evet
durum	enum	Öğenin durumu. in_progress, completedveya incomplete. Öğeler API aracılığıyla döndürülürken doldurulur. Olası değerler: in_progress, completed, incomplete	Evet
type	enum	Olası değerler: function_call	Evet

OpenAI.FunctionToolCallOutputItemParam

İşlev aracı çağrısının çıktısı.

İsim	Türü	Description	Gerekli	Varsayılan
call_id	String	Model tarafından oluşturulan işlev aracı çağrısının benzersiz kimliği.	Evet
çıktı	String	İşlev aracı çağrısının çıkışının JSON dizesi.	Evet
type	enum	Olası değerler: function_call_output	Evet

OpenAI.FunctionToolCallOutputItemResource

İşlev aracı çağrısının çıktısı.

İsim	Türü	Description	Gerekli	Varsayılan
call_id	String	Model tarafından oluşturulan işlev aracı çağrısının benzersiz kimliği.	Evet
çıktı	String	İşlev aracı çağrısının çıkışının JSON dizesi.	Evet
durum	enum	Öğenin durumu. in_progress, completedveya incomplete. Öğeler API aracılığıyla döndürülürken doldurulur. Olası değerler: in_progress, completed, incomplete	Evet
type	enum	Olası değerler: function_call_output	Evet

OpenAI.Grader

OpenAI.Grader 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
label_model	OpenAI.GraderLabelModel
text_similarity	OpenAI.GraderTextSimilarity
python	OpenAI.GraderPython
score_model	OpenAI.GraderScoreModel
multi	OpenAI.GraderMulti

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.GraderType		Evet

OpenAI.GraderLabelModel

Değerlendirmedeki her öğeye etiket atamak için model kullanan bir LabelModelGrader nesnesi.

İsim	Türü	Description	Gerekli	Varsayılan
girdi	dizi		Evet
labels	dizi	Değerlendirmedeki her öğeye atanacak etiketler.	Evet
model	String	Değerlendirme için kullanılacak model. Yapılandırılmış çıktıları destekleme zorunluluğu vardır.	Evet
name	String	Değerlendiricinin adı.	Evet
geçen etiketler	dizi	Geçen sonucu belirten etiketler. Etiketlerin bir alt kümesi olmalıdır.	Evet
type	enum	Her zaman label_modelolan nesne türü. Olası değerler: label_model	Evet

OpenAI.GraderMulti

MultiGrader nesnesi, tek bir puan oluşturmak için birden çok not verenin çıkışını birleştirir.

İsim	Türü	Description	Gerekli	Varsayılan
calculate_output	String	Not veren sonuçlarına göre çıkışı hesaplamak için bir formül.	Evet
Greyder	nesne		Evet
name	String	Değerlendiricinin adı.	Evet
type	enum	Her zaman multiolan nesne türü. Olası değerler: multi	Evet

OpenAI.GraderPython

Girişte python betiği çalıştıran bir PythonGrader nesnesi.

İsim	Türü	Description	Gerekli	Varsayılan
image_tag	String	Python betiği için kullanılacak görüntü etiketi.	Hayı
name	String	Değerlendiricinin adı.	Evet
kaynak	String	Python betiğinin kaynak kodu.	Evet
type	enum	Her zaman pythonolan nesne türü. Olası değerler: python	Evet

OpenAI.GraderScoreModel

Girişe puan atamak için model kullanan scoreModelGrader nesnesi.

İsim	Türü	Description	Gerekli	Varsayılan
girdi	dizi	Giriş metni. Bu, şablon dizelerini içerebilir.	Evet
model	String	Değerlendirme için kullanılacak model.	Evet
name	String	Değerlendiricinin adı.	Evet
menzil	dizi	Puan aralığı. Varsayılan olarak [0, 1] değerini alır.	Hayı
Örnekleme_Parametreleri		Modelin örnekleme parametreleri.	Hayı
type	enum	Her zaman score_modelolan nesne türü. Olası değerler: score_model	Evet

OpenAI.GraderStringCheck

Belirtilen işlemi kullanarak giriş ve başvuru arasında dize karşılaştırması gerçekleştiren bir StringCheckGrader nesnesi.

İsim	Türü	Description	Gerekli	Varsayılan
girdi	String	Giriş metni. Bu, şablon dizelerini içerebilir.	Evet
name	String	Değerlendiricinin adı.	Evet
Operasyon	enum	Gerçekleştirilecek dize denetimi işlemi. eq, ne, like veya ilike. Olası değerler: eq, ne, like, ilike	Evet
referans	String	Başvuru metni. Bu, şablon dizelerini içerebilir.	Evet
type	enum	Her zaman string_checkolan nesne türü. Olası değerler: string_check	Evet

OpenAI.GraderTextSimilarity

Metinleri benzerlik ölçümlerine göre notlayan textSimilarityGrader nesnesi.

İsim	Türü	Description	Gerekli	Varsayılan
değerlendirme ölçütü	enum	Kullanılacak değerlendirme ölçümü. fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5 veya rouge_l. Olası değerler: fuzzy_match, bleu, gleu, , meteor, rouge_1, , rouge_2, rouge_3rouge_4, rouge_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.GraderType

Mülkiyet	Değer
Türü	String
Değerler	string_check text_similarity score_model label_model python multi

OpenAI.ImageGenTool

gibi gpt-image-1.5bir model kullanarak görüntü oluşturan bir araç.

İsim	Türü	Description	Gerekli	Varsayılan
arka plan	enum	Oluşturulan görüntünün arka plan türü. transparent, opaqueveya auto. Varsayılan: auto. Olası değerler: transparent, opaque, auto	Hayı
girdi_görüntü_maskesi	nesne	Boyanma için isteğe bağlı maske. İçerir image_url (dize, isteğe bağlı) ve file_id (dize, isteğe bağlı).	Hayı
└─ dosya_kimliği	String	Maske görüntüsünün dosya kimliği.	Hayı
└─ image_url (görsel URL'si)	String	Base64 ile kodlanmış maske görüntüsü.	Hayı
model	enum	Kullanılacak görüntü oluşturma modeli. Varsayılan: gpt-image-1. Olası değerler: gpt-image-1, gpt-image-1.5	Hayı
moderation	enum	Oluşturulan görüntü için denetim düzeyi. Varsayılan: auto. Olası değerler: auto, low	Hayı
çıktı sıkıştırma	tamsayı	Çıkış görüntüsü için sıkıştırma düzeyi. Varsayılan: 100.	Hayı	100
çıkış formatı	enum	Oluşturulan görüntünün çıkış biçimi. png, webpveya jpeg. Varsayılan: png. Olası değerler: png, webp, jpeg	Hayı
kısmi_görüntüler	tamsayı	Akış modunda 0 'dan (varsayılan değer) 3'e kadar oluşturulacak kısmi görüntü sayısı.	Hayı	0
nitelik	enum	Oluşturulan görüntünün kalitesi. low, medium, high veya auto. Varsayılan: auto. Olası değerler: low, medium, high, auto	Hayı
boyut	enum	Oluşturulan görüntünün boyutu. 1024x1024, 1024x1536, 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.ImageGenToolCallItemParam

Model tarafından yapılan bir görüntü oluşturma isteği.

İsim	Türü	Description	Gerekli	Varsayılan
sonuç	String	Oluşturulan görüntü base64'te kodlanmış.	Evet
type	enum	Olası değerler: image_generation_call	Evet

OpenAI.ImageGenToolCallItemResource

Model tarafından yapılan bir görüntü oluşturma isteği.

İsim	Türü	Description	Gerekli	Varsayılan
sonuç	String	Oluşturulan görüntü base64'te kodlanmış.	Evet
durum	enum	Olası değerler: in_progress, completed, generating, failed	Evet
type	enum	Olası değerler: image_generation_call	Evet

OpenAI.ImplicitUserMessage

İsim	Türü	Description	Gerekli	Varsayılan
içerik	dize veya dizi		Evet

OpenAI.Includable

Model yanıtına eklenecek ek çıktı verilerini belirtin. Şu anda desteklenen değerler şunlardır:

• code_interpreter_call.outputs: Kod yorumlayıcı aracı çağrı öğelerinde python kod yürütme çıktılarını içerir.
• computer_call_output.output.image_url: Bilgisayar çağrısı çıkışından görüntü URL'lerini ekleyin.
• file_search_call.results: Dosya arama aracı çağrısının arama sonuçlarını ekleyin.
• message.input_image.image_url: Giriş iletisinden görüntü URL'lerini ekleyin.
• message.output_text.logprobs: Yardımcı iletilerine logprobs ekleyin.
• reasoning.encrypted_content: Akıl yürütme öğesi çıkışlarında akıl yürütme belirteçlerinin şifrelenmiş bir sürümünü içerir. Bu, Yanıtlar API'sini durum bilgisi olmadan kullanırken (örneğin, store parametresi false olarak ayarlandığında veya bir kuruluş sıfır veri saklama programına kaydedildiğinde) akıl yürütme öğelerinin çok aşamalı konuşmalarda kullanılmasını sağlar.

Mülkiyet	Değer
Açıklama	Model yanıtına eklenecek ek çıktı verilerini belirtin. Şu anda desteklenen değerler şunlardır: - code_interpreter_call.outputs: 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	code_interpreter_call.outputs computer_call_output.output.image_url file_search_call.results message.input_image.image_url message.output_text.logprobs reasoning.encrypted_content

OpenAI.ItemContent

OpenAI.ItemContent için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
input_audio	OpenAI.ItemContentInputAudio
output_audio	OpenAI.ItemContentOutputAudio
refusal	OpenAI.ItemContentRefusal
input_text	OpenAI.ItemContentInputText
input_image	OpenAI.ItemContentInputImage
input_file	OpenAI.ItemContentInputFile
output_text	OpenAI.ItemContentOutputText

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.ItemContentType	Çok modlu giriş ve çıkış içeriği.	Evet

OpenAI.ItemContentInputAudio

Modele ses girişi.

İsim	Türü	Description	Gerekli	Varsayılan
veriler	String	Base64 ile kodlanmış ses verileri.	Evet
format	enum	Ses verilerinin biçimi. Şu anda desteklenen biçimler mp3 ve wav'dir. Olası değerler: mp3, wav	Evet
type	enum	Giriş öğesinin türü. Her zaman input_audio. Olası değerler: input_audio	Evet

OpenAI.ItemContentInputFile

Modele bir dosya girişi.

İsim	Türü	Description	Gerekli	Varsayılan
file_data	String	Modele gönderilecek dosyanın içeriği.	Hayı
dosya_kimlik	String	Modele gönderilecek dosyanın kimliği.	Hayı
filename	String	Modele gönderilecek dosyanın adı.	Hayı
type	enum	Giriş öğesinin türü. Her zaman input_file. Olası değerler: input_file	Evet

OpenAI.ItemContentInputImage

Modele bir görüntü girişi.

İsim	Türü	Description	Gerekli	Varsayılan
detail	enum	Modele gönderilecek görüntünün ayrıntı düzeyi. high, lowveya auto. Varsayılan olarak auto değerini alır. Olası değerler: low, high, auto	Hayı
dosya_kimlik	String	Modele gönderilecek dosyanın kimliği.	Hayı
image_url	String	Modele gönderilecek görüntünün URL'si. Tam bir URL veya veri URL'sinde base64 kodlanmış görüntü.	Hayı
type	enum	Giriş öğesinin türü. Her zaman input_image. Olası değerler: input_image	Evet

OpenAI.ItemContentInputText

Modele metin girişi.

İsim	Türü	Description	Gerekli	Varsayılan
text	String	Modele metin girişi.	Evet
type	enum	Giriş öğesinin türü. Her zaman input_text. Olası değerler: input_text	Evet

OpenAI.ItemContentOutputAudio

Modelden gelen bir ses çıkışı.

İsim	Türü	Description	Gerekli	Varsayılan
veriler	String	Modelden alınan Base64 ile kodlanmış ses verileri.	Evet
transcript	String	Modeldeki ses verilerinin dökümü.	Evet
type	enum	Çıkış sesinin türü. Her zaman output_audio. Olası değerler: output_audio	Evet

OpenAI.ItemContentOutputText

Modelden bir metin çıktısı.

İsim	Türü	Description	Gerekli	Varsayılan
Açıklamalar	dizi	Metin çıkışının ek açıklamaları.	Evet
logprobs	dizi		Hayı
text	String	Modelden metin çıkışı.	Evet
type	enum	Çıkış metninin türü. Her zaman output_text. Olası değerler: output_text	Evet

OpenAI.ItemContentRefusal

Model tarafından reddedilme.

İsim	Türü	Description	Gerekli	Varsayılan
Ret	String	Modelden gelen reddetme açıklaması.	Evet
type	enum	Reddetmenin türü. Her zaman refusal. Olası değerler: refusal	Evet

OpenAI.ItemContentType

Çok modlu giriş ve çıkış içeriği.

Mülkiyet	Değer
Açıklama	Çok modlu giriş ve çıkış içeriği.
Türü	String
Değerler	input_text input_audio input_image input_file output_text output_audio refusal

OpenAI.ItemParam

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

OpenAI.ItemParam için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
file_search_call	OpenAI.FileSearchToolCallItemParam
computer_call	OpenAI.ComputerToolCallItemParam
computer_call_output	OpenAI.ComputerToolCallOutputItemParam
web_search_call	OpenAI.WebSearchToolCallItemParam
function_call	OpenAI.FunctionToolCallItemParam
function_call_output	OpenAI.FunctionToolCallOutputItemParam
reasoning	OpenAI.ReasoningItemParam
item_reference	OpenAI.ItemReferenceItemParam
image_generation_call	OpenAI.ImageGenToolCallItemParam
code_interpreter_call	OpenAI.CodeInterpreterToolCallItemParam
local_shell_call	OpenAI.LocalShellToolCallItemParam
local_shell_call_output	OpenAI.LocalShellToolCallOutputItemParam
mcp_list_tools	OpenAI.MCPListToolsItemParam
mcp_approval_request	OpenAI.MCPApprovalRequestItemParam
mcp_approval_response	OpenAI.MCPApprovalResponseItemParam
mcp_call	OpenAI.MCPCallItemParam
message	OpenAI.ResponsesMessageItemParam

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.ItemType		Evet

OpenAI.ItemReferenceItemParam

Başvurulacak bir öğenin iç tanımlayıcısı.

İsim	Türü	Description	Gerekli	Varsayılan
kimlik	String	Daha önce oluşturulmuş ve referans alınan yanıt öğesinin servis kaynaklı kimliği.	Evet
type	enum	Olası değerler: item_reference	Evet

OpenAI.ItemResource

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

OpenAI.ItemResource için Ayrıştırıcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
file_search_call	OpenAI.FileSearchToolCallItemResource
computer_call	OpenAI.ComputerToolCallItemResource
computer_call_output	OpenAI.ComputerToolCallOutputItemResource
web_search_call	OpenAI.WebSearchToolCallItemResource
function_call	OpenAI.FunctionToolCallItemResource
function_call_output	OpenAI.FunctionToolCallOutputItemResource
reasoning	OpenAI.ReasoningItemResource
image_generation_call	OpenAI.ImageGenToolCallItemResource
code_interpreter_call	OpenAI.CodeInterpreterToolCallItemResource
local_shell_call	OpenAI.LocalShellToolCallItemResource
local_shell_call_output	OpenAI.LocalShellToolCallOutputItemResource
mcp_list_tools	OpenAI.MCPListToolsItemResource
mcp_approval_request	OpenAI.MCPApprovalRequestItemResource
mcp_approval_response	OpenAI.MCPApprovalResponseItemResource
mcp_call	OpenAI.MCPCallItemResource
message	OpenAI.ResponsesMessageItemResource

İsim	Türü	Description	Gerekli	Varsayılan
kimlik	String		Evet
type	OpenAI.ItemType		Evet

OpenAI.ItemType

Mülkiyet	Değer
Türü	String
Değerler	message file_search_call function_call function_call_output computer_call computer_call_output web_search_call reasoning item_reference image_generation_call code_interpreter_call local_shell_call local_shell_call_output mcp_list_tools mcp_approval_request mcp_approval_response mcp_call

OpenAI.ListFineTuningJobCheckpointsResponse

İsim	Türü	Description	Gerekli	Varsayılan
veriler	dizi		Evet
ilk_kimlik	String		Hayı
daha_fazla	Boolean		Evet
son_kimlik	String		Hayı
nesne	enum	Olası değerler: list	Evet

OpenAI.ListFineTuningJobEventsResponse

İsim	Türü	Description	Gerekli	Varsayılan
veriler	dizi		Evet
daha_fazla	Boolean		Evet
nesne	enum	Olası değerler: list	Evet

OpenAI.ListModelsResponse

İsim	Türü	Description	Gerekli	Varsayılan
veriler	dizi		Evet
nesne	enum	Olası değerler: list	Evet

OpenAI.ListPaginatedFineTuningJobsResponse

İsim	Türü	Description	Gerekli	Varsayılan
veriler	dizi		Evet
daha_fazla	Boolean		Evet
nesne	enum	Olası değerler: list	Evet

OpenAI.ListVectorStoreFilesFilter

Mülkiyet	Değer
Türü	String
Değerler	in_progress completed failed cancelled

OpenAI.ListVectorStoreFilesResponse

İsim	Türü	Description	Gerekli	Varsayılan
veriler	dizi		Evet
ilk_kimlik	String		Evet
daha_fazla	Boolean		Evet
son_kimlik	String		Evet
nesne	enum	Olası değerler: list	Evet

OpenAI.ListVectorStoresResponse

İsim	Türü	Description	Gerekli	Varsayılan
veriler	dizi		Evet
ilk_kimlik	String		Evet
daha_fazla	Boolean		Evet
son_kimlik	String		Evet
nesne	enum	Olası değerler: list	Evet

OpenAI.LocalShellExecAction

Sunucuda bir kabuk komutu yürütür.

İsim	Türü	Description	Gerekli	Varsayılan
komut	dizi	Çalıştırılacak komut.	Evet
env	nesne	Komutu için ayarlanacağı ortam değişkenleri.	Evet
zaman_aşımı_ms	tamsayı	komutu için milisaniye cinsinden isteğe bağlı zaman aşımı.	Hayı
type	enum	Yerel kabuk eyleminin türü. Her zaman exec. Olası değerler: exec	Evet
user	String	komutu olarak çalıştırmak için isteğe bağlı kullanıcı.	Hayı
working_directory	String	komutun çalıştırılacak isteğe bağlı çalışma dizini.	Hayı

OpenAI.LocalShellTool

Modelin yerel bir ortamda kabuk komutlarını yürütmesine izin veren bir araç.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Yerel kabuk aracının türü. Her zaman local_shell. Olası değerler: local_shell	Evet

OpenAI.LocalShellToolCallItemParam

Yerel kabukta komut çalıştırmak için bir araç çağrısı.

İsim	Türü	Description	Gerekli	Varsayılan
hareket	OpenAI.LocalShellExecAction	Sunucuda bir kabuk komutu yürütür.	Evet
call_id	String	Model tarafından oluşturulan yerel kabuk aracı çağrısının benzersiz kimliği.	Evet
type	enum	Olası değerler: local_shell_call	Evet

OpenAI.LocalShellToolCallItemResource

Yerel kabukta komut çalıştırmak için bir araç çağrısı.

İsim	Türü	Description	Gerekli	Varsayılan
hareket	OpenAI.LocalShellExecAction	Sunucuda bir kabuk komutu yürütür.	Evet
call_id	String	Model tarafından oluşturulan yerel kabuk aracı çağrısının benzersiz kimliği.	Evet
durum	enum	Olası değerler: in_progress, completed, incomplete	Evet
type	enum	Olası değerler: local_shell_call	Evet

OpenAI.LocalShellToolCallOutputItemParam

Yerel kabuk aracı çağrısının çıktısı.

İsim	Türü	Description	Gerekli	Varsayılan
çıktı	String	Yerel kabuk aracı çağrısının çıkışının JSON dizesi.	Evet
type	enum	Olası değerler: local_shell_call_output	Evet

OpenAI.LocalShellToolCallOutputItemResource

Yerel kabuk aracı çağrısının çıktısı.

İsim	Türü	Description	Gerekli	Varsayılan
çıktı	String	Yerel kabuk aracı çağrısının çıkışının JSON dizesi.	Evet
durum	enum	Olası değerler: in_progress, completed, incomplete	Evet
type	enum	Olası değerler: local_shell_call_output	Evet

OpenAI.Location

OpenAI.Location için Ayırt Edici

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
approximate	OpenAI.ApproximateLocation

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.LocationType		Evet

OpenAI.LokasyonTürü

Mülkiyet	Değer
Türü	String
Değerler	approximate

OpenAI.LogProb

Belirtecin günlük olasılığı.

İsim	Türü	Description	Gerekli	Varsayılan
bytes	dizi		Evet
logprob	Numara		Evet
token	String		Evet
top_logprobs	dizi		Evet

OpenAI.MCPApprovalRequestItemParam

Bir araç çağrısı işlemi için insan onayı isteği.

İsim	Türü	Description	Gerekli	Varsayılan
arguments	String	Araç için bir JSON bağımsız değişken dizesi.	Evet
name	String	Çalıştırılacak aracın adı.	Evet
sunucu etiketi	String	İsteği yapan MCP sunucusunun etiketi.	Evet
type	enum	Olası değerler: mcp_approval_request	Evet

OpenAI.MCPApprovalRequestItemResource

Bir araç çağrısı işlemi için insan onayı isteği.

İsim	Türü	Description	Gerekli	Varsayılan
arguments	String	Araç için bir JSON bağımsız değişken dizesi.	Evet
name	String	Çalıştırılacak aracın adı.	Evet
sunucu etiketi	String	İsteği yapan MCP sunucusunun etiketi.	Evet
type	enum	Olası değerler: mcp_approval_request	Evet

OpenAI.MCPApprovalResponseItemParam

MCP onay isteğine yanıt.

İsim	Türü	Description	Gerekli	Varsayılan
approval_request_id	String	Yanıtlanan onay isteğinin ID'si.	Evet
approve	Boolean	İsteğin onaylanıp onaylanmadı.	Evet
sebep	String	Karar için isteğe bağlı neden.	Hayı
type	enum	Olası değerler: mcp_approval_response	Evet

OpenAI.MCPApprovalResponseItemResource

MCP onay isteğine yanıt.

İsim	Türü	Description	Gerekli	Varsayılan
approval_request_id	String	Yanıtlanan onay isteğinin ID'si.	Evet
approve	Boolean	İsteğin onaylanıp onaylanmadı.	Evet
sebep	String	Karar için isteğe bağlı neden.	Hayı
type	enum	Olası değerler: mcp_approval_response	Evet

OpenAI.MCPCallItemParam

MCP sunucusundaki bir aracın çağrılması.

İsim	Türü	Description	Gerekli	Varsayılan
arguments	String	Araca geçirilen bağımsız değişkenlerin JSON dizesi.	Evet
hata	String	Araç çağrısından gelen bir hata varsa.	Hayı
name	String	Çalıştırılan aracın adı.	Evet
çıktı	String	Araç çağrısının çıktısı.	Hayı
sunucu etiketi	String	Aracı çalıştıran MCP sunucusunun etiketi.	Evet
type	enum	Olası değerler: mcp_call	Evet

OpenAI.MCPCallItemResource

MCP sunucusundaki bir aracın çağrılması.

İsim	Türü	Description	Gerekli	Varsayılan
arguments	String	Araca geçirilen bağımsız değişkenlerin JSON dizesi.	Evet
hata	String	Araç çağrısından gelen bir hata varsa.	Hayı
name	String	Çalıştırılan aracın adı.	Evet
çıktı	String	Araç çağrısının çıktısı.	Hayı
sunucu etiketi	String	Aracı çalıştıran MCP sunucusunun etiketi.	Evet
type	enum	Olası değerler: mcp_call	Evet

OpenAI.MCPListToolsItemParam

MCP sunucusunda kullanılabilen araçların listesi.

İsim	Türü	Description	Gerekli	Varsayılan
hata	String	Sunucu araçları listeleyemediyse hata iletisi.	Hayı
sunucu etiketi	String	MCP sunucusunun etiketi.	Evet
araçlar	dizi	Sunucuda bulunan araçlar.	Evet
type	enum	Olası değerler: mcp_list_tools	Evet

OpenAI.MCPListToolsItemResource

MCP sunucusunda kullanılabilen araçların listesi.

İsim	Türü	Description	Gerekli	Varsayılan
hata	String	Sunucu araçları listeleyemediyse hata iletisi.	Hayı
sunucu etiketi	String	MCP sunucusunun etiketi.	Evet
araçlar	dizi	Sunucuda bulunan araçlar.	Evet
type	enum	Olası değerler: mcp_list_tools	Evet

OpenAI.MCPListToolsTool

MCP sunucusunda kullanılabilen bir araç.

İsim	Türü	Description	Gerekli	Varsayılan
Açıklamalar		Araç hakkında ek açıklamalar.	Hayı
açıklama	String	Araç Açıklaması	Hayı
input_schema		Aracın girişini açıklayan JSON şeması.	Evet
name	String	Araç adı.	Evet

OpenAI.MCPTool

Modele uzak Model Bağlam Protokolü (MCP) sunucuları aracılığıyla ek araçlara erişim verin.

İsim	Türü	Description	Gerekli	Varsayılan
izin verilen araçlar	nesne		Hayı
└─ araç_adları	dizi	İzin verilen araç adlarının listesi.	Hayı
headers	nesne	MCP sunucusuna gönderilecek isteğe bağlı HTTP üst bilgileri. Kimlik doğrulaması veya başka amaçlar için kullanın.	Hayı
onay_gerektir	object (aşağıdaki geçerli modellere bakın)	Hangi MCP sunucusunun araçlarının onay gerektirdiğini belirtin.	Hayı
sunucu etiketi	String	Bu MCP sunucusu için araç çağrılarında tanımlamak için kullanılan bir etiket.	Evet
sunucu_url	String	MCP sunucusunun URL'si.	Evet
type	enum	MCP aracının türü. Her zaman mcp. Olası değerler: mcp	Evet

OpenAI.MetadataPropertyForRequest

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.

İsim	Türü	Description	Gerekli	Varsayılan
metadata	nesne	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.	Hayı

OpenAI.Model

API ile kullanılabilecek bir OpenAI model teklifini açıklar.

İsim	Türü	Description	Gerekli	Varsayılan
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
owned_by	String	Modelin sahibi olan kuruluş.	Evet

OpenAI.OtherChunkingStrategyResponseParam

Öbekleme stratejisi bilinmediğinde 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.ParallelToolCalls

Araç kullanımı sırasında paralel işlev çağrısının etkinleştirilip etkinleştirilmeyileceği.

Tür: bool

OpenAI.Prompt

bir istem şablonuna ve değişkenlerine başvuru.

İsim	Türü	Description	Gerekli	Varsayılan
kimlik	String	Kullanılacak istem şablonunun benzersiz tanımlayıcısı.	Evet
değişkenler	nesne	İsteminizde değişkenlerin yerine kullanılacak isteğe bağlı değer eşlemesi. Değiştirme değerleri dizeler veya görüntüler veya dosyalar gibi diğer Yanıt giriş türleri olabilir.	Hayı
version	String	İstem şablonunun isteğe bağlı sürümü.	Hayı

OpenAI.RankingOptions

İsim	Türü	Description	Gerekli	Varsayılan
sıralayıcı	enum	Dosya araması için kullanılacak dereceleyici. Olası değerler: auto, default-2024-11-15	Hayı
puan_eşik_değeri	Numara	Dosya araması için puan eşiği, 0 ile 1 arasında bir sayı. 1'e yakın sayılar yalnızca en uygun sonuçları döndürmeye çalışır, ancak daha az sonuç döndürebilir.	Hayı

OpenAI.Reasoning

yalnızca o serisi modeller

İsim	Türü	Description	Gerekli	Varsayılan
effort	nesne	yalnızca o serisi modeller Mantıp modelleri için mantık yürütme çabasını kısıtlar. Şu anda desteklenen değerler , lowve medium'tirhigh. Muhakeme çabasının azaltılması, yanıtta daha hızlı yanıtlar ve daha az belirteç kullanılmasına neden olabilir.	Hayı
generate_summary	enum	Kullanım dışı: bunun yerine kullanın summary . Model tarafından gerçekleştirilen mantığın özeti. Bu, hata ayıklama ve modelin akıl yürütme işlemini anlamak için yararlı olabilir. auto, conciseveya detailed. Olası değerler: auto, concise, detailed	Hayı
summary	enum	Model tarafından gerçekleştirilen mantığın özeti. Bu, hata ayıklama ve modelin akıl yürütme işlemini anlamak için yararlı olabilir. auto, conciseveya detailed. Olası değerler: auto, concise, detailed	Hayı

OpenAI.ReasoningEffort

yalnızca o serisi modeller

Mantıp modelleri için mantık yürütme çabasını kısıtlar. Şu anda desteklenen değerler , lowve medium'tirhigh. Muhakeme çabasının azaltılması, yanıtta daha hızlı yanıtlar ve daha az belirteç kullanılmasına neden olabilir.

Mülkiyet	Değer
Açıklama	yalnızca o serisi modeller Mantıp modelleri için mantık yürütme çabasını kısıtlar. Şu anda desteklenen değerler , lowve medium'tirhigh. Muhakeme çabasının azaltılması, yanıtta daha hızlı yanıtlar ve daha az belirteç kullanılmasına neden olabilir.
Türü	String
Değerler	low medium high

OpenAI.ReasoningItemParam

Bir yanıt oluştururken bir akıl yürütme modeli tarafından kullanılan düşünce zincirinin açıklaması. Bağlamı el ile yönetiyorsanız, bu öğeleri konuşmanın sonraki dönüşleri için Yanıtlar API'nize input eklediğinizden emin olun.

İsim	Türü	Description	Gerekli	Varsayılan
encrypted_content	String	Gerekçe öğesinin şifrelenmiş içeriği - parametresinde reasoning.encrypted_content ile include bir yanıt oluşturulduğunda doldurulur.	Hayı
summary	dizi	Metin içeriğini muhakeme etme.	Evet
type	enum	Olası değerler: reasoning	Evet

OpenAI.ReasoningItemResource

Bir yanıt oluştururken bir akıl yürütme modeli tarafından kullanılan düşünce zincirinin açıklaması. Bağlamı el ile yönetiyorsanız, bu öğeleri konuşmanın sonraki dönüşleri için Yanıtlar API'nize input eklediğinizden emin olun.

İsim	Türü	Description	Gerekli	Varsayılan
encrypted_content	String	Gerekçe öğesinin şifrelenmiş içeriği - parametresinde reasoning.encrypted_content ile include bir yanıt oluşturulduğunda doldurulur.	Hayı
summary	dizi	Metin içeriğini muhakeme etme.	Evet
type	enum	Olası değerler: reasoning	Evet

OpenAI.ReasoningItemSummaryPart

OpenAI.ReasoningItemSummaryPart için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
summary_text	OpenAI.ReasoningItemSummaryTextPart

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.ReasoningItemSummaryPartType		Evet

OpenAI.ReasoningItemSummaryPartType

Mülkiyet	Değer
Türü	String
Değerler	summary_text

OpenAI.ReasoningItemSummaryTextPart

İsim	Türü	Description	Gerekli	Varsayılan
text	String		Evet
type	enum	Olası değerler: summary_text	Evet

OpenAI.Response

İsim	Türü	Description	Gerekli	Varsayılan
arka plan	Boolean	Model yanıtının arka planda çalıştırılıp çalıştırılmayacağı.	Hayı	Yanlış
oluşturulma_tarihi	tamsayı	Bu Yanıtın oluşturulduğu unix zaman damgası (saniye).	Evet
hata	nesne	Model yanıt oluşturamadığında döndürülen bir hata nesnesi.	Evet
└─ kod	OpenAI.ResponseErrorCode	Yanıtın hata kodu.	Hayı
└─ ileti	String	Hatanın insan tarafından okunabilen açıklaması.	Hayı
kimlik	String	Bu Yanıt için benzersiz tanımlayıcı.	Evet
incomplete_details	nesne	Yanıtın neden eksik olduğuna ilişkin ayrıntılar.	Evet
└─ neden	enum	Yanıtın tamamlanmamış olmasının nedeni. Olası değerler: max_output_tokens, content_filter	Hayı
instructions	dize veya dizi		Evet
max_output_tokens	tamsayı	Görünür çıkış belirteçleri ve muhakeme belirteçleri de dahil olmak üzere yanıt için oluşturulabilecek belirteç sayısı için üst sınır	Hayı
max_tool_calls	tamsayı	Bir yanıtta işlenebilen yerleşik araçlara yapılan toplam çağrı sayısı üst sınırı. Bu maksimum sayı, tek tek araç başına değil, tüm yerleşik araç çağrıları için geçerlidir. Model tarafından bir aracı çağırmaya yönelik diğer girişimler yoksayılır.	Hayı
metadata	nesne	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, 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	Bu kaynağın nesne türü - her zaman response olarak ayarlanır. Olası değerler: response	Evet
çıktı	dizi	Model tarafından oluşturulan içerik öğeleri dizisi. - Dizideki output öğelerin uzunluğu ve sırası modelin yanıtına bağlıdır. - Dizideki output ilk öğeye erişmek ve bunun model tarafından oluşturulan içeriğe sahip bir assistant ileti olduğunu varsaymak yerine SDK'larda desteklenen özelliğini kullanmayı output_text düşünebilirsiniz.	Evet
output_text	String	SDK özellikli yalnızca kolaylık sağlayan bir özellik olan, varsa dizideki tüm output_text öğelerinin metin çıktılarını bir araya getiren output içeren özellik. Python ve JavaScript SDK'larında desteklenir.	Hayı
paralel araç çağrıları	Boolean	Modelin araç çağrılarını paralel olarak çalıştırmasına izin verilip verilmeyeceği.	Evet	Doğru
previous_response_id	String	Modele önceki yanıtın benzersiz kimliği. Çok aşamalı konuşmalar oluşturmak için bunu kullanın.	Hayı
prompt	nesne	bir istem şablonuna ve değişkenlerine başvuru.	Hayı
└─ kimlik	String	Kullanılacak istem şablonunun benzersiz tanımlayıcısı.	Hayı
└─ değişkenler	OpenAI.ResponsePromptVariables	İsteminizde değişkenlerin yerine kullanılacak isteğe bağlı değer eşlemesi. Değiştirme değerleri dizeler veya görüntüler veya dosyalar gibi diğer Yanıt giriş türleri olabilir.	Hayı
└─ sürümü	String	İstem şablonunun isteğe bağlı sürümü.	Hayı
reasoning	nesne	yalnızca o serisi modeller Mantık modelleri için yapılandırma seçenekleri.	Hayı
└─ çaba	OpenAI.ReasoningEffort	yalnızca o serisi modeller Mantıp modelleri için mantık yürütme çabasını kısıtlar. Şu anda desteklenen değerler , lowve medium'tirhigh. Muhakeme çabasının azaltılması, yanıtta daha hızlı yanıtlar ve daha az belirteç kullanılmasına neden olabilir.	Hayı
└─ özet oluştur	enum	Kullanım dışı: bunun yerine kullanın summary . Model tarafından gerçekleştirilen mantığın özeti. Bu, hata ayıklama ve modelin akıl yürütme işlemini anlamak için yararlı olabilir. auto, conciseveya detailed. Olası değerler: auto, concise, detailed	Hayı
└─ özeti	enum	Model tarafından gerçekleştirilen mantığın özeti. Bu, hata ayıklama ve modelin akıl yürütme işlemini anlamak için yararlı olabilir. auto, conciseveya detailed. Olası değerler: auto, concise, detailed	Hayı
durum	enum	Yanıt oluşturma durumu. completed, failed, in_progress, cancelled, queued veya incomplete. Olası değerler: completed, failed, in_progress, cancelled, , queued, incomplete	Hayı
sıcaklık	Numara	0 ile 2 arasında hangi örnekleme sıcaklığının kullanılacağı. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir. Genellikle bunu değiştirmenizi öneririz top_p ancak ikisini birden değiştirmemenizi öneririz.	Evet
text	nesne	Modelden metin yanıtı için yapılandırma seçenekleri. Düz metin veya yapılandırılmış JSON verileri olabilir.	Hayı
└─ biçimi	OpenAI.ResponseTextFormatConfiguration		Hayı
tool_choice	nesne	Model tarafından çağrılan aracı (varsa) denetler. none modelin herhangi bir aracı çağırmayacağı ve bunun yerine bir ileti oluşturduğu anlamına gelir. auto modelin 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.	Hayı
└─ türü	OpenAI.ToolChoiceObjectType	Modelin bir yanıt oluşturmak için yerleşik bir araç kullanması gerektiğini gösterir.	Hayı
araçlar	dizi	Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Parametresini ayarlayarak tool_choice hangi aracın kullanılacağını belirtebilirsiniz. Modeli sağlayabileceğiniz iki araç kategorisi şunlardır: - Yerleşik araçlar: OpenAI tarafından sağlanan ve modelin özelliklerini genişleten araçlar.	Hayı
top_logprobs	tamsayı	Her biri ilişkili günlük olasılığına sahip her belirteç konumunda döndürülecek en olası belirteç sayısını belirten 0 ile 20 arasında bir tamsayı.	Hayı
top_p	Numara	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.	Evet
truncation	enum	Model yanıtı için kullanılacak kesme stratejisi. - auto: Bu yanıtın bağlamı ve öncekiler modelin bağlam penceresi boyutunu aşarsa, model konuşmanın ortasına giriş öğelerini bırakarak yanıtı bağlam penceresine uyacak şekilde kesecektir. - disabled (varsayılan): Model yanıtı bir modelin bağlam penceresi boyutunu aşarsa istek 400 hatasıyla başarısız olur. Olası değerler: auto, disabled	Hayı
usage	OpenAI.ResponseUsage	Giriş belirteçleri, çıkış belirteçleri, çıkış belirteçlerinin dökümü ve kullanılan toplam belirteçler dahil olmak üzere belirteç kullanım ayrıntılarını temsil eder.	Hayı
user	String	OpenAI'nin kötüye kullanımı izlemesine ve algılamasına yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı.	Evet

OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent

Kısmi kod parçacığı kod yorumlayıcı tarafından akışa alındığında yayılır.

İsim	Türü	Description	Gerekli	Varsayılan
delta	String	Kod yorumlayıcı tarafından akışı yapılan kısmi kod parçacığı.	Evet
item_id	String	Kod yorumlayıcı aracı çağrı öğesinin benzersiz tanımlayıcısı.	Evet
output_index	tamsayı	Kodun akışa alındığı yanıttaki çıkış öğesinin dizini.	Evet
type	enum	Olayın türü. Her zaman response.code_interpreter_call_code.delta. Olası değerler: response.code_interpreter_call_code.delta	Evet

OpenAI.ResponseCodeInterpreterCallCodeDoneEvent

Kod parçacığı kod yorumlayıcı tarafından sonlandırıldığında yayılır.

İsim	Türü	Description	Gerekli	Varsayılan
kod	String	Kod yorumlayıcısı tarafından son kod parçacığı çıkışı.	Evet
item_id	String	Kod yorumlayıcı aracı çağrı öğesinin benzersiz tanımlayıcısı.	Evet
output_index	tamsayı	Kodun sonlandırıldığı yanıttaki çıkış öğesinin dizini.	Evet
type	enum	Olayın türü. Her zaman response.code_interpreter_call_code.done. Olası değerler: response.code_interpreter_call_code.done	Evet

OpenAI.ResponseCodeInterpreterCallCompletedEvent

Kod yorumlayıcı çağrısı tamamlandığında gönderilir.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	Kod yorumlayıcı aracı çağrı öğesinin benzersiz tanımlayıcısı.	Evet
output_index	tamsayı	Kod yorumlayıcı çağrısının tamamlandığı yanıttaki çıkış öğesinin dizini.	Evet
type	enum	Olayın türü. Her zaman response.code_interpreter_call.completed. Olası değerler: response.code_interpreter_call.completed	Evet

OpenAI.ResponseCodeInterpreterCallInProgressEvent

Bir kod yorumlayıcı çağrısı sırasında tetiklenir.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	Kod yorumlayıcı aracı çağrı öğesinin benzersiz tanımlayıcısı.	Evet
output_index	tamsayı	Kod yorumlayıcı çağrısının devam ettiği yanıttaki çıkış öğesinin dizini.	Evet
type	enum	Olayın türü. Her zaman response.code_interpreter_call.in_progress. Olası değerler: response.code_interpreter_call.in_progress	Evet

OpenAI.ResponseCodeInterpreterCallInterpretingEvent

Kod yorumlayıcısı kod parçacığını etkin bir şekilde yorumladığında yayılır.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	Kod yorumlayıcı aracı çağrı öğesinin benzersiz tanımlayıcısı.	Evet
output_index	tamsayı	Kod yorumlayıcının kodu yorumladığı yanıttaki çıkış öğesinin dizini.	Evet
type	enum	Olayın türü. Her zaman response.code_interpreter_call.interpreting. Olası değerler: response.code_interpreter_call.interpreting	Evet

OpenAI.ResponseCompletedEvent

Model yanıtı tamamlandığında gönderilir.

İsim	Türü	Description	Gerekli	Varsayılan
yanıt	nesne		Evet
└─ arka plan	Boolean	Model yanıtının arka planda çalıştırılıp çalıştırılmayacağı.	Hayı	Yanlış
└─ oluşturulma_tarihi	tamsayı	Bu Yanıtın oluşturulduğu unix zaman damgası (saniye).	Hayı
└─ hata	OpenAI.ResponseError	Model yanıt oluşturamadığında döndürülen bir hata nesnesi.	Hayı
└─ kimlik	String	Bu Yanıt için benzersiz tanımlayıcı.	Hayı
└─ eksik_bilgiler	nesne	Yanıtın neden eksik olduğuna ilişkin ayrıntılar.	Hayı
└─ neden	enum	Yanıtın tamamlanmamış olmasının nedeni. Olası değerler: max_output_tokens, content_filter	Hayı
└─ yönerge	dize veya dizi	Modelin bağlamı içine eklenen bir sistem (veya geliştirici) iletisi. ile previous_response_idbirlikte kullanıldığında, önceki yanıttan alınan yönergeler sonraki yanıta taşınmaz. Bu, sistem (veya geliştirici) iletilerini yeni yanıtlarda değiştirme işlemini basitleştirir.	Hayı
└─ maksimum_çıkış_jetonları	tamsayı	Görünür çıkış belirteçleri ve muhakeme belirteçleri de dahil olmak üzere yanıt için oluşturulabilecek belirteç sayısı için üst sınır	Hayı
└─ maksimum araç çağrıları	tamsayı	Bir yanıtta işlenebilen yerleşik araçlara yapılan toplam çağrı sayısı üst sınırı. Bu maksimum sayı, tek tek araç başına değil, tüm yerleşik araç çağrıları için geçerlidir. Model tarafından bir aracı çağırmaya yönelik diğer girişimler yoksayılır.	Hayı
└─ meta veriler	nesne	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, 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.	Hayı
└─ nesne	enum	Bu kaynağın nesne türü - her zaman response olarak ayarlanır. Olası değerler: response	Hayı
└─ çıkış	dizi	Model tarafından oluşturulan içerik öğeleri dizisi. - Dizideki output öğelerin uzunluğu ve sırası modelin yanıtına bağlıdır. - Dizideki output ilk öğeye erişmek ve bunun model tarafından oluşturulan içeriğe sahip bir assistant ileti olduğunu varsaymak yerine SDK'larda desteklenen özelliğini kullanmayı output_text düşünebilirsiniz.	Hayı
└─ çıktı_metin	String	SDK özellikli yalnızca kolaylık sağlayan bir özellik olan, varsa dizideki tüm output_text öğelerinin metin çıktılarını bir araya getiren output içeren özellik. Python ve JavaScript SDK'larında desteklenir.	Hayı
└─ paralel_arac_cagrilari	Boolean	Modelin araç çağrılarını paralel olarak çalıştırmasına izin verilip verilmeyeceği.	Hayı	Doğru
└─ önceki_cevap_id	String	Modele önceki yanıtın benzersiz kimliği. Çok aşamalı konuşmalar oluşturmak için bunu kullanın.	Hayı
└─ istemi	OpenAI.Prompt	bir istem şablonuna ve değişkenlerine başvuru.	Hayı
└─ akıl yürütme	OpenAI.Reasoning	yalnızca o serisi modeller Mantık modelleri için yapılandırma seçenekleri.	Hayı
└─ durumu	enum	Yanıt oluşturma durumu. completed, failed, in_progress, cancelled, queued veya incomplete. Olası değerler: completed, failed, in_progress, cancelled, , queued, incomplete	Hayı
└─ sıcaklık	Numara	0 ile 2 arasında hangi örnekleme sıcaklığının kullanılacağı. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir. Genellikle bunu değiştirmenizi öneririz top_p ancak ikisini birden değiştirmemenizi öneririz.	Hayı
└─ metin	nesne	Modelden metin yanıtı için yapılandırma seçenekleri. Düz metin veya yapılandırılmış JSON verileri olabilir.	Hayı
└─ biçimi	OpenAI.ResponseTextFormatConfiguration		Hayı
└─ araç seçimi	OpenAI.ToolChoiceOptions veya OpenAI.ToolChoiceObject	Modelin yanıt oluştururken kullanılacak aracı (veya araçları) seçmesi gerekir. Modelin hangi araçları çağırabileceğini belirtmek için tools parametresine bakın.	Hayı
└─ araçları	dizi	Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Parametresini ayarlayarak tool_choice hangi aracın kullanılacağını belirtebilirsiniz. Modeli sağlayabileceğiniz iki araç kategorisi şunlardır: - Yerleşik araçlar: OpenAI tarafından sağlanan ve modelin özelliklerini genişleten araçlar.	Hayı
└─ top_logprobs	tamsayı	Her biri ilişkili günlük olasılığına sahip her belirteç konumunda döndürülecek en olası belirteç sayısını belirten 0 ile 20 arasında bir tamsayı.	Hayı
└─ top_p	Numara	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ı
└─ kısaltma	enum	Model yanıtı için kullanılacak kesme stratejisi. - auto: Bu yanıtın bağlamı ve öncekiler modelin bağlam penceresi boyutunu aşarsa, model konuşmanın ortasına giriş öğelerini bırakarak yanıtı bağlam penceresine uyacak şekilde kesecektir. - disabled (varsayılan): Model yanıtı bir modelin bağlam penceresi boyutunu aşarsa istek 400 hatasıyla başarısız olur. Olası değerler: auto, disabled	Hayı
└─ kullanımı	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.	Hayı
└─ kullanıcı	String	OpenAI'nin kötüye kullanımı izlemesine ve algılamasına yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı.	Hayı
type	enum	Olayın türü. Her zaman response.completed. Olası değerler: response.completed	Evet

OpenAI.ResponseContentPartAddedEvent

Yeni bir içerik bölümü eklendiğinde gönderilir.

İsim	Türü	Description	Gerekli	Varsayılan
content_index	tamsayı	Eklenen içerik bölümünün dizini.	Evet
item_id	String	İçerik bölümünün eklendiği çıkış öğesinin kimliği.	Evet
output_index	tamsayı	İçerik bölümünün eklendiği çıkış öğesinin dizini.	Evet
parça	nesne		Evet
└─ türü	OpenAI.ItemContentType	Çok modlu giriş ve çıkış içeriği.	Hayı
type	enum	Olayın türü. Her zaman response.content_part.added. Olası değerler: response.content_part.added	Evet

OpenAI.ResponseContentPartDoneEvent

İçerik bölümü tamamlandığında gönderilir.

İsim	Türü	Description	Gerekli	Varsayılan
content_index	tamsayı	Tamamlanan içerik bölümünün dizini.	Evet
item_id	String	İçerik bölümünün eklendiği çıkış öğesinin kimliği.	Evet
output_index	tamsayı	İçerik bölümünün eklendiği çıkış öğesinin dizini.	Evet
parça	nesne		Evet
└─ türü	OpenAI.ItemContentType	Çok modlu giriş ve çıkış içeriği.	Hayı
type	enum	Olayın türü. Her zaman response.content_part.done. Olası değerler: response.content_part.done	Evet

OpenAI.ResponseCreatedEvent

Bir yanıt oluşturulduğunda yayılan bir olay.

İsim	Türü	Description	Gerekli	Varsayılan
yanıt	nesne		Evet
└─ arka plan	Boolean	Model yanıtının arka planda çalıştırılıp çalıştırılmayacağı.	Hayı	Yanlış
└─ oluşturulma_tarihi	tamsayı	Bu Yanıtın oluşturulduğu unix zaman damgası (saniye).	Hayı
└─ hata	OpenAI.ResponseError	Model yanıt oluşturamadığında döndürülen bir hata nesnesi.	Hayı
└─ kimlik	String	Bu Yanıt için benzersiz tanımlayıcı.	Hayı
└─ eksik_bilgiler	nesne	Yanıtın neden eksik olduğuna ilişkin ayrıntılar.	Hayı
└─ neden	enum	Yanıtın tamamlanmamış olmasının nedeni. Olası değerler: max_output_tokens, content_filter	Hayı
└─ yönerge	dize veya dizi	Modelin bağlamı içine eklenen bir sistem (veya geliştirici) iletisi. ile previous_response_idbirlikte kullanıldığında, önceki yanıttan alınan yönergeler sonraki yanıta taşınmaz. Bu, sistem (veya geliştirici) iletilerini yeni yanıtlarda değiştirme işlemini basitleştirir.	Hayı
└─ maksimum_çıkış_jetonları	tamsayı	Görünür çıkış belirteçleri ve muhakeme belirteçleri de dahil olmak üzere yanıt için oluşturulabilecek belirteç sayısı için üst sınır	Hayı
└─ maksimum araç çağrıları	tamsayı	Bir yanıtta işlenebilen yerleşik araçlara yapılan toplam çağrı sayısı üst sınırı. Bu maksimum sayı, tek tek araç başına değil, tüm yerleşik araç çağrıları için geçerlidir. Model tarafından bir aracı çağırmaya yönelik diğer girişimler yoksayılır.	Hayı
└─ meta veriler	nesne	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, 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.	Hayı
└─ nesne	enum	Bu kaynağın nesne türü - her zaman response olarak ayarlanır. Olası değerler: response	Hayı
└─ çıkış	dizi	Model tarafından oluşturulan içerik öğeleri dizisi. - Dizideki output öğelerin uzunluğu ve sırası modelin yanıtına bağlıdır. - Dizideki output ilk öğeye erişmek ve bunun model tarafından oluşturulan içeriğe sahip bir assistant ileti olduğunu varsaymak yerine SDK'larda desteklenen özelliğini kullanmayı output_text düşünebilirsiniz.	Hayı
└─ çıktı_metin	String	SDK özellikli yalnızca kolaylık sağlayan bir özellik olan, varsa dizideki tüm output_text öğelerinin metin çıktılarını bir araya getiren output içeren özellik. Python ve JavaScript SDK'larında desteklenir.	Hayı
└─ paralel_arac_cagrilari	Boolean	Modelin araç çağrılarını paralel olarak çalıştırmasına izin verilip verilmeyeceği.	Hayı	Doğru
└─ önceki_cevap_id	String	Modele önceki yanıtın benzersiz kimliği. Çok aşamalı konuşmalar oluşturmak için bunu kullanın.	Hayı
└─ istemi	OpenAI.Prompt	bir istem şablonuna ve değişkenlerine başvuru.	Hayı
└─ akıl yürütme	OpenAI.Reasoning	yalnızca o serisi modeller Mantık modelleri için yapılandırma seçenekleri.	Hayı
└─ durumu	enum	Yanıt oluşturma durumu. , , completed' lerden failedbiri in_progress, cancelled, queued veya incomplete. Olası değerler: completed, failed, in_progress, cancelled, , queued, incomplete	Hayı
└─ sıcaklık	Numara	0 ile 2 arasında hangi örnekleme sıcaklığının kullanılacağı. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir. Genellikle bunu değiştirmenizi öneririz top_p ancak ikisini birden değiştirmemenizi öneririz.	Hayı
└─ metin	nesne	Modelden metin yanıtı için yapılandırma seçenekleri. Düz metin veya yapılandırılmış JSON verileri olabilir.	Hayı
└─ biçimi	OpenAI.ResponseTextFormatConfiguration		Hayı
└─ araç seçimi	OpenAI.ToolChoiceOptions veya OpenAI.ToolChoiceObject	Modelin yanıt oluştururken kullanılacak aracı (veya araçları) seçmesi gerekir. Modelin hangi araçları çağırabileceğini belirtmek için tools parametresine bakın.	Hayı
└─ araçları	dizi	Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Parametresini ayarlayarak tool_choice hangi aracın kullanılacağını belirtebilirsiniz. Modeli sağlayabileceğiniz iki araç kategorisi şunlardır: - Yerleşik araçlar: OpenAI tarafından sağlanan ve modelin özelliklerini genişleten araçlar.	Hayı
└─ top_logprobs	tamsayı	Her biri ilişkili günlük olasılığına sahip her belirteç konumunda döndürülecek en olası belirteç sayısını belirten 0 ile 20 arasında bir tamsayı.	Hayı
└─ top_p	Numara	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ı
└─ kısaltma	enum	Model yanıtı için kullanılacak kesme stratejisi. - auto: Bu yanıtın bağlamı ve öncekiler modelin bağlam penceresi boyutunu aşarsa, model konuşmanın ortasına giriş öğelerini bırakarak yanıtı bağlam penceresine uyacak şekilde kesecektir. - disabled (varsayılan): Model yanıtı bir modelin bağlam penceresi boyutunu aşarsa istek 400 hatasıyla başarısız olur. Olası değerler: auto, disabled	Hayı
└─ kullanımı	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.	Hayı
└─ kullanıcı	String	OpenAI'nin kötüye kullanımı izlemesine ve algılamasına yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı.	Hayı
type	enum	Olayın türü. Her zaman response.created. Olası değerler: response.created	Evet

OpenAI.ResponseError

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

İsim	Türü	Description	Gerekli	Varsayılan
kod	OpenAI.ResponseErrorCode	Yanıtın hata kodu.	Evet
mesaj	String	Hatanın insan tarafından okunabilen açıklaması.	Evet

OpenAI.ResponseErrorCode

Yanıtın hata kodu.

Mülkiyet	Değer
Açıklama	Yanıtın hata kodu.
Türü	String
Değerler	server_error rate_limit_exceeded invalid_prompt vector_store_timeout invalid_image invalid_image_format invalid_base64_image invalid_image_url image_too_large image_too_small image_parse_error image_content_policy_violation invalid_image_mode image_file_too_large unsupported_image_media_type empty_image_file failed_to_download_image image_file_not_found

OpenAI.ResponseErrorEvent

Bir hata oluştuğunda yayılır.

İsim	Türü	Description	Gerekli	Varsayılan
kod	String	Hata kodu.	Evet
mesaj	String	Hata iletisi.	Evet
param	String	Hata parametresi.	Evet
type	enum	Olayın türü. Her zaman error. Olası değerler: error	Evet

OpenAI.ResponseFailedEvent

Yanıt başarısız olduğunda yayılan bir olay.

İsim	Türü	Description	Gerekli	Varsayılan
yanıt	nesne		Evet
└─ arka plan	Boolean	Model yanıtının arka planda çalıştırılıp çalıştırılmayacağı.	Hayı	Yanlış
└─ oluşturulma_tarihi	tamsayı	Bu Yanıtın oluşturulduğu unix zaman damgası (saniye).	Hayı
└─ hata	OpenAI.ResponseError	Model yanıt oluşturamadığında döndürülen bir hata nesnesi.	Hayı
└─ kimlik	String	Bu Yanıt için benzersiz tanımlayıcı.	Hayı
└─ eksik_bilgiler	nesne	Yanıtın neden eksik olduğuna ilişkin ayrıntılar.	Hayı
└─ neden	enum	Yanıtın tamamlanmamış olmasının nedeni. Olası değerler: max_output_tokens, content_filter	Hayı
└─ yönerge	dize veya dizi	Modelin bağlamı içine eklenen bir sistem (veya geliştirici) iletisi. ile previous_response_idbirlikte kullanıldığında, önceki yanıttan alınan yönergeler sonraki yanıta taşınmaz. Bu, sistem (veya geliştirici) iletilerini yeni yanıtlarda değiştirme işlemini basitleştirir.	Hayı
└─ maksimum_çıkış_jetonları	tamsayı	Görünür çıkış belirteçleri ve muhakeme belirteçleri de dahil olmak üzere yanıt için oluşturulabilecek belirteç sayısı için üst sınır	Hayı
└─ maksimum araç çağrıları	tamsayı	Bir yanıtta işlenebilen yerleşik araçlara yapılan toplam çağrı sayısı üst sınırı. Bu maksimum sayı, tek tek araç başına değil, tüm yerleşik araç çağrıları için geçerlidir. Model tarafından bir aracı çağırmaya yönelik diğer girişimler yoksayılır.	Hayı
└─ meta veriler	nesne	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, 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.	Hayı
└─ nesne	enum	Bu kaynağın nesne türü - her zaman response olarak ayarlanır. Olası değerler: response	Hayı
└─ çıkış	dizi	Model tarafından oluşturulan içerik öğeleri dizisi. - Dizideki output öğelerin uzunluğu ve sırası modelin yanıtına bağlıdır. - Dizideki output ilk öğeye erişmek ve bunun model tarafından oluşturulan içeriğe sahip bir assistant ileti olduğunu varsaymak yerine SDK'larda desteklenen özelliğini kullanmayı output_text düşünebilirsiniz.	Hayı
└─ çıktı_metin	String	SDK özellikli yalnızca kolaylık sağlayan bir özellik olan, varsa dizideki tüm output_text öğelerinin metin çıktılarını bir araya getiren output içeren özellik. Python ve JavaScript SDK'larında desteklenir.	Hayı
└─ paralel_arac_cagrilari	Boolean	Modelin araç çağrılarını paralel olarak çalıştırmasına izin verilip verilmeyeceği.	Hayı	Doğru
└─ önceki_cevap_id	String	Modele önceki yanıtın benzersiz kimliği. Çok aşamalı konuşmalar oluşturmak için bunu kullanın.	Hayı
└─ istemi	OpenAI.Prompt	bir istem şablonuna ve değişkenlerine başvuru.	Hayı
└─ akıl yürütme	OpenAI.Reasoning	yalnızca o serisi modeller Mantık modelleri için yapılandırma seçenekleri.	Hayı
└─ durumu	enum	Yanıt oluşturma durumu. completed, failed, in_progress, cancelled, queued veya incomplete. Olası değerler: completed, failed, in_progress, cancelled, , queued, incomplete	Hayı
└─ sıcaklık	Numara	0 ile 2 arasında hangi örnekleme sıcaklığının kullanılacağı. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir. Genellikle bunu değiştirmenizi öneririz top_p ancak ikisini birden değiştirmemenizi öneririz.	Hayı
└─ metin	nesne	Modelden metin yanıtı için yapılandırma seçenekleri. Düz metin veya yapılandırılmış JSON verileri olabilir.	Hayı
└─ biçimi	OpenAI.ResponseTextFormatConfiguration		Hayı
└─ araç seçimi	OpenAI.ToolChoiceOptions veya OpenAI.ToolChoiceObject	Modelin yanıt oluştururken kullanılacak aracı (veya araçları) seçmesi gerekir. Modelin hangi araçları çağırabileceğini belirtmek için tools parametresine bakın.	Hayı
└─ araçları	dizi	Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Parametresini ayarlayarak tool_choice hangi aracın kullanılacağını belirtebilirsiniz. Modeli sağlayabileceğiniz iki araç kategorisi şunlardır: - Yerleşik araçlar: OpenAI tarafından sağlanan ve modelin özelliklerini genişleten araçlar.	Hayı
└─ top_logprobs	tamsayı	Her biri ilişkili günlük olasılığına sahip her belirteç konumunda döndürülecek en olası belirteç sayısını belirten 0 ile 20 arasında bir tamsayı.	Hayı
└─ top_p	Numara	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ı
└─ kısaltma	enum	Model yanıtı için kullanılacak kesme stratejisi. - auto: Bu yanıtın bağlamı ve öncekiler modelin bağlam penceresi boyutunu aşarsa, model konuşmanın ortasına giriş öğelerini bırakarak yanıtı bağlam penceresine uyacak şekilde kesecektir. - disabled (varsayılan): Model yanıtı bir modelin bağlam penceresi boyutunu aşarsa istek 400 hatasıyla başarısız olur. Olası değerler: auto, disabled	Hayı
└─ kullanımı	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.	Hayı
└─ kullanıcı	String	OpenAI'nin kötüye kullanımı izlemesine ve algılamasına yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı.	Hayı
type	enum	Olayın türü. Her zaman response.failed. Olası değerler: response.failed	Evet

OpenAI.ResponseFileSearchCallCompletedEvent

Bir dosya arama çağrısı tamamlandığında (sonuçlar bulundu) yayılır.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	Dosya arama çağrısının başlatıldığı çıkış öğesinin kimliği.	Evet
output_index	tamsayı	Dosya arama çağrısının başlatıldığı çıkış öğesinin dizini.	Evet
type	enum	Olayın türü. Her zaman response.file_search_call.completed. Olası değerler: response.file_search_call.completed	Evet

OpenAI.ResponseFileSearchCallInProgressEvent

Bir dosya arama çağrısı başlatıldığında gönderilir.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	Dosya arama çağrısının başlatıldığı çıkış öğesinin kimliği.	Evet
output_index	tamsayı	Dosya arama çağrısının başlatıldığı çıkış öğesinin dizini.	Evet
type	enum	Olayın türü. Her zaman response.file_search_call.in_progress. Olası değerler: response.file_search_call.in_progress	Evet

OpenAI.ResponseFileSearchCallSearchingEvent

Bir dosya araması sırasında arama yapıldığında tetiklenir.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	Dosya arama çağrısının başlatıldığı çıkış öğesinin kimliği.	Evet
output_index	tamsayı	Dosya arama çağrısının arama yaptığı çıkış öğesinin dizini.	Evet
type	enum	Olayın türü. Her zaman response.file_search_call.searching. Olası değerler: response.file_search_call.searching	Evet

OpenAI.ResponseFormat

OpenAI.ResponseFormat için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
text	OpenAI.ResponseFormatText
json_object	OpenAI.ResponseFormatJsonObject
json_schema	OpenAI.ResponseFormatJsonSchema

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olası değerler: text, json_object, json_schema	Evet

OpenAI.ResponseFormatJsonObject

JSON nesne yanıt biçimi. JSON yanıtları oluşturmanın eski bir yöntemi. Bunu destekleyen modeller için kullanılması json_schema önerilir. Modelin bir sistem veya kullanıcı iletisi olmadan JSON oluşturmayacağını unutmayın.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Tanımlanan yanıt biçiminin türü. Her zaman json_object. Olası değerler: json_object	Evet

OpenAI.ResponseFormatJsonSchema

JSON Şeması yanıt biçimi. Yapılandırılmış JSON yanıtları oluşturmak için kullanılır.

İsim	Türü	Description	Gerekli	Varsayılan
json şeması	nesne	Bir JSON Şeması da dahil olmak üzere Yapılandırılmış Çıkışlar yapılandırma seçenekleri.	Evet
└─ açıklama	String	Yanıt formatının amacına ilişkin bir açıklama, modelin bu formatta nasıl yanıt vereceğini belirlemesi için kullanılır.	Hayı
└─ ad	String	Yanıt biçiminin adı. En fazla uzunluğu 64 olan a-z, A-Z, 0-9 veya alt çizgi ve kısa çizgi içermelidir.	Hayı
└─ ş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ı	Boolean	Çıktı oluşturulurken sıkı şemaya bağlı kalınmasının etkinleştirilip etkinleştirilmeyileceği. True olarak ayarlanırsa, model her zaman alanda tanımlanan tam şemayı schema izler. strict trueolduğunda yalnızca bir JSON Şeması alt kümesi desteklenir.	Hayı	Yanlış
type	enum	Tanımlanan yanıt biçiminin türü. Her zaman json_schema. Olası değerler: json_schema	Evet

OpenAI.CevapFormatJsonŞemaŞeması

JSON Şeması nesnesi olarak tanımlanan yanıt biçimi şeması. JSON şemaları oluşturmayı buradan öğrenin.

Tür: nesne

OpenAI.ResponseFormatText

Varsayılan yanıt biçimi. Metin yanıtları oluşturmak için kullanılır.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Tanımlanan yanıt biçiminin türü. Her zaman text. Olası değerler: text	Evet

OpenAI.ResponseFunctionCallArgumentsDeltaEvent

Kısmi işlev çağrısı bağımsız değişkenleri delta olduğunda yayılır.

İsim	Türü	Description	Gerekli	Varsayılan
delta	String	Fonksiyon çağrısı argümanlarına eklenen delta.	Evet
item_id	String	delta işlev çağrısı bağımsız değişkenlerinin eklendiği çıkış öğesinin kimliği.	Evet
output_index	tamsayı	İşlev çağrısı bağımsız değişkenlerinin delta'sının toplandığı çıkış öğesinin dizini.	Evet
type	enum	Olayın türü. Her zaman response.function_call_arguments.delta. Olası değerler: response.function_call_arguments.delta	Evet

OpenAI.ResponseFunctionCallArgumentsDoneEvent

İşlev çağrısı bağımsız değişkenleri sonlandırıldığında verilir.

İsim	Türü	Description	Gerekli	Varsayılan
arguments	String	İşlev çağrısı için argümanlar.	Evet
item_id	String	Öğenin kimliği.	Evet
output_index	tamsayı	Çıkış öğesinin dizini.	Evet
type	enum	Olası değerler: response.function_call_arguments.done	Evet

OpenAI.ResponseImageGenCallCompletedEvent

Görüntü oluşturma aracı çağrısı tamamlandığında ve son görüntü kullanılabilir olduğunda yayılır.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	İşlenmekte olan görüntü oluşturma öğesinin benzersiz tanımlayıcısı.	Evet
output_index	tamsayı	Yanıtın çıkış dizisindeki çıkış öğesinin dizini.	Evet
type	enum	Olayın türü. Her zaman 'response.image_generation_call.completed' şeklinde. Olası değerler: response.image_generation_call.completed	Evet

OpenAI.ResponseImageGenCallGeneratingEvent

Görüntü oluşturma aracı çağrısı (ara durum) etkin bir şekilde görüntü oluştururken tetiklenir.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	İşlenmekte olan görüntü oluşturma öğesinin benzersiz tanımlayıcısı.	Evet
output_index	tamsayı	Yanıtın çıkış dizisindeki çıkış öğesinin dizini.	Evet
type	enum	Olayın türü. Her zaman 'response.image_generation_call.generating'. Olası değerler: response.image_generation_call.generating	Evet

OpenAI.ResponseImageGenCallInProgressEvent

Görüntü oluşturma aracı çağrısı devam ederken bir bildirim gönderilir.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	İşlenmekte olan görüntü oluşturma öğesinin benzersiz tanımlayıcısı.	Evet
output_index	tamsayı	Yanıtın çıkış dizisindeki çıkış öğesinin dizini.	Evet
type	enum	Olayın türü. Her zaman 'response.image_generation_call.in_progress'. Olası değerler: response.image_generation_call.in_progress	Evet

OpenAI.ResponseImageGenCallPartialImageEvent

Görüntü oluşturma akışı sırasında kısmi bir görüntü kullanılabilir olduğunda emit edilir.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	İşlenmekte olan görüntü oluşturma öğesinin benzersiz tanımlayıcısı.	Evet
output_index	tamsayı	Yanıtın çıkış dizisindeki çıkış öğesinin dizini.	Evet
partial_image_b64	String	Base64 ile kodlanmış kısmi görüntü verileri, görüntü olarak işleme için uygundur.	Evet
partial_image_index	tamsayı	Kısmi görüntü için 0 tabanlı dizin (arka uç 1 tabanlıdır, ancak bu kullanıcı için 0 tabanlıdır).	Evet
type	enum	Olayın türü. Her zaman 'response.image_generation_call.partial_image'. Olası değerler: response.image_generation_call.partial_image	Evet

OpenAI.ResponseInProgressEvent

Yanıt devam ederken gönderilir.

İsim	Türü	Description	Gerekli	Varsayılan
yanıt	nesne		Evet
└─ arka plan	Boolean	Model yanıtının arka planda çalıştırılıp çalıştırılmayacağı.	Hayı	Yanlış
└─ oluşturulma_tarihi	tamsayı	Bu Yanıtın oluşturulduğu unix zaman damgası (saniye).	Hayı
└─ hata	OpenAI.ResponseError	Model yanıt oluşturamadığında döndürülen bir hata nesnesi.	Hayı
└─ kimlik	String	Bu Yanıt için benzersiz tanımlayıcı.	Hayı
└─ eksik_bilgiler	nesne	Yanıtın neden eksik olduğuna ilişkin ayrıntılar.	Hayı
└─ neden	enum	Yanıtın tamamlanmamış olmasının nedeni. Olası değerler: max_output_tokens, content_filter	Hayı
└─ yönerge	dize veya dizi	Modelin bağlamı içine eklenen bir sistem (veya geliştirici) iletisi. ile previous_response_idbirlikte kullanıldığında, önceki yanıttan alınan yönergeler sonraki yanıta taşınmaz. Bu, sistem (veya geliştirici) iletilerini yeni yanıtlarda değiştirme işlemini basitleştirir.	Hayı
└─ maksimum_çıkış_jetonları	tamsayı	Görünür çıkış belirteçleri ve muhakeme belirteçleri de dahil olmak üzere yanıt için oluşturulabilecek belirteç sayısı için üst sınır	Hayı
└─ maksimum araç çağrıları	tamsayı	Bir yanıtta işlenebilen yerleşik araçlara yapılan toplam çağrı sayısı üst sınırı. Bu maksimum sayı, tek tek araç başına değil, tüm yerleşik araç çağrıları için geçerlidir. Model tarafından bir aracı çağırmaya yönelik diğer girişimler yoksayılır.	Hayı
└─ meta veriler	nesne	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, 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.	Hayı
└─ nesne	enum	Bu kaynağın nesne türü - her zaman response olarak ayarlanır. Olası değerler: response	Hayı
└─ çıkış	dizi	Model tarafından oluşturulan içerik öğeleri dizisi. - Dizideki output öğelerin uzunluğu ve sırası modelin yanıtına bağlıdır. - Dizideki output ilk öğeye erişmek ve bunun model tarafından oluşturulan içeriğe sahip bir assistant ileti olduğunu varsaymak yerine SDK'larda desteklenen özelliğini kullanmayı output_text düşünebilirsiniz.	Hayı
└─ çıktı_metin	String	SDK özellikli yalnızca kolaylık sağlayan bir özellik olan, varsa dizideki tüm output_text öğelerinin metin çıktılarını bir araya getiren output içeren özellik. Python ve JavaScript SDK'larında desteklenir.	Hayı
└─ paralel_arac_cagrilari	Boolean	Modelin araç çağrılarını paralel olarak çalıştırmasına izin verilip verilmeyeceği.	Hayı	Doğru
└─ önceki_cevap_id	String	Modele önceki yanıtın benzersiz kimliği. Çok aşamalı konuşmalar oluşturmak için bunu kullanın.	Hayı
└─ istemi	OpenAI.Prompt	bir istem şablonuna ve değişkenlerine başvuru.	Hayı
└─ akıl yürütme	OpenAI.Reasoning	yalnızca o serisi modeller Mantık modelleri için yapılandırma seçenekleri.	Hayı
└─ durumu	enum	Yanıt oluşturma durumu. completed, failed, in_progress, cancelled, queued veya incomplete. Olası değerler: completed, failed, in_progress, cancelled, , queued, incomplete	Hayı
└─ sıcaklık	Numara	0 ile 2 arasında hangi örnekleme sıcaklığının kullanılacağı. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir. Genellikle bunu değiştirmenizi öneririz top_p ancak ikisini birden değiştirmemenizi öneririz.	Hayı
└─ metin	nesne	Modelden metin yanıtı için yapılandırma seçenekleri. Düz metin veya yapılandırılmış JSON verileri olabilir.	Hayı
└─ biçimi	OpenAI.ResponseTextFormatConfiguration		Hayı
└─ araç seçimi	OpenAI.ToolChoiceOptions veya OpenAI.ToolChoiceObject	Modelin yanıt oluştururken kullanılacak aracı (veya araçları) seçmesi gerekir. Modelin hangi araçları çağırabileceğini belirtmek için tools parametresine bakın.	Hayı
└─ araçları	dizi	Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Parametresini ayarlayarak tool_choice hangi aracın kullanılacağını belirtebilirsiniz. Modeli sağlayabileceğiniz iki araç kategorisi şunlardır: - Yerleşik araçlar: OpenAI tarafından sağlanan ve modelin özelliklerini genişleten araçlar.	Hayı
└─ top_logprobs	tamsayı	Her biri ilişkili günlük olasılığına sahip her belirteç konumunda döndürülecek en olası belirteç sayısını belirten 0 ile 20 arasında bir tamsayı.	Hayı
└─ top_p	Numara	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ı
└─ kısaltma	enum	Model yanıtı için kullanılacak kesme stratejisi. - auto: Bu yanıtın bağlamı ve öncekiler modelin bağlam penceresi boyutunu aşarsa, model konuşmanın ortasına giriş öğelerini bırakarak yanıtı bağlam penceresine uyacak şekilde kesecektir. - disabled (varsayılan): Model yanıtı bir modelin bağlam penceresi boyutunu aşarsa istek 400 hatasıyla başarısız olur. Olası değerler: auto, disabled	Hayı
└─ kullanımı	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.	Hayı
└─ kullanıcı	String	OpenAI'nin kötüye kullanımı izlemesine ve algılamasına yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı.	Hayı
type	enum	Olayın türü. Her zaman response.in_progress. Olası değerler: response.in_progress	Evet

OpenAI.ResponseIncompleteEvent

Yanıt eksik olduğunda yayılan bir olay.

İsim	Türü	Description	Gerekli	Varsayılan
yanıt	nesne		Evet
└─ arka plan	Boolean	Model yanıtının arka planda çalıştırılıp çalıştırılmayacağı.	Hayı	Yanlış
└─ oluşturulma_tarihi	tamsayı	Bu Yanıtın oluşturulduğu unix zaman damgası (saniye).	Hayı
└─ hata	OpenAI.ResponseError	Model yanıt oluşturamadığında döndürülen bir hata nesnesi.	Hayı
└─ kimlik	String	Bu Yanıt için benzersiz tanımlayıcı.	Hayı
└─ eksik_bilgiler	nesne	Yanıtın neden eksik olduğuna ilişkin ayrıntılar.	Hayı
└─ neden	enum	Yanıtın tamamlanmamış olmasının nedeni. Olası değerler: max_output_tokens, content_filter	Hayı
└─ yönerge	dize veya dizi	Modelin bağlamı içine eklenen bir sistem (veya geliştirici) iletisi. ile previous_response_idbirlikte kullanıldığında, önceki yanıttan alınan yönergeler sonraki yanıta taşınmaz. Bu, sistem (veya geliştirici) iletilerini yeni yanıtlarda değiştirme işlemini basitleştirir.	Hayı
└─ maksimum_çıkış_jetonları	tamsayı	Görünür çıkış belirteçleri ve muhakeme belirteçleri de dahil olmak üzere yanıt için oluşturulabilecek belirteç sayısı için üst sınır	Hayı
└─ maksimum araç çağrıları	tamsayı	Bir yanıtta işlenebilen yerleşik araçlara yapılan toplam çağrı sayısı üst sınırı. Bu maksimum sayı, tek tek araç başına değil, tüm yerleşik araç çağrıları için geçerlidir. Model tarafından bir aracı çağırmaya yönelik diğer girişimler yoksayılır.	Hayı
└─ meta veriler	nesne	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, 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.	Hayı
└─ nesne	enum	Bu kaynağın nesne türü - her zaman response olarak ayarlanır. Olası değerler: response	Hayı
└─ çıkış	dizi	Model tarafından oluşturulan içerik öğeleri dizisi. - Dizideki output öğelerin uzunluğu ve sırası modelin yanıtına bağlıdır. - Dizideki output ilk öğeye erişmek ve bunun model tarafından oluşturulan içeriğe sahip bir assistant ileti olduğunu varsaymak yerine SDK'larda desteklenen özelliğini kullanmayı output_text düşünebilirsiniz.	Hayı
└─ çıktı_metin	String	SDK özellikli yalnızca kolaylık sağlayan bir özellik olan, varsa dizideki tüm output_text öğelerinin metin çıktılarını bir araya getiren output içeren özellik. Python ve JavaScript SDK'larında desteklenir.	Hayı
└─ paralel_arac_cagrilari	Boolean	Modelin araç çağrılarını paralel olarak çalıştırmasına izin verilip verilmeyeceği.	Hayı	Doğru
└─ önceki_cevap_id	String	Modele önceki yanıtın benzersiz kimliği. Çok aşamalı konuşmalar oluşturmak için bunu kullanın.	Hayı
└─ istemi	OpenAI.Prompt	bir istem şablonuna ve değişkenlerine başvuru.	Hayı
└─ akıl yürütme	OpenAI.Reasoning	yalnızca o serisi modeller Mantık modelleri için yapılandırma seçenekleri.	Hayı
└─ durumu	enum	Yanıt oluşturma durumu. completed, failed, in_progress, cancelled, queued veya incomplete. Olası değerler: completed, failed, in_progress, cancelled, , queued, incomplete	Hayı
└─ sıcaklık	Numara	0 ile 2 arasında hangi örnekleme sıcaklığının kullanılacağı. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir. Genellikle bunu değiştirmenizi öneririz top_p ancak ikisini birden değiştirmemenizi öneririz.	Hayı
└─ metin	nesne	Modelden metin yanıtı için yapılandırma seçenekleri. Düz metin veya yapılandırılmış JSON verileri olabilir.	Hayı
└─ biçimi	OpenAI.ResponseTextFormatConfiguration		Hayı
└─ araç seçimi	OpenAI.ToolChoiceOptions veya OpenAI.ToolChoiceObject	Modelin yanıt oluştururken kullanılacak aracı (veya araçları) seçmesi gerekir. Modelin hangi araçları çağırabileceğini belirtmek için tools parametresine bakın.	Hayı
└─ araçları	dizi	Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Parametresini ayarlayarak tool_choice hangi aracın kullanılacağını belirtebilirsiniz. Modeli sağlayabileceğiniz iki araç kategorisi şunlardır: - Yerleşik araçlar: OpenAI tarafından sağlanan ve modelin özelliklerini genişleten araçlar.	Hayı
└─ top_logprobs	tamsayı	Her biri ilişkili günlük olasılığına sahip her belirteç konumunda döndürülecek en olası belirteç sayısını belirten 0 ile 20 arasında bir tamsayı.	Hayı
└─ top_p	Numara	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ı
└─ kısaltma	enum	Model yanıtı için kullanılacak kesme stratejisi. - auto: Bu yanıtın bağlamı ve öncekiler modelin bağlam penceresi boyutunu aşarsa, model konuşmanın ortasına giriş öğelerini bırakarak yanıtı bağlam penceresine uyacak şekilde kesecektir. - disabled (varsayılan): Model yanıtı bir modelin bağlam penceresi boyutunu aşarsa istek 400 hatasıyla başarısız olur. Olası değerler: auto, disabled	Hayı
└─ kullanımı	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.	Hayı
└─ kullanıcı	String	OpenAI'nin kötüye kullanımı izlemesine ve algılamasına yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı.	Hayı
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	Varsayılan
veriler	dizi	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.ResponseMCPCallArgumentsDeltaEvent

MCP araç çağrısının bağımsız değişkenlerinde delta (kısmi güncelleştirme) olduğunda gerçekleşir.

İsim	Türü	Description	Gerekli	Varsayılan
delta		MCP aracı çağrısı için bağımsız değişkenlerin kısmî güncelleştirmesi.	Evet
item_id	String	İşlenen MCP aracı çağrı öğesinin benzersiz tanımlayıcısı.	Evet
output_index	tamsayı	Yanıtın çıkış dizisindeki çıkış öğesinin dizini.	Evet
type	enum	Olayın türü. Her zaman 'response.mcp_call.arguments_delta'. Olası değerler: response.mcp_call.arguments_delta	Evet

OpenAI.ResponseMCPCallArgumentsDoneEvent

Bir MCP araç çağrısı için bağımsız değişkenler sonlandırıldığında oluşur.

İsim	Türü	Description	Gerekli	Varsayılan
arguments		MCP araç çağrısı için son haline getirilmiş bağımsız değişkenler.	Evet
item_id	String	İşlenen MCP aracı çağrı öğesinin benzersiz tanımlayıcısı.	Evet
output_index	tamsayı	Yanıtın çıkış dizisindeki çıkış öğesinin dizini.	Evet
type	enum	Olayın türü. Her zaman 'response.mcp_call.arguments_done'. Olası değerler: response.mcp_call.arguments_done	Evet

OpenAI.ResponseMCPCallCompletedEvent

BIR MCP araç çağrısı başarıyla tamamlandığında yayılır.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olayın türü. Her zaman 'response.mcp_call.completed'. Olası değerler: response.mcp_call.completed	Evet

OpenAI.ResponseMCPCallFailedEvent

Bir MCP aracı çağrısının başarısız olması durumunda yayımlanır.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olayın türü. 'sonuç her zaman 'response.mcp_call.failed' olur. Olası değerler: response.mcp_call.failed	Evet

OpenAI.ResponseMCPCallInProgressEvent

Bir MCP araç çağrısı devam ederken tetiklenir.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	İşlenen MCP aracı çağrı öğesinin benzersiz tanımlayıcısı.	Evet
output_index	tamsayı	Yanıtın çıkış dizisindeki çıkış öğesinin dizini.	Evet
type	enum	Olayın türü. Her zaman 'response.mcp_call.in_progress'. Olası değerler: response.mcp_call.in_progress	Evet

OpenAI.ResponseMCPListToolsCompletedEvent

Kullanılabilir MCP araçlarının listesi başarıyla alındığında tetiklenir.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olayın türü. Her zaman 'response.mcp_list_tools.completed'. Olası değerler: response.mcp_list_tools.completed	Evet

OpenAI.ResponseMCPListToolsFailedEvent

Kullanılabilir MCP araçlarını listeleme girişimi başarısız olduğunda ortaya çıkar.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olayın türü. Her zaman 'response.mcp_list_tools.başarısız'. Olası değerler: response.mcp_list_tools.failed	Evet

OpenAI.ResponseMCPListToolsInProgressEvent

Sistem, kullanılabilir MCP araçlarının listesini alırken tetiklenir.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olayın türü. Her zaman 'response.mcp_list_tools.in_progress'. Olası değerler: response.mcp_list_tools.in_progress	Evet

OpenAI.ResponseOutputItemAddedEvent

Yeni bir çıkış öğesi eklendiğinde gönderilir.

İsim	Türü	Description	Gerekli	Varsayılan
öğe	nesne	Yanıt oluşturmak için kullanılan içerik öğesi.	Evet
└─ kimlik	String		Hayı
└─ türü	OpenAI.ItemType		Hayı
output_index	tamsayı	Eklenen çıkış öğesinin dizini.	Evet
type	enum	Olayın türü. Her zaman response.output_item.added. Olası değerler: response.output_item.added	Evet

OpenAI.ResponseOutputItemDoneEvent

Çıktı öğesi tamamlandı olarak işaretlendiğinde yayılır.

İsim	Türü	Description	Gerekli	Varsayılan
öğe	nesne	Yanıt oluşturmak için kullanılan içerik öğesi.	Evet
└─ kimlik	String		Hayı
└─ türü	OpenAI.ItemType		Hayı
output_index	tamsayı	Bitti olarak işaretlenen çıkış öğesinin dizini.	Evet
type	enum	Olayın türü. Her zaman response.output_item.done. Olası değerler: response.output_item.done	Evet

OpenAI.ResponsePromptVariables

İsteminizde değişkenlerin yerine kullanılacak isteğe bağlı değer eşlemesi. Değiştirme değerleri dizeler veya görüntüler veya dosyalar gibi diğer Yanıt giriş türleri olabilir.

Tür: nesne

OpenAI.ResponseQueuedEvent

Bir yanıt kuyruğa alınıp işlenmeyi beklediğinde gönderilir.

İsim	Türü	Description	Gerekli	Varsayılan
yanıt	nesne		Evet
└─ arka plan	Boolean	Model yanıtının arka planda çalıştırılıp çalıştırılmayacağı.	Hayı	Yanlış
└─ oluşturulma_tarihi	tamsayı	Bu Yanıtın oluşturulduğu unix zaman damgası (saniye).	Hayı
└─ hata	OpenAI.ResponseError	Model yanıt oluşturamadığında döndürülen bir hata nesnesi.	Hayı
└─ kimlik	String	Bu Yanıt için benzersiz tanımlayıcı.	Hayı
└─ eksik_bilgiler	nesne	Yanıtın neden eksik olduğuna ilişkin ayrıntılar.	Hayı
└─ neden	enum	Yanıtın tamamlanmamış olmasının nedeni. Olası değerler: max_output_tokens, content_filter	Hayı
└─ yönerge	dize veya dizi	Modelin bağlamı içine eklenen bir sistem (veya geliştirici) iletisi. ile previous_response_idbirlikte kullanıldığında, önceki yanıttan alınan yönergeler sonraki yanıta taşınmaz. Bu, sistem (veya geliştirici) iletilerini yeni yanıtlarda değiştirme işlemini basitleştirir.	Hayı
└─ maksimum_çıkış_jetonları	tamsayı	Görünür çıkış belirteçleri ve muhakeme belirteçleri de dahil olmak üzere yanıt için oluşturulabilecek belirteç sayısı için üst sınır	Hayı
└─ maksimum araç çağrıları	tamsayı	Bir yanıtta işlenebilen yerleşik araçlara yapılan toplam çağrı sayısı üst sınırı. Bu maksimum sayı, tek tek araç başına değil, tüm yerleşik araç çağrıları için geçerlidir. Model tarafından bir aracı çağırmaya yönelik diğer girişimler yoksayılır.	Hayı
└─ meta veriler	nesne	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, 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.	Hayı
└─ nesne	enum	Bu kaynağın nesne türü - her zaman response olarak ayarlanır. Olası değerler: response	Hayı
└─ çıkış	dizi	Model tarafından oluşturulan içerik öğeleri dizisi. - Dizideki output öğelerin uzunluğu ve sırası modelin yanıtına bağlıdır. - Dizideki output ilk öğeye erişmek ve bunun model tarafından oluşturulan içeriğe sahip bir assistant ileti olduğunu varsaymak yerine SDK'larda desteklenen özelliğini kullanmayı output_text düşünebilirsiniz.	Hayı
└─ çıktı_metin	String	SDK özellikli yalnızca kolaylık sağlayan bir özellik olan, varsa dizideki tüm output_text öğelerinin metin çıktılarını bir araya getiren output içeren özellik. Python ve JavaScript SDK'larında desteklenir.	Hayı
└─ paralel_arac_cagrilari	Boolean	Modelin araç çağrılarını paralel olarak çalıştırmasına izin verilip verilmeyeceği.	Hayı	Doğru
└─ önceki_cevap_id	String	Modele önceki yanıtın benzersiz kimliği. Çok aşamalı konuşmalar oluşturmak için bunu kullanın.	Hayı
└─ istemi	OpenAI.Prompt	bir istem şablonuna ve değişkenlerine başvuru.	Hayı
└─ akıl yürütme	OpenAI.Reasoning	yalnızca o serisi modeller Mantık modelleri için yapılandırma seçenekleri.	Hayı
└─ durumu	enum	Yanıt oluşturma durumu. completed, failed, in_progress, cancelled, queued veya incomplete. Olası değerler: completed, failed, in_progress, cancelled, , queued, incomplete	Hayı
└─ sıcaklık	Numara	0 ile 2 arasında hangi örnekleme sıcaklığının kullanılacağı. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir. Genellikle bunu değiştirmenizi öneririz top_p ancak ikisini birden değiştirmemenizi öneririz.	Hayı
└─ metin	nesne	Modelden metin yanıtı için yapılandırma seçenekleri. Düz metin veya yapılandırılmış JSON verileri olabilir.	Hayı
└─ biçimi	OpenAI.ResponseTextFormatConfiguration		Hayı
└─ araç seçimi	OpenAI.ToolChoiceOptions veya OpenAI.ToolChoiceObject	Modelin yanıt oluştururken kullanılacak aracı (veya araçları) seçmesi gerekir. Modelin hangi araçları çağırabileceğini belirtmek için tools parametresine bakın.	Hayı
└─ araçları	dizi	Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Parametresini ayarlayarak tool_choice hangi aracın kullanılacağını belirtebilirsiniz. Modeli sağlayabileceğiniz iki araç kategorisi şunlardır: - Yerleşik araçlar: OpenAI tarafından sağlanan ve modelin özelliklerini genişleten araçlar.	Hayı
└─ top_logprobs	tamsayı	Her biri ilişkili günlük olasılığına sahip her belirteç konumunda döndürülecek en olası belirteç sayısını belirten 0 ile 20 arasında bir tamsayı.	Hayı
└─ top_p	Numara	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ı
└─ kısaltma	enum	Model yanıtı için kullanılacak kesme stratejisi. - auto: Bu yanıtın bağlamı ve öncekiler modelin bağlam penceresi boyutunu aşarsa, model konuşmanın ortasına giriş öğelerini bırakarak yanıtı bağlam penceresine uyacak şekilde kesecektir. - disabled (varsayılan): Model yanıtı bir modelin bağlam penceresi boyutunu aşarsa istek 400 hatasıyla başarısız olur. Olası değerler: auto, disabled	Hayı
└─ kullanımı	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.	Hayı
└─ kullanıcı	String	OpenAI'nin kötüye kullanımı izlemesine ve algılamasına yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı.	Hayı
type	enum	Olayın türü. Her zaman 'response.queued'. Olası değerler: response.queued	Evet

OpenAI.ResponseReasoningDeltaEvent

Muhakeme içeriğinde bir değişiklik (kısmi güncelleme) olduğunda sinyal yayılır.

İsim	Türü	Description	Gerekli	Varsayılan
content_index	tamsayı	Çıkış öğesi içindeki akıl yürütme içeriği bölümünün dizini.	Evet
delta		Gerekçe içeriğinin kısmi güncelleştirmesi.	Evet
item_id	String	Mantığın güncelleştirildiği öğenin benzersiz tanımlayıcısı.	Evet
output_index	tamsayı	Yanıtın çıkış dizisindeki çıkış öğesinin dizini.	Evet
type	enum	Olayın türü. Her zaman 'response.reasoning.delta'. Olası değerler: response.reasoning.delta	Evet

OpenAI.ResponseReasoningDoneEvent

Bir öğe için gerekçe oluşturma içeriği sonlandırıldığında gönderilir.

İsim	Türü	Description	Gerekli	Varsayılan
content_index	tamsayı	Çıkış öğesi içindeki akıl yürütme içeriği bölümünün dizini.	Evet
item_id	String	Mantığın kesinleştirildiği öğenin benzersiz tanımlayıcısı.	Evet
output_index	tamsayı	Yanıtın çıkış dizisindeki çıkış öğesinin dizini.	Evet
text	String	Son haline getirilmiş mantık metni.	Evet
type	enum	Olayın türü. Her zaman 'response.reasoning.done'. Olası değerler: response.reasoning.done	Evet

OpenAI.ResponseReasoningSummaryDeltaEvent

Muhakeme özeti içeriğinde bir değişiklik (kısmi güncelleme) olduğunda yayılır.

İsim	Türü	Description	Gerekli	Varsayılan
delta		Muhakeme özeti içeriğine yönelik kısmi güncelleştirme.	Evet
item_id	String	Gerekçe özetinin güncelleştirildiği öğenin benzersiz tanımlayıcısı.	Evet
output_index	tamsayı	Yanıtın çıkış dizisindeki çıkış öğesinin dizini.	Evet
summary_index	tamsayı	Çıkış öğesi içindeki özet bölümünün dizini.	Evet
type	enum	Olayın türü. Her zaman 'response.reasoning_summary.delta'. Olası değerler: response.reasoning_summary.delta	Evet

OpenAI.ResponseReasoningSummaryDoneEvent

Bir öğe için akıl yürütme özeti sonlandırıldığında yayınlanır.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	Gerekçe özetinin son haline getirildiği öğenin benzersiz tanımlayıcısı.	Evet
output_index	tamsayı	Yanıtın çıkış dizisindeki çıkış öğesinin dizini.	Evet
summary_index	tamsayı	Çıkış öğesi içindeki özet bölümünün dizini.	Evet
text	String	Son haline getirilmiş akıl yürütme özeti metni.	Evet
type	enum	Olayın türü. Her zaman 'response.reasoning_summary.bitti'. Olası değerler: response.reasoning_summary.done	Evet

OpenAI.ResponseReasoningSummaryPartAddedEvent

Yeni bir akıl yürütme özeti bölümü eklendiğinde yayımlanır.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	Bu özet bölümün ilişkili olduğu öğenin kimliği.	Evet
output_index	tamsayı	Bu özet bölümünün ilişkili olduğu çıkış öğesinin dizini.	Evet
parça	nesne		Evet
└─ türü	OpenAI.ReasoningItemSummaryPartType		Hayı
summary_index	tamsayı	Akıl yürütme özeti içindeki özet bölümünün dizini.	Evet
type	enum	Olayın türü. Her zaman response.reasoning_summary_part.added. Olası değerler: response.reasoning_summary_part.added	Evet

OpenAI.ResponseReasoningSummaryPartDoneEvent

Bir akıl yürütme özeti bölümü tamamlandığında gönderilir.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	Bu özet bölümün ilişkili olduğu öğenin kimliği.	Evet
output_index	tamsayı	Bu özet bölümünün ilişkili olduğu çıkış öğesinin dizini.	Evet
parça	nesne		Evet
└─ türü	OpenAI.ReasoningItemSummaryPartType		Hayı
summary_index	tamsayı	Akıl yürütme özeti içindeki özet bölümünün dizini.	Evet
type	enum	Olayın türü. Her zaman response.reasoning_summary_part.done. Olası değerler: response.reasoning_summary_part.done	Evet

OpenAI.ResponseReasoningSummaryTextDeltaEvent

Bir muhakeme özeti metnine delta eklendiğinde oluşur.

İsim	Türü	Description	Gerekli	Varsayılan
delta	String	Özete eklenen metin deltası.	Evet
item_id	String	Bu özet metin deltasının ilişkili olduğu öğenin kimliği.	Evet
output_index	tamsayı	Bu özet metin deltasının bağlı olduğu çıkış öğesinin dizini.	Evet
summary_index	tamsayı	Akıl yürütme özeti içindeki özet bölümünün dizini.	Evet
type	enum	Olayın türü. Her zaman response.reasoning_summary_text.delta. Olası değerler: response.reasoning_summary_text.delta	Evet

OpenAI.ResponseReasoningSummaryTextDoneEvent

Bir akıl yürütme özeti metni tamamlandığında yayılır.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	Bu özet metnin ilişkili olduğu öğenin kimliği.	Evet
output_index	tamsayı	Bu özet metnin ilişkili olduğu çıkış öğesinin dizini.	Evet
summary_index	tamsayı	Akıl yürütme özeti içindeki özet bölümünün dizini.	Evet
text	String	Tamamlanan akıl yürütme özetinin tam metni.	Evet
type	enum	Olayın türü. Her zaman response.reasoning_summary_text.done. Olası değerler: response.reasoning_summary_text.done	Evet

OpenAI.ResponseRefusalDeltaEvent

Kısmi bir reddetme metni olduğunda yayılır.

İsim	Türü	Description	Gerekli	Varsayılan
content_index	tamsayı	Reddetme metninin eklendiği içerik bölümünün dizini.	Evet
delta	String	Eklenen ret metni.	Evet
item_id	String	Reddetme metninin eklendiği çıkış öğesinin kimliği.	Evet
output_index	tamsayı	Reddetme metninin eklendiği çıkış öğesinin dizini.	Evet
type	enum	Olayın türü. Her zaman response.refusal.delta. Olası değerler: response.refusal.delta	Evet

OpenAI.ResponseRefusalDoneEvent

Reddeden metin sonlandırıldığında yayılır.

İsim	Türü	Description	Gerekli	Varsayılan
content_index	tamsayı	Red metni kesinleştiren içerik bölümünün dizini.	Evet
item_id	String	Sonlandırılan reddetme metninin ait olduğu çıkış öğesinin kimliği.	Evet
output_index	tamsayı	Reddetme metninin sonlandırıldığı çıkış öğesinin dizini.	Evet
Ret	String	Kesinleştirilen reddetme metni.	Evet
type	enum	Olayın türü. Her zaman response.refusal.done. Olası değerler: response.refusal.done	Evet

OpenAI.ResponseStreamEvent

OpenAI.ResponseStreamEvent için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
response.completed	OpenAI.ResponseCompletedEvent
response.content_part.added	OpenAI.ResponseContentPartAddedEvent
response.content_part.done	OpenAI.ResponseContentPartDoneEvent
response.created	OpenAI.ResponseCreatedEvent
error	OpenAI.ResponseErrorEvent
response.file_search_call.completed	OpenAI.ResponseFileSearchCallCompletedEvent
response.file_search_call.in_progress	OpenAI.ResponseFileSearchCallInProgressEvent
response.file_search_call.searching	OpenAI.ResponseFileSearchCallSearchingEvent
response.function_call_arguments.delta	OpenAI.ResponseFunctionCallArgumentsDeltaEvent
response.function_call_arguments.done	OpenAI.ResponseFunctionCallArgumentsDoneEvent
response.in_progress	OpenAI.ResponseInProgressEvent
response.failed	OpenAI.ResponseFailedEvent
response.incomplete	OpenAI.ResponseIncompleteEvent
response.output_item.added	OpenAI.ResponseOutputItemAddedEvent
response.output_item.done	OpenAI.ResponseOutputItemDoneEvent
response.refusal.delta	OpenAI.ResponseRefusalDeltaEvent
response.refusal.done	OpenAI.ResponseRefusalDoneEvent
response.output_text.delta	OpenAI.ResponseTextDeltaEvent
response.output_text.done	OpenAI.ResponseTextDoneEvent
response.reasoning_summary_part.added	OpenAI.ResponseReasoningSummaryPartAddedEvent
response.reasoning_summary_part.done	OpenAI.ResponseReasoningSummaryPartDoneEvent
response.reasoning_summary_text.delta	OpenAI.ResponseReasoningSummaryTextDeltaEvent
response.reasoning_summary_text.done	OpenAI.ResponseReasoningSummaryTextDoneEvent
response.web_search_call.completed	OpenAI.ResponseWebSearchCallCompletedEvent
response.web_search_call.in_progress	OpenAI.ResponseWebSearchCallInProgressEvent
response.web_search_call.searching	OpenAI.ResponseWebSearchCallSearchingEvent
response.image_generation_call.completed	OpenAI.ResponseImageGenCallCompletedEvent
response.image_generation_call.generating	OpenAI.ResponseImageGenCallGeneratingEvent
response.image_generation_call.in_progress	OpenAI.ResponseImageGenCallInProgressEvent
response.image_generation_call.partial_image	OpenAI.ResponseImageGenCallPartialImageEvent
response.mcp_call.arguments_delta	OpenAI.ResponseMCPCallArgumentsDeltaEvent
response.mcp_call.arguments_done	OpenAI.ResponseMCPCallArgumentsDoneEvent
response.mcp_call.completed	OpenAI.ResponseMCPCallCompletedEvent
response.mcp_call.failed	OpenAI.ResponseMCPCallFailedEvent
response.mcp_call.in_progress	OpenAI.ResponseMCPCallInProgressEvent
response.mcp_list_tools.completed	OpenAI.ResponseMCPListToolsCompletedEvent
response.mcp_list_tools.failed	OpenAI.ResponseMCPListToolsFailedEvent
response.mcp_list_tools.in_progress	OpenAI.ResponseMCPListToolsInProgressEvent
response.queued	OpenAI.ResponseQueuedEvent
response.reasoning.delta	OpenAI.ResponseReasoningDeltaEvent
response.reasoning.done	OpenAI.ResponseReasoningDoneEvent
response.reasoning_summary.delta	OpenAI.ResponseReasoningSummaryDeltaEvent
response.reasoning_summary.done	OpenAI.ResponseReasoningSummaryDoneEvent
response.code_interpreter_call_code.delta	OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent
response.code_interpreter_call_code.done	OpenAI.ResponseCodeInterpreterCallCodeDoneEvent
response.code_interpreter_call.completed	OpenAI.ResponseCodeInterpreterCallCompletedEvent
response.code_interpreter_call.in_progress	OpenAI.ResponseCodeInterpreterCallInProgressEvent
response.code_interpreter_call.interpreting	OpenAI.ResponseCodeInterpreterCallInterpretingEvent

İsim	Türü	Description	Gerekli	Varsayılan
sequence_number	tamsayı	Bu olayın sıra numarası.	Evet
type	OpenAI.ResponseStreamEventType		Evet

OpenAI.ResponseStreamEventType

Mülkiyet	Değer
Türü	String
Değerler	response.audio.delta response.audio.done response.audio_transcript.delta response.audio_transcript.done response.code_interpreter_call_code.delta response.code_interpreter_call_code.done response.code_interpreter_call.completed response.code_interpreter_call.in_progress response.code_interpreter_call.interpreting response.completed response.content_part.added response.content_part.done response.created error response.file_search_call.completed response.file_search_call.in_progress response.file_search_call.searching response.function_call_arguments.delta response.function_call_arguments.done response.in_progress response.failed response.incomplete response.output_item.added response.output_item.done response.refusal.delta response.refusal.done response.output_text.annotation.added response.output_text.delta response.output_text.done response.reasoning_summary_part.added response.reasoning_summary_part.done response.reasoning_summary_text.delta response.reasoning_summary_text.done response.web_search_call.completed response.web_search_call.in_progress response.web_search_call.searching response.image_generation_call.completed response.image_generation_call.generating response.image_generation_call.in_progress response.image_generation_call.partial_image response.mcp_call.arguments_delta response.mcp_call.arguments_done response.mcp_call.completed response.mcp_call.failed response.mcp_call.in_progress response.mcp_list_tools.completed response.mcp_list_tools.failed response.mcp_list_tools.in_progress response.queued response.reasoning.delta response.reasoning.done response.reasoning_summary.delta response.reasoning_summary.done

OpenAI.ResponseTextDeltaEvent

İlave bir metin deltası olduğunda oluşur.

İsim	Türü	Description	Gerekli	Varsayılan
content_index	tamsayı	Metin deltasının eklendiği içerik bölümünün dizini.	Evet
delta	String	Eklenen metin deltası.	Evet
item_id	String	Metin deltasının eklendiği çıkış öğesinin kimliği.	Evet
output_index	tamsayı	Metin deltasının eklendiği çıkış öğesinin dizini.	Evet
type	enum	Olayın türü. Her zaman response.output_text.delta. Olası değerler: response.output_text.delta	Evet

OpenAI.ResponseTextDoneEvent

Metin içeriği sonlandırıldığında yayınlanır.

İsim	Türü	Description	Gerekli	Varsayılan
content_index	tamsayı	Metin içeriğinin tamamlandığı içerik bölümünün dizini.	Evet
item_id	String	Metin içeriğinin sonlandırıldığı çıkış öğesinin kimliği.	Evet
output_index	tamsayı	Son haline getirilen metin içeriğine ait çıktı öğesinin dizini.	Evet
text	String	Son haline getirilmiş metin içeriği.	Evet
type	enum	Olayın türü. Her zaman response.output_text.done. Olası değerler: response.output_text.done	Evet

OpenAI.ResponseTextFormatConfiguration

OpenAI.ResponseTextFormatConfiguration için Ayrıştırıcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
text	OpenAI.ResponseTextFormatConfigurationText
json_object	OpenAI.ResponseTextFormatConfigurationJsonObject
json_schema	OpenAI.ResponseTextFormatConfigurationJsonSchema

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.ResponseTextFormatConfigurationType	Modelin çıkış yapması gereken biçimi belirten bir nesne. Yapılandırma { "type": "json_schema" } , modelin sağlanan JSON şemanızla eşleşmesini sağlayan Yapılandırılmış Çıkışlar'ı etkinleştirir. Varsayılan biçim { "type": "text" } ek seçenek yoktur. gpt-4o ve daha yeni modeller için önerilmez: ayarı { "type": "json_object" } , modelin oluşturduğu iletinin geçerli JSON olduğundan emin olan eski JSON modunu etkinleştirir. Destekleyen modeller için json_schema kullanılması tercih edilir.	Evet

OpenAI.ResponseTextFormatConfigurationJsonObject

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olası değerler: json_object	Evet

OpenAI.ResponseTextFormatConfigurationJsonSchema (Yanıt Metin Biçim Yapılandırma Şeması)

JSON Şeması yanıt biçimi. Yapılandırılmış JSON yanıtları oluşturmak için kullanılır.

İsim	Türü	Description	Gerekli	Varsayılan
açıklama	String	Yanıt formatının amacına ilişkin bir açıklama, modelin bu formatta nasıl yanıt vereceğini belirlemesi için kullanılır.	Hayı
name	String	Yanıt biçiminin adı. En fazla uzunluğu 64 olan a-z, A-Z, 0-9 veya alt çizgi ve kısa çizgi içermelidir.	Evet
şema	OpenAI.YanıtFormatıJsonŞemaŞeması	JSON Şeması nesnesi olarak tanımlanan yanıt biçimi şeması. JSON şemaları oluşturmayı buradan öğrenin.	Evet
Sıkı	Boolean	Çıktı oluşturulurken sıkı şemaya bağlı kalınmasının etkinleştirilip etkinleştirilmeyileceği. True olarak ayarlanırsa, model her zaman alanda tanımlanan tam şemayı schema izler. strict trueolduğunda yalnızca bir JSON Şeması alt kümesi desteklenir.	Hayı	Yanlış
type	enum	Tanımlanan yanıt biçiminin türü. Her zaman json_schema. Olası değerler: json_schema	Evet

OpenAI.CevapMetinBiçimiYapılandırmaMetni

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olası değerler: text	Evet

OpenAI.CevapMetinBiçimiYapılandırmaTürü

Modelin çıkış yapması gereken biçimi belirten bir nesne.

Yapılandırma { "type": "json_schema" } , modelin sağlanan JSON şemanızla eşleşmesini sağlayan Yapılandırılmış Çıkışlar'ı etkinleştirir.

Varsayılan biçim { "type": "text" } ek seçenek yoktur.

gpt-4o ve daha yeni modeller için önerilmez:

ayarı { "type": "json_object" } , modelin oluşturduğu iletinin geçerli JSON olduğundan emin olan eski JSON modunu etkinleştirir. Destekleyen modeller için json_schema kullanılması tercih edilir.

Mülkiyet	Değer
Açıklama	Modelin çıkış yapması gereken biçimi belirten bir nesne.

Yapılandırma { "type": "json_schema" } , modelin sağlanan JSON şemanızla eşleşmesini sağlayan Yapılandırılmış Çıkışlar'ı etkinleştirir.

Varsayılan biçim { "type": "text" } ek seçenek yoktur.

gpt-4o ve daha yeni modeller için önerilmez:

ayarı { "type": "json_object" } , modelin oluşturduğu iletinin geçerli JSON olduğundan emin olan eski JSON modunu etkinleştirir. Kullanan json_schema, onu destekleyen modeller için tercih edilir.

OpenAI.ResponseUsage

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

İsim	Türü	Description	Gerekli	Varsayılan
input_tokens	tamsayı	Giriş belirteçlerinin sayısı.	Evet
input_tokens_details	nesne	Giriş belirteçlerinin ayrıntılı dökümü.	Evet
└─ önbelleğe alınmış jetonlar	tamsayı	Önbellekten alınan belirteçlerin sayısı.	Hayı
output_tokens	tamsayı	Çıkış belirteçlerinin sayısı.	Evet
output_tokens_details	nesne	Çıkış belirteçlerinin ayrıntılı dökümü.	Evet
└─ akıl yürütme_tokenlar	tamsayı	Akıl yürütme belirteçlerinin sayısı.	Hayı
total_tokens	tamsayı	Kullanılan toplam belirteç sayısı.	Evet

OpenAI.ResponseWebSearchCallCompletedEvent

Not: web_search henüz Azure OpenAI aracılığıyla sağlanmaz.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	Web arama çağrısıyla ilişkili çıkış öğesinin benzersiz kimliği.	Evet
output_index	tamsayı	Web arama çağrısının ilişkili olduğu çıkış öğesinin dizini.	Evet
type	enum	Olayın türü. Her zaman response.web_search_call.completed. Olası değerler: response.web_search_call.completed	Evet

OpenAI.ResponseWebSearchCallInProgressEvent

Not: web_search henüz Azure OpenAI aracılığıyla sağlanmaz.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	Web arama çağrısıyla ilişkili çıkış öğesinin benzersiz kimliği.	Evet
output_index	tamsayı	Web arama çağrısının ilişkili olduğu çıkış öğesinin dizini.	Evet
type	enum	Olayın türü. Her zaman response.web_search_call.in_progress. Olası değerler: response.web_search_call.in_progress	Evet

OpenAI.ResponseWebSearchCallSearchingEvent

Not: web_search henüz Azure OpenAI aracılığıyla sağlanmaz.

İsim	Türü	Description	Gerekli	Varsayılan
item_id	String	Web arama çağrısıyla ilişkili çıkış öğesinin benzersiz kimliği.	Evet
output_index	tamsayı	Web arama çağrısının ilişkili olduğu çıkış öğesinin dizini.	Evet
type	enum	Olayın türü. Her zaman response.web_search_call.searching. Olası değerler: response.web_search_call.searching	Evet

OpenAI.ResponsesAssistantMessageItemParam

Rolü assistant olan bir ileti parametresi öğesi.

İsim	Türü	Description	Gerekli	Varsayılan
içerik	dizi	İletiye bağlı içerik.	Evet
role	enum	her zaman assistantolan iletinin rolü. Olası değerler: assistant	Evet

OpenAI.ResponsesAssistantMessageItemResource

Rolü assistant olan bir mesaj kaynak öğesi.

İsim	Türü	Description	Gerekli	Varsayılan
içerik	dizi	İletiye bağlı içerik.	Evet
role	enum	her zaman assistantolan iletinin rolü. Olası değerler: assistant	Evet

OpenAI.ResponsesDeveloperMessageItemParam

Rolü developer olan bir ileti parametresi öğesi.

İsim	Türü	Description	Gerekli	Varsayılan
içerik	dizi	İletiye bağlı içerik.	Evet
role	enum	her zaman developerolan iletinin rolü. Olası değerler: developer	Evet

OpenAI.ResponsesDeveloperMessageItemResource

Rolü developer olan bir mesaj kaynak öğesi.

İsim	Türü	Description	Gerekli	Varsayılan
içerik	dizi	İletiye bağlı içerik.	Evet
role	enum	her zaman developerolan iletinin rolü. Olası değerler: developer	Evet

OpenAI.ResponsesMessageItemParam

İstemci isteği parametreleri olarak sağlanan bir rolü ve içeriği temsil eden bir yanıt iletisi öğesi.

OpenAI.ResponsesMessageItemParam için Ayırt Edici

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini role kullanır:

Tür Değeri	Şema
user	OpenAI.ResponsesUserMessageItemParam
system	OpenAI.ResponsesSystemMessageItemParam
developer	OpenAI.ResponsesDeveloperMessageItemParam
assistant	OpenAI.ResponsesAssistantMessageItemParam

İsim	Türü	Description	Gerekli	Varsayılan
role	nesne	Yanıt ileti öğeleri için geçerli rollerin koleksiyonu.	Evet
type	enum	Yanıtlar öğesinin türü her zaman 'ileti'dir. Olası değerler: message	Evet

OpenAI.ResponsesMessageItemResource

Hizmet yanıtlarında sağlandığı gibi bir rolü ve içeriği temsil eden bir yanıt iletisi kaynak öğesi.

OpenAI.ResponsesMessageItemResource için Ayırıcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini role kullanır:

Tür Değeri	Şema
user	OpenAI.ResponsesUserMessageItemResource
system	OpenAI.ResponsesSystemMessageItemResource
developer	OpenAI.ResponsesDeveloperMessageItemResource
assistant	OpenAI.ResponsesAssistantMessageItemResource

İsim	Türü	Description	Gerekli	Varsayılan
role	nesne	Yanıt ileti öğeleri için geçerli rollerin koleksiyonu.	Evet
durum	enum	Öğenin durumu. in_progress, completedveya incomplete. Öğeler API aracılığıyla döndürülürken doldurulur. Olası değerler: in_progress, completed, incomplete	Evet
type	enum	Yanıtlar öğesinin türü her zaman 'ileti'dir. Olası değerler: message	Evet

OpenAI.ResponsesMessageRole

Yanıt ileti öğeleri için geçerli rollerin koleksiyonu.

Mülkiyet	Değer
Açıklama	Yanıt ileti öğeleri için geçerli rollerin koleksiyonu.
Türü	String
Değerler	system developer user assistant

OpenAI.ResponsesSystemMessageItemParam

Rolü system olan bir ileti parametresi öğesi.

İsim	Türü	Description	Gerekli	Varsayılan
içerik	dizi	İletiye bağlı içerik.	Evet
role	enum	her zaman systemolan iletinin rolü. Olası değerler: system	Evet

OpenAI.ResponsesSystemMessageItemResource

Rolü system olan bir mesaj kaynak öğesi.

İsim	Türü	Description	Gerekli	Varsayılan
içerik	dizi	İletiye bağlı içerik.	Evet
role	enum	her zaman systemolan iletinin rolü. Olası değerler: system	Evet

OpenAI.ResponsesUserMessageItemParam

Rolü user olan bir ileti parametresi öğesi.

İsim	Türü	Description	Gerekli	Varsayılan
içerik	dizi	İletiye bağlı içerik.	Evet
role	enum	her zaman userolan iletinin rolü. Olası değerler: user	Evet

OpenAI.ResponsesUserMessageItemResource

Rolü user olan bir mesaj kaynak öğesi.

İsim	Türü	Description	Gerekli	Varsayılan
içerik	dizi	İletiye bağlı içerik.	Evet
role	enum	her zaman userolan iletinin rolü. Olası değerler: user	Evet

OpenAI.RunGraderRequest

İsim	Türü	Description	Gerekli	Varsayılan
Greyder	nesne	Belirtilen işlemi kullanarak giriş ve başvuru arasında dize karşılaştırması gerçekleştiren bir StringCheckGrader nesnesi.	Evet
└─ çıktıyı_hesapla	String	Not veren sonuçlarına göre çıkışı hesaplamak için bir formül.	Hayı
└─ değerlendirme_metriği	enum	Kullanılacak değerlendirme ölçümü. fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5 veya rouge_l. Olası değerler: fuzzy_match, bleu, gleu, , meteor, rouge_1, , rouge_2, rouge_3rouge_4, rouge_5,rouge_l	Hayı
└─ greyderler	nesne		Hayı
└─ görsel_etiketi	String	Python betiği için kullanılacak görüntü etiketi.	Hayı
└─ giriş	dizi	Giriş metni. Bu, şablon dizelerini içerebilir.	Hayı
└─ modeli	String	Değerlendirme için kullanılacak model.	Hayı
└─ ad	String	Değerlendiricinin adı.	Hayı
└─ işlem	enum	Gerçekleştirilecek dize denetimi işlemi. eq, ne, like veya ilike. Olası değerler: eq, ne, like, ilike	Hayı
└─ aralığı	dizi	Puan aralığı. Varsayılan olarak [0, 1] değerini alır.	Hayı
└─ başvuru	String	Değerlendirmenin yapıldığı metin.	Hayı
└─ örnekleme_parametreleri		Modelin örnekleme parametreleri.	Hayı
└─ kaynak	String	Python betiğinin kaynak kodu.	Hayı
└─ türü	enum	Her zaman multiolan nesne türü. Olası değerler: multi	Hayı
öğe		Not verene sağlanan veri kümesi öğesi. Bu, ad alanını item doldurmak için kullanılır.	Hayı
model_sample	String	Değerlendirilecek model örneği. Bu değer ad alanını sample doldurmak için kullanılır. output_json Model örneği geçerli bir JSON dizesiyse değişken doldurulur.	Evet

OpenAI.RunGraderResponse

İsim	Türü	Description	Gerekli	Varsayılan
metadata	nesne		Evet
└─ hataları	nesne		Hayı
└─ formül_parse_hatası	Boolean		Hayı
└─ geçersiz_değişken_hatası	Boolean		Hayı
└─ model_değerlendirici_analiz_hatası	Boolean		Hayı
└─ model_değerlendirici_reddetme_hatası	Boolean		Hayı
└─ model değerlendirici sunucu hatası	Boolean		Hayı
└─ model_derecelendirme_sunucusu_hata_detayları	String		Hayı
└─ diğer_hata	Boolean		Hayı
└─ python_değerlendirici_çalışma_zamanı_hatası	Boolean		Hayı
└─ python_grader_çalışma_zamanı_hata_ayrıntıları	String		Hayı
└─ python_grader_sunucu_hatası	Boolean		Hayı
└─ python_grader_server_error_type (Python derecelendirme sunucusu hata türü)	String		Hayı
└─ örnek_çözümleme_hatası	Boolean		Hayı
└─ kesilmiş_gözlem_hatası	Boolean		Hayı
\- tepkisiz_ödül_hatası	Boolean		Hayı
└─ yürütme_süresi	Numara		Hayı
└─ ad	String		Hayı
└─ sampled_model_name	String		Hayı
└─ puanlar			Hayı
└─ belirteç_kullanımı	tamsayı		Hayı
└─ türü	String		Hayı
model_grader_token_usage_per_model			Evet
ödül	Numara		Evet
sub_rewards			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_tokensaş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.	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 4 dizi. Döndürülen metin durdurma sırasını içermez.

Bu şema aşağıdaki türlerden birini kabul eder:

• string
• array

OpenAI.Tool

OpenAI.Tool için Ayırıcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
function	OpenAI.FunctionTool
file_search	OpenAI.FileSearchTool
computer_use_preview	OpenAI.ComputerUsePreviewTool
web_search_preview	OpenAI.WebSearchPreviewTool
code_interpreter	OpenAI.CodeInterpreterTool
image_generation	OpenAI.ImageGenTool
local_shell	OpenAI.LocalShellTool
mcp	OpenAI.MCPTool

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.ToolType	Yanıt oluşturmak için kullanılabilecek bir araç.	Evet

OpenAI.ToolChoiceObject

OpenAI.ToolChoiceObject için Ayırıcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
file_search	OpenAI.ToolChoiceObjectFileSearch
computer_use_preview	OpenAI.ToolChoiceObjectComputer
web_search_preview	OpenAI.ToolChoiceObjectWebSearch
image_generation	OpenAI.ToolChoiceObjectImageGen
code_interpreter	OpenAI.ToolChoiceObjectCodeInterpreter
function	OpenAI.ToolChoiceObjectFunction
mcp	OpenAI.ToolChoiceObjectMCP

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.ToolChoiceObjectType	Modelin bir yanıt oluşturmak için yerleşik bir araç kullanması gerektiğini gösterir.	Evet

OpenAI.ToolChoiceObjectCodeInterpreter

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olası değerler: code_interpreter	Evet

OpenAI.ToolChoiceObjectComputer

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olası değerler: computer_use_preview	Evet

OpenAI.ToolChoiceObjectFileSearch

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olası değerler: file_search	Evet

OpenAI.ToolChoiceObjectFunction

Modeli belirli bir işlevi çağırmaya zorlamak için bu seçeneği kullanın.

İsim	Türü	Description	Gerekli	Varsayılan
name	String	Çağrılacak işlevin adı.	Evet
type	enum	İşlev çağrısı için türü her zaman functionşeklindedir. Olası değerler: function	Evet

OpenAI.ToolChoiceObjectImageGen

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olası değerler: image_generation	Evet

OpenAI.ToolChoiceObjectMCP

Modeli uzak bir MCP sunucusunda belirli bir aracı çağırmaya zorlamak için bu seçeneği kullanın.

İsim	Türü	Description	Gerekli	Varsayılan
name	String	Sunucuda çağrılacak aracın adı.	Hayı
sunucu etiketi	String	Kullanılacak MCP sunucusunun etiketi.	Evet
type	enum	MCP araçları için türü her zaman mcpşeklindedir. Olası değerler: mcp	Evet

OpenAI.ToolChoiceObjectType

Modelin bir yanıt oluşturmak için yerleşik bir araç kullanması gerektiğini gösterir.

Mülkiyet	Değer
Açıklama	Modelin bir yanıt oluşturmak için yerleşik bir araç kullanması gerektiğini gösterir.
Türü	String
Değerler	file_search function computer_use_preview web_search_preview image_generation code_interpreter mcp

OpenAI.ToolChoiceObjectWebSearch

Not: web_search henüz Azure OpenAI aracılığıyla sağlanmaz.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Olası değerler: web_search_preview	Evet

OpenAI.ToolChoiceOptions

Model tarafından çağrılan aracı (varsa) denetler.

none modelin herhangi bir aracı çağırmayacağı ve bunun yerine bir ileti oluşturduğu anlamına gelir.

auto modelin ileti oluşturma veya bir veya daha fazla araç çağırma arasında seçim yapabileceğiniz anlamına gelir.

required modelin bir veya daha fazla araç çağırması gerektiği anlamına gelir.

Mülkiyet	Değer
Açıklama	Model tarafından çağrılan aracı (varsa) denetler. none modelin herhangi bir aracı çağırmayacağı ve bunun yerine bir ileti oluşturduğu anlamına gelir. auto modelin 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.
Türü	String
Değerler	none auto required

OpenAI.AraçTürü

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

Mülkiyet	Değer
Açıklama	Yanıt oluşturmak için kullanılabilecek bir araç.
Türü	String
Değerler	file_search function computer_use_preview web_search_preview mcp code_interpreter image_generation local_shell

OpenAI.TopLogProb

Belirtecin en yüksek günlük olasılığı.

İsim	Türü	Description	Gerekli	Varsayılan
bytes	dizi		Evet
logprob	Numara		Evet
token	String		Evet

OpenAI.TranscriptionAudioResponseFormat

Başvurular: OpenAI.AudioResponseFormat

OpenAI.TranscriptionInclude

Mülkiyet	Değer
Türü	String
Değerler	logprobs

OpenAI.TranscriptionSegment

İsim	Türü	Description	Gerekli	Varsayılan
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	dizi	Metin içeriğinin belirteç kimlikleri dizisi.	Evet

OpenAI.TranscriptionWord

İsim	Türü	Description	Gerekli	Varsayılan
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.TranslationAudioResponseFormat

Başvurular: OpenAI.AudioResponseFormat

OpenAI.UpdateVectorStoreFileAttributesRequest

İsim	Türü	Description	Gerekli	Varsayılan
attributes	nesne	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, nesne hakkında ek bilgileri yapılandırılmış biçimde depolamak ve API veya pano aracılığıyla nesneleri sorgulamak için yararlı olabilir. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler, uzunluğu en fazla 512 karakter, boole veya sayı olan dizelerdir.	Evet

OpenAI.UpdateVectorStoreRequest

İsim	Türü	Description	Gerekli	Varsayılan
sona_erdikten_sonra	nesne	Vektör deposu için süre sonu ilkesi.	Hayı
└─ tutturucu	enum	Süre sonu ilkesinin uygulanacağı bağlantı zaman damgası. Desteklenen tutturucular: last_active_at. Olası değerler: last_active_at	Hayı
└─ gün	tamsayı	Vektör deposunun süresinin dolacağı yer işareti saatinden sonraki gün sayısı.	Hayı
metadata	nesne	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.	Hayı
name	String	Vektör deposunun adı.	Hayı

OpenAI.VadConfig

İsim	Türü	Description	Gerekli	Varsayılan
prefix_padding_ms	tamsayı	VAD konuşma algılamadan önce eklenecek ses miktarı (milisaniye cinsinden).	Hayı	300
silence_duration_ms	tamsayı	Konuşma durdurmayı algılamak için sessizlik süresi (milisaniye cinsinden). Daha kısa değerlerle model daha hızlı yanıt verir, ancak kullanıcı kısa durakladığında araya girebilir.	Hayı	200
threshold	Numara	Ses etkinliği algılama için duyarlılık eşiği (0,0 - 1,0). Daha yüksek bir eşik, modeli etkinleştirmek için daha yüksek ses gerektirir ve bu nedenle gürültülü ortamlarda daha iyi performans gösterebilir.	Hayı	0,5
type	enum	Manuel parçalamayı sunucu tarafı VAD kullanarak etkinleştirmek için server_vad olarak ayarlanmalıdır. Olası değerler: server_vad	Evet

OpenAI.ValidateGraderRequest

İsim	Türü	Description	Gerekli	Varsayılan
Greyder	nesne	Belirtilen işlemi kullanarak giriş ve başvuru arasında dize karşılaştırması gerçekleştiren bir StringCheckGrader nesnesi.	Evet
└─ çıktıyı_hesapla	String	Not veren sonuçlarına göre çıkışı hesaplamak için bir formül.	Hayı
└─ değerlendirme_metriği	enum	Kullanılacak değerlendirme ölçümü. fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5 veya rouge_l. Olası değerler: fuzzy_match, bleu, gleu, , meteor, rouge_1, , rouge_2, rouge_3rouge_4, rouge_5,rouge_l	Hayı
└─ greyderler	nesne		Hayı
└─ görsel_etiketi	String	Python betiği için kullanılacak görüntü etiketi.	Hayı
└─ giriş	dizi	Giriş metni. Bu, şablon dizelerini içerebilir.	Hayı
└─ modeli	String	Değerlendirme için kullanılacak model.	Hayı
└─ ad	String	Değerlendiricinin adı.	Hayı
└─ işlem	enum	Gerçekleştirilecek dize denetimi işlemi. eq, ne, like veya ilike. Olası değerler: eq, ne, like, ilike	Hayı
└─ aralığı	dizi	Puan aralığı. Varsayılan olarak [0, 1] değerini alır.	Hayı
└─ başvuru	String	Değerlendirmenin yapıldığı metin.	Hayı
└─ örnekleme_parametreleri		Modelin örnekleme parametreleri.	Hayı
└─ kaynak	String	Python betiğinin kaynak kodu.	Hayı
└─ türü	enum	Her zaman multiolan nesne türü. Olası değerler: multi	Hayı

OpenAI.ValidateGraderResponse

İsim	Türü	Description	Gerekli	Varsayılan
Greyder	nesne	Belirtilen işlemi kullanarak giriş ve başvuru arasında dize karşılaştırması gerçekleştiren bir StringCheckGrader nesnesi.	Hayı
└─ çıktıyı_hesapla	String	Not veren sonuçlarına göre çıkışı hesaplamak için bir formül.	Hayı
└─ değerlendirme_metriği	enum	Kullanılacak değerlendirme ölçümü. fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5 veya rouge_l. Olası değerler: fuzzy_match, bleu, gleu, , meteor, rouge_1, , rouge_2, rouge_3rouge_4, rouge_5,rouge_l	Hayı
└─ greyderler	nesne		Hayı
└─ görsel_etiketi	String	Python betiği için kullanılacak görüntü etiketi.	Hayı
└─ giriş	dizi	Giriş metni. Bu, şablon dizelerini içerebilir.	Hayı
└─ modeli	String	Değerlendirme için kullanılacak model.	Hayı
└─ ad	String	Değerlendiricinin adı.	Hayı
└─ işlem	enum	Gerçekleştirilecek dize denetimi işlemi. eq, ne, like veya ilike. Olası değerler: eq, ne, like, ilike	Hayı
└─ aralığı	dizi	Puan aralığı. Varsayılan olarak [0, 1] değerini alır.	Hayı
└─ başvuru	String	Değerlendirmenin yapıldığı metin.	Hayı
└─ örnekleme_parametreleri		Modelin örnekleme parametreleri.	Hayı
└─ kaynak	String	Python betiğinin kaynak kodu.	Hayı
└─ türü	enum	Her zaman multiolan nesne türü. Olası değerler: multi	Hayı

OpenAI.VectorStoreExpirationAfter

Vektör deposu için süre sonu ilkesi.

İsim	Türü	Description	Gerekli	Varsayılan
anchor	enum	Süre sonu ilkesinin uygulanacağı bağlantı zaman damgası. Desteklenen tutturucular: last_active_at. Olası değerler: last_active_at	Evet
Günler	tamsayı	Vektör deposunun süresinin dolacağı yer işareti saatinden sonraki gün sayısı.	Evet

OpenAI.VectorStoreFileAttributes

Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, nesne hakkında ek bilgileri yapılandırılmış biçimde depolamak ve API veya pano aracılığıyla nesneleri sorgulamak için yararlı olabilir. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler, uzunluğu en fazla 512 karakter, boole veya sayı olan dizelerdir.

Tür: nesne

OpenAI.VectorStoreFileBatchObject

Vektör deposuna eklenmiş bir dosya grubu.

İsim	Türü	Description	Gerekli	Varsayılan
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ı	nesne		Evet
└─ iptal edildi	tamsayı	İptal edilen dosyaların sayısı.	Hayı
└─ tamamlandı	tamsayı	İşlenen dosyaların sayısı.	Hayı
└─ başarısız oldu	tamsayı	İşlenemeyen dosyaların sayısı.	Hayı
└─ devam ediyor	tamsayı	İşlenmekte olan dosyaların sayısı.	Hayı
└─ toplam	tamsayı	Toplam dosya sayısı.	Hayı
kimlik	String	API uç noktalarında başvurulabilen tanımlayıcı.	Evet
nesne	enum	Her zaman vector_store.file_batcholan nesne türü. Olası değerler: vector_store.files_batch	Evet
durum	enum	Vektör deposu dosyaları toplu işleminin durumu , veya in_progressolabilircompletedcancelledfailed. Olası değerler: in_progress, completed, cancelled, failed	Evet
vektör_depolama_kimliği	String	Dosyanın eklendiği vektör deposunun kimliği.	Evet

OpenAI.VectorStoreFileObject

Vektör deposuna eklenmiş dosyaların listesi.

İsim	Türü	Description	Gerekli	Varsayılan
attributes	nesne	Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, nesne hakkında ek bilgileri yapılandırılmış biçimde depolamak ve API veya pano aracılığıyla nesneleri sorgulamak için yararlı olabilir. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler, uzunluğu en fazla 512 karakter, boole veya sayı olan dizelerdir.	Hayı
chunking_strategy	nesne		Hayı
└─ türü	enum	Olası değerler: static, other	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	nesne	Bu vektör deposu dosyasıyla ilişkili son hata. Hata yoksa olacaktır null .	Evet
└─ kod	enum	server_error veya rate_limit_exceeded'den biri. Olası değerler: server_error, unsupported_file, invalid_file	Hayı
└─ ileti	String	Hatanın insan tarafından okunabilen açıklaması.	Hayı
nesne	enum	Her zaman vector_store.fileolan nesne türü. Olası değerler: vector_store.file	Evet
durum	enum	, , in_progressveya completedolabilir cancelledfailedvektö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 eklendiği vektör deposunun kimliği.	Evet

OpenAI.VectorStoreObject

Vektör deposu, araç tarafından file_search kullanılabilecek işlenmiş dosya koleksiyonudur.

İsim	Türü	Description	Gerekli	Varsayılan
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 süre sonu ilkesi.	Hayı
sona_erdigi_tarih	tamsayı	Vektör deposunun süresinin ne zaman dolacağı için Unix zaman damgası (saniye olarak).	Hayı
dosya_sayıları	nesne		Evet
└─ iptal edildi	tamsayı	İptal edilen dosya sayısı.	Hayı
└─ tamamlandı	tamsayı	Başarıyla işlenen dosyaların sayısı.	Hayı
└─ başarısız oldu	tamsayı	İşlenemeyen dosyaların sayısı.	Hayı
└─ devam ediyor	tamsayı	İşlenmekte olan dosyaların sayısı.	Hayı
└─ toplam	tamsayı	Toplam dosya sayısı.	Hayı
kimlik	String	API uç noktalarında başvurulabilen tanımlayıcı.	Evet
son etkinlik zamanı	tamsayı	Vektör deposunun en son etkin olduğu zaman için Unix zaman damgası (saniye olarak).	Evet
metadata	nesne	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
name	String	Vektör deposunun adı.	Evet
nesne	enum	Her zaman vector_storeolan nesne türü. Olası değerler: vector_store	Evet
durum	enum	, veya expiredolabilir in_progresscompletedvektö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.VoiceIdsShared

Mülkiyet	Değer
Türü	String
Değerler	alloy ash ballad coral echo fable onyx nova sage shimmer verse

OpenAI.WebSearchAction

OpenAI.WebSearchAction için Ayrımcı

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri	Şema
find	OpenAI.WebSearchActionFind
open_page	OpenAI.WebSearchActionOpenPage
search	OpenAI.WebSearchActionSearch

İsim	Türü	Description	Gerekli	Varsayılan
type	OpenAI.WebSearchActionType		Evet

OpenAI.WebSearchActionFind

Eylem türü "bul": Yüklenen bir sayfada desen arar.

İsim	Türü	Description	Gerekli	Varsayılan
pattern	String	Sayfa içinde aranacak desen veya metin.	Evet
type	enum	Eylem türü. Olası değerler: find	Evet
url	String	Sayfanın URL'si deseni aradı.	Evet

OpenAI.WebSearchActionOpenPage

Eylem türü "open_page" - Arama sonuçlarından belirli bir URL'yi açar.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Eylem türü. Olası değerler: open_page	Evet
url	String	Model tarafından açılan URL.	Evet

OpenAI.WebSearchActionSearch

Eylem türü "arama" - Web araması sorgusu gerçekleştirir.

İsim	Türü	Description	Gerekli	Varsayılan
soru	String	Arama sorgusu.	Evet
type	enum	Eylem türü. Olası değerler: search	Evet

OpenAI.WebSearchActionType

Mülkiyet	Değer
Türü	String
Değerler	search open_page find

OpenAI.WebSearchPreviewTool

Not: web_search henüz Azure OpenAI aracılığıyla sağlanmaz.

İsim	Türü	Description	Gerekli	Varsayılan
arama_bağlam_boyutu	enum	Arama için kullanılacak bağlam penceresi alanı miktarına yönelik üst düzey kılavuz. low, mediumveya high. medium varsayılan değerdir. Olası değerler: low, medium, high	Hayı
type	enum	Web arama aracının türü. web_search_preview veya web_search_preview_2025_03_11'den biri. Olası değerler: web_search_preview	Evet
kullanıcı_konumu	nesne		Hayı
└─ türü	OpenAI.LocationType		Hayı

OpenAI.WebSearchToolCallItemParam

Not: web_search henüz Azure OpenAI aracılığıyla sağlanmaz.

İsim	Türü	Description	Gerekli	Varsayılan
hareket	nesne		Evet
└─ türü	OpenAI.WebSearchActionType		Hayı
type	enum	Olası değerler: web_search_call	Evet

OpenAI.WebSearchToolCallItemResource

Not: web_search henüz Azure OpenAI aracılığıyla sağlanmaz.

İsim	Türü	Description	Gerekli	Varsayılan
hareket	nesne		Evet
└─ türü	OpenAI.WebSearchActionType		Hayı
durum	enum	Web arama aracı çağrısının durumu. Olası değerler: in_progress, searching, completed, failed	Evet
type	enum	Olası değerler: web_search_call	Evet

PineconeChatDataSource

İsim	Türü	Description	Gerekli	Varsayılan
parameters	nesne	Pinecone veri kaynağının kullanımını denetlemek için parametre bilgileri.	Evet
└─ kısmi_sonuç_izin_ver	Boolean	True olarak ayarlanırsa, sistem kısmi arama sonuçlarının kullanılmasına izin verir ve tüm kısmi sorgular başarısız olursa istek başarısız olur. Belirtilmezse veya false olarak belirtilmezse, herhangi bir arama sorgusu başarısız olursa istek başarısız olur.	Hayı	Yanlış
└─ kimlik doğrulaması	nesne		Hayı
└─ anahtar	String		Hayı
└─ türü	enum	Olası değerler: api_key	Hayı
└─ gömme_bağımlılığı	nesne	Veri kaynağı ile ekleme kaynağı olarak kullanılabilen bir veri vektörleştirme kaynağının gösterimi.	Hayı
└─ türü	AzureChatDataSourceVectorizationSourceType	Somut vektörleştirme kaynağının ayırt edici tanımlayıcısı.	Hayı
└─ ortam	String	Pinecone ile kullanılacak ortam adı.	Hayı
└─ alanlar_haritalama	nesne	Pinecone veri kaynağı tarafından kullanılan verilere uygulanacak alan eşlemeleri. Pinecone için içerik alanı eşlemelerinin gerekli olduğunu unutmayın.	Hayı
└─ içerik_alanları	dizi		Hayı
└─ içerik_alanları_ayırıcı	String		Hayı
└─ dosyayolu_alani	String		Hayı
└─ başlık_alanı	String		Hayı
└─ url_alanı	String		Hayı
└─ in_scope	Boolean	Sorguların dizine alınan verilerin kullanımıyla sınırlandırılıp kısıtlanmaması gerektiği.	Hayı
└─ kapsamları_dahil_et	dizi	Yanıta dahil edilecek çıktı bağlamı özellikleri. Varsayılan olarak, alıntılar ve amaç istenir.	Hayı	['alıntılar', 'amaç']
└─ indeks_adı	String	Kullanılacak Pinecone veritabanı dizininin adı.	Hayı
└─ max_search_queries (maksimum arama sorguları)	tamsayı	Tek bir kullanıcı iletisi için arama sağlayıcısına gönderilmesi gereken en fazla yeniden yazılan sorgu sayısı. Varsayılan olarak, sistem otomatik bir belirleme yapar.	Hayı
└─ katılık	tamsayı	Arama ilgi filtresinin yapılandırılmış katılığı. Daha yüksek katılık, yanıtın doğruluğunu artırır ancak geri çağırma oranını düşürür.	Hayı
└─ top_n_documents	tamsayı	Sorguda öne çıkması için yapılandırılan belge sayısı.	Hayı
type	enum	Her zaman 'çam kozalağı' olan ayrıştırıcı tür tanımlayıcısı. Olası değerler: pinecone	Evet

Nitelik

Alınacak video içeriğinin kalitesi. Bu, döndürülmesi gereken video içeriğinin kalitesini belirtir.

Mülkiyet	Değer
Açıklama	Alınacak video içeriğinin kalitesi. Bu, döndürülmesi gereken video içeriğinin kalitesini belirtir.
Türü	String
Değerler	high low

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

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 ses 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"]

Dizisi: string

SpeechGenerationResponseFormat

Metin okuma için desteklenen ses çıkış biçimleri.

Bu bileşen aşağıdakilerden biri olabilir:

VideoGeneration

Video oluşturma sonucu.

İsim	Türü	Description	Gerekli	Varsayılan
oluşturulma_tarihi	tamsayı	Videonun üretildiği zaman.	Evet
height	tamsayı	Videonun yüksekliği.	Evet
kimlik	String	Video oluşturma ID'si.	Evet
job_id	String	Bu video için video oluşturma görevinin kimliği.	Evet
n_seconds	tamsayı	Video oluşturma süresi.	Evet
nesne	enum	Olası değerler: video.generation	Evet
prompt	String	Bu video oluşturma için istem.	Evet
width	tamsayı	Videonun genişliği.	Evet

VideoGenerationJob

Bir video oluşturma işi.

İsim	Türü	Description	Gerekli	Varsayılan
oluşturulma_tarihi	tamsayı	İşin oluşturulduğu zaman.	Evet
sona_erdigi_tarih	tamsayı	İşin hizmetten otomatik olarak silindiği zaman. Veri kaybını önlemek için işin video içeriği ve meta verileri bu tarihten önce depolanmalıdır.	Hayı
failure_reason	dize (aşağıdaki geçerli modellere bakın)		Hayı
tamamlandı	tamsayı	İşin tüm video sürümleri tamamlandığında.	Hayı
Nesil	dizi	Bu iş için oluşturulan videolar. Sayı, verilen n_variants ve nesillerin yaratılış başarısına bağlıdır.	Hayı
height	tamsayı	Videonun yüksekliği.	Evet
kimlik	String	İşin kimliği.	Evet
inpaint_items	dizi	Bu video oluşturma işi için isteğe bağlı renklendirme öğeleri.	Hayı
model	String	Bu video oluşturma işi için kullanılacak dağıtımın adı.	Evet
n_seconds	tamsayı	Video oluşturma işinin süresi.	Evet
n_variants	tamsayı	Bu video oluşturma işi için varyant olarak üretilecek video adedi.	Evet
nesne	enum	Olası değerler: video.generation.job	Evet
prompt	String	Bu video oluşturma işinin istemi.	Evet
durum	nesne	Video oluşturma işinin durumu.	Evet
width	tamsayı	Videonun yüksekliği.	Evet

VideoGenerationJobList

Video oluşturma işlerinin listesi.

İsim	Türü	Description	Gerekli	Varsayılan
veriler	dizi	Video oluşturma işlerinin listesi.	Evet
ilk_kimlik	String	Varsa, geçerli sayfadaki ilk işin 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 işin kimliği.	Hayı
nesne	enum	Olası değerler: list	Evet

Sonraki Adımlar

Modeller hakkında bilgi edinin ve REST API ile ince ayarlamalar yapın. Azure OpenAI'yi destekleyen temel modeller hakkında daha fazla bilgi edinin.