Microsoft Döküm Modellerinde OpenAI REST API başvurusu Azure

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

API belirtimleri

Azure OpenAI modellerini ve kaynaklarını yönetme ve bunlarla etkileşim kurma, üç birincil API yüzeyine ayrılır:

Kontrol düzlemi
Veri düzlemi - yazma
Veri düzlemi - çıkarım

Her API yüzeyi/belirtimi farklı bir Azure OpenAI özelliklerini kapsüller. Her API'nin kendi benzersiz önizleme ve kararlı/genel kullanıma açık (GA) API sürümleri vardır. Önizleme sürümleri şu anda aylık bir tempo takip etme eğilimindedir.

Önemli

Artık yeni bir önizleme çıkarım API'si vardır. API yaşam döngüsü kılavuzumuzdan daha fazla bilgi edinin.

API	En son önizleme sürümü	En son GA sürümü	Özellikler	Açıklama
Kontrol düzlemi	`2025-07-01-preview`	`2025-06-01`	Spec dosyaları	Denetim düzlemi API'si kaynak oluşturma, model dağıtımı ve diğer üst düzey kaynak yönetimi görevleri gibi işlemler için kullanılır. Denetim düzlemi ayrıca Azure Resource Manager, Bicep, Terraform ve Azure CLI gibi özelliklerle neler yapabileceğinizi de yönetir.
Veri düzlemi	`v1 preview`	`v1`	Spec dosyaları	Veri düzlemi API'si çıkarım ve yazma işlemlerini denetler.

Kimlik doğrulama

Azure OpenAI kimlik doğrulaması için iki yöntem sağlar. API Anahtarlarını veya Microsoft Entra ID kullanabilirsiniz.

API Anahtarı kimlik doğrulaması: Bu kimlik doğrulaması türü için tüm API istekleri HTTP üst bilgisinde api-key API Anahtarını içermelidir. Hızlı Başlangıç, bu kimlik doğrulaması türüyle çağrı yapma konusunda rehberlik sağlar.
Microsoft Entra ID authentication: Microsoft Entra belirteci kullanarak API çağrısının kimliğini doğrulayabilirsiniz. Kimlik doğrulama belirteçleri bir isteğe üst bilgi olarak Authorization eklenir. Sağlanan belirtecin önünde Bearer, örneğin Bearer YOUR_AUTH_TOKENolmalıdır. Microsoft Entra ID ile authenticating ile ilgili nasıl yapılır kılavuzumuzu okuyabilirsiniz.

REST API sürümü oluşturma

Hizmet API'leri sorgu parametresi kullanılarak api-version sürümlenir. Tüm sürümler YYYY-MM-DD tarih yapısını izler. Örneğin:

POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/chat/completions?api-version=2024-06-01

Veri düzlemi çıkarımı

Makalenin geri kalanı, Azure OpenAI veri düzlemi çıkarım belirtimi 2024-10-21 GA sürümünü kapsar.

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

Tamamlama

POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2024-10-21

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

URI Parametreleri

Adı	Inç	Gerekli	Türü	Açıklama
Bitiş noktası	Yolu	Evet	Dize Url	OpenAI uç noktaları Azure desteklenir (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
deployment-id	Yolu	Evet	Dize	Dağıtılan modelin dağıtım kimliği.
api sürümü	Sorgu	Evet	Dize	API sürümü

İstek Üst Bilgisi

Adı	Gerekli	Türü	Açıklama
api-key	True	Dize	Burada Azure OpenAI API anahtarı sağlayın

İstek Gövdesi

İçerik Türü: application/json

Adı	Türü	Açıklama	Gerekli	Varsayılan
Istemi	dize veya dizi	Dize olarak kodlanmış, dize dizisi, belirteç dizisi veya belirteç dizi dizisi için tamamlamalar oluşturma istemi. \|endoftext\|> öğesinin<, modelin eğitim sırasında gördüğü belge ayırıcısı olduğunu unutmayın. Bu nedenle, bir istem belirtilmezse model, yeni belgenin başından itibaren oluşturulmuş gibi oluşturulur.	Evet
best_of	Tamsayı	Tamamlamaları `best_of` sunucu tarafı oluşturur ve "en iyi" değerini (belirteç başına en yüksek günlük olasılığına sahip olan) döndürür. Sonuçlar akışla aktarılamaz. ile `n`kullanıldığında, `best_of` aday tamamlama sayısını denetler ve `n` döndürülecek sayı sayısını belirtir â€" `best_of` değerinin değerinden `n`büyük olması gerekir. Not: Bu parametre birçok tamamlama oluşturduğundan, belirteç kotanızı hızla kullanabilir. dikkatle kullanın ve ve `stop`için `max_tokens` makul ayarlara sahip olduğunuzdan emin olun.	No	1
Yankı	Boolean	Tamamlamaya ek olarak istemi geri yankıla	No	False
frequency_penalty	Numarası	-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.	No	0
logit_bias	Nesne	Belirtilen belirteçlerin tamamlanmada görünme olasılığını değiştirin. Belirteçleri (GPT belirteç oluşturucusunda belirteç kimliğiyle belirtilen) -100 ile 100 arasındaki ilişkili bir sapma değeriyle eşleyen bir JSON nesnesini kabul eder. Matematiksel olarak sapma, örneklemeden önce model tarafından oluşturulan logit'lere eklenir. Tam etki modele göre değişir, ancak -1 ile 1 arasındaki değerler seçim olasılığını azaltmalı veya artırmalıdır; -100 veya 100 gibi değerler, ilgili belirtecin yasaklanması veya özel olarak seçilmesiyle sonuçlanmalıdır. Örneğin, \|endoftext\|> belirtecinin oluşturulmasını <önlemek için geçirebilirsiniz`{"50256": -100}`.	No	Hiçbiri
logprobs	Tamsayı	Günlük olasılıklarını `logprobs` en olası çıkış belirteçlerine ve seçilen belirteçlere ekleyin. Örneğin, 5 ise `logprobs` , API en olası beş belirtecin listesini döndürür. API her zaman örneklenen belirtecin değerini döndürür `logprob` , bu nedenle yanıtta en `logprobs+1` fazla öğe olabilir. için `logprobs` en büyük değer 5'tir.	No	Hiçbiri
max_tokens	Tamsayı	Tamamlanma sırasında oluşturulabilecek en fazla belirteç sayısı. İsteminizin ve artı `max_tokens` değerin belirteç sayısı modelin bağlam uzunluğunu aşamaz.	No	16
n	Tamsayı	Her istem için kaç tamamlama oluşturulacağı. Not: Bu parametre birçok tamamlama oluşturduğundan, belirteç kotanızı hızla kullanabilir. dikkatle kullanın ve ve `stop`için `max_tokens` makul ayarlara sahip olduğunuzdan emin olun.	No	1
presence_penalty	Numarası	-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.	No	0
Tohum	Tamsayı	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.	No
Durdurmak	dize veya dizi	API'nin başka belirteçler üretmeyi durduracağı en fazla dört dizi. Döndürülen metin durdurma sırasını içermez.	No
Akışı	Boolean	Kısmi ilerlemenin akışla geri aktarılıp aktarılmayacağı. Ayarlanırsa, belirteçler kullanılabilir hale geldikçe yalnızca veri sunucu tarafından gönderilen olaylar olarak gönderilir ve akış bir `data: [DONE]` ileti tarafından sonlandırılır.	No	False
Soneki	Dize	Eklenen metnin tamamlanmasından sonra gelen sonek. Bu parametre yalnızca için `gpt-3.5-turbo-instruct`desteklenir.	No	Hiçbiri
Sıcaklık	Numarası	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.	No	1
top_p	Numarası	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.	No	1
Kullanıcı	Dize	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ı.	No

Yanıt

Durum Kodu: 200

Açıklama: Tamam

İçerik Türü	Türü	Açıklama
application/json	createCompletionResponse	API'den bir tamamlama yanıtını temsil eder. Not: Hem akışlı hem de akışsız yanıt nesneleri aynı şekli paylaşır (sohbet uç noktasından farklı olarak).

Durum Kodu: varsayılan

Açıklama: Hizmet kullanılamıyor

İçerik Türü	Türü	Açıklama
application/json	errorResponse

Örnekler

Örnek

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

POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2024-10-21

{
 "prompt": [
  "tell me a joke about mango"
 ],
 "max_tokens": 32,
 "temperature": 1.0,
 "n": 1
}

Yanıtlar: Durum Kodu: 200

{
  "body": {
    "id": "cmpl-7QmVI15qgYVllxK0FtxVGG6ywfzaq",
    "created": 1686617332,
    "choices": [
      {
        "text": "es\n\nWhat do you call a mango who's in charge?\n\nThe head mango.",
        "index": 0,
        "finish_reason": "stop",
        "logprobs": null
      }
    ],
    "usage": {
      "completion_tokens": 20,
      "prompt_tokens": 6,
      "total_tokens": 26
    }
  }
}

Eklemeler

POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2024-10-21

Makine öğrenmesi modelleri ve algoritmaları tarafından kolayca kullanılabilen belirli bir girişin vektör gösterimini alın.

URI Parametreleri

Adı	Inç	Gerekli	Türü	Açıklama
Bitiş noktası	Yolu	Evet	Dize Url	OpenAI uç noktaları Azure desteklenir (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
deployment-id	Yolu	Evet	Dize
api sürümü	Sorgu	Evet	Dize	API sürümü

İstek Üst Bilgisi

Adı	Gerekli	Türü	Açıklama
api-key	True	Dize	Burada Azure OpenAI API anahtarı sağlayın

İstek Gövdesi

İçerik Türü: application/json

Adı	Türü	Açıklama	Gerekli
Giriş	dize veya dizi	Eklemek için metin girin, dize veya belirteç dizisi olarak kodlanmış. Tek bir isteğe birden çok giriş eklemek için bir dizi dize veya belirteç dizisi geçirin. Giriş, model için maksimum giriş belirteçlerini aşmamalıdır (için `text-embedding-ada-002`8.192 belirteç), boş bir dize olamaz ve herhangi bir dizi 2.048 boyut veya daha az olmalıdır.	Evet
Kullanıcı	Dize	Kötüye kullanımı izlemeye ve algılamaya yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı.	No
input_type	Dize	kullanılacak ekleme aramasının giriş türü	No
encoding_format	Dize	Eklemelerin döndürüleceği biçim. veya `base64`olabilir`float`. varsayılan değeridir `float`.	No
Boyutlar	Tamsayı	Sonuçta elde edilen çıktı eklemelerinin sahip olması gereken boyut sayısı. Yalnızca ve sonraki modellerde `text-embedding-3` desteklenir.	No

Yanıt

Adı	Türü	Gerekli
Nesne	Dize	Evet
Modeli	Dize	Evet
Veri	Dizi	Evet
Kullanım	Nesne	Evet

Kullanım özellikleri

prompt_tokens

Adı	Türü	Açıklama	Varsayılan
prompt_tokens	Tamsayı

total_tokens

Adı	Türü	Açıklama	Varsayılan
total_tokens	Tamsayı

Durum Kodu: 200

Açıklama: Tamam

İçerik Türü	Türü	Açıklama
application/json	Nesne

Örnekler

Örnek

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

POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2024-10-21

{
 "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
        ]
      }
    ],
    "usage": {
      "prompt_tokens": 4,
      "total_tokens": 4
    }
  }
}

Sohbet tamamlamaları

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-21

Sohbet iletisi için tamamlama oluşturur

URI Parametreleri

Adı	Inç	Gerekli	Türü	Açıklama
Bitiş noktası	Yolu	Evet	Dize Url	OpenAI uç noktaları Azure desteklenir (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
deployment-id	Yolu	Evet	Dize	Dağıtılan modelin dağıtım kimliği.
api sürümü	Sorgu	Evet	Dize	API sürümü

İstek Üst Bilgisi

Adı	Gerekli	Türü	Açıklama
api-key	True	Dize	Burada Azure OpenAI API anahtarı sağlayın

İstek Gövdesi

İçerik Türü: application/json

Adı	Türü	Açıklama	Gerekli	Varsayılan
Sıcaklık	Numarası	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.	No	1
top_p	Numarası	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.	No	1
Akışı	Boolean	Ayarlanırsa, ChatGPT'deki gibi kısmi ileti değişimleri gönderilir. Belirteçler, kullanılabilir hale geldikçe yalnızca veri sunucu tarafından gönderilen olaylar olarak gönderilir ve akış bir `data: [DONE]` ileti tarafından sonlandırılır.	No	False
Durdurmak	dize veya dizi	API'nin başka belirteçler üretmeyi durduracağı en fazla dört dizi.	No
max_tokens	Tamsayı	Sohbet tamamlandığında oluşturulabilecek en fazla belirteç sayısı. Giriş belirteçlerinin ve oluşturulan belirteçlerin toplam uzunluğu modelin bağlam uzunluğuyla sınırlıdır.	No
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.	No
presence_penalty	Numarası	-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.	No	0
frequency_penalty	Numarası	-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.	No	0
logit_bias	Nesne	Belirtilen belirteçlerin tamamlanmada görünme olasılığını değiştirin. Belirteçleri (belirteç oluşturucudaki belirteç kimliğiyle belirtilen) -100'den 100'e ilişkilendirilmiş 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.	No	Hiçbiri
Kullanıcı	Dize	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ı.	No
Ileti	Dizi	Şu ana kadarki konuşmayı içeren iletilerin listesi.	Evet
data_sources	Dizi	Bunları kullanan Azure OpenAI sohbet uzantıları için yapılandırma girişleri. Bu ek belirtim yalnızca Azure OpenAI ile uyumludur.	No
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 `contentmessage`her çıkış belirtecinin günlük olasılıklarını döndürür.	No	False
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ı. `logprobs` bu parametre kullanılıyorsa olarak ayarlanmalıdır `true` .	No
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 ücretlendirileceksiniz. Maliyetleri en aza indirmek için farklı `1` tutun`n`.	No	1
parallel_tool_calls	ParallelToolCalls	Araç kullanımı sırasında paralel işlev çağrısının etkinleştirilip etkinleştirilmeyileceği.	No	True
response_format	ResponseFormatText veya ResponseFormatJsonObject veya ResponseFormatJsonSchema	Modelin çıkış yapması gereken biçimi belirten bir nesne. GPT-4o, GPT-4o mini, GPT-4 Turbo ve tüm GPT-3.5 Turbo modelleri ile `gpt-3.5-turbo-1106`uyumludur. ayarı, `{ "type": "json_schema", "json_schema": {...} }` modelin sağlanan JSON şemanızla eşleşeceğini garanti eden Yapılandırılmış Çıkışlar'ı etkinleştirir. ayarı `{ "type": "json_object" }` , modelin oluşturduğu iletinin geçerli JSON olduğunu garanti eden JSON modunu etkinleştirir. Önemli: JSON modunu kullanırken, modele bir sistem veya kullanıcı iletisi aracılığıyla kendiniz JSON üretmesini de belirtmeniz gerekir . Bu olmadan model, nesil belirteç sınırına ulaşana kadar bitmeyen bir boşluk akışı oluşturabilir ve bu da uzun süre çalışan ve görünüşe göre "takılmış" bir istekle sonuçlanır. Ayrıca, neslin aşıldığını veya konuşmanın maksimum bağlam uzunluğunu aştığını `max_tokens` gösteren ileti `finish_reason="length"`içeriğinin kısmen kesilebileceğini unutmayın.	No
Tohum	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.	No
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.	No
tool_choice	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.	No
function_call	string veya chatCompletionFunctionCallOption	yerine `tool_choice`kullanım dışı bırakıldı. Model tarafından çağrılan (varsa) işlevi denetler. `none` modelin işlev çağırmayacağı ve bunun yerine bir ileti oluşturduğu anlamına gelir. `auto` , modelin ileti oluşturma veya işlev çağırma arasında seçim yapabileceğiniz anlamına gelir. aracılığıyla `{"name": "my_function"}` belirli bir işlevin belirtilmesi, modeli bu işlevi çağırmaya zorlar. `none` , hiçbir işlev mevcut olmadığında varsayılan değerdir. `auto` , işlevler varsa varsayılan değerdir.	No
Işlev	Dizi	yerine `tools`kullanım dışı bırakıldı. Modelin JSON girişleri oluşturabileceği işlevlerin listesi.	No

Yanıt

Durum Kodu: 200

Açıklama: Tamam

İçerik Türü	Türü	Açıklama
application/json	createChatCompletionResponse veya createChatCompletionStreamResponse

Durum Kodu: varsayılan

Açıklama: Hizmet kullanılamıyor

İçerik Türü	Türü	Açıklama
application/json	errorResponse

Örnekler

Örnek

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

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-21

{
 "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? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye\u00e2\u20ac\u2122ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' \u00e2\u20ac\u2122bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!"
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Örnek

Azure Arama verilerine ve sistem tarafından atanan yönetilen kimliğe göre bir tamamlama oluşturur.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-21

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "index_name": "{index name}",
    "authentication": {
     "type": "system_assigned_managed_identity"
    }
   }
  }
 ]
}

Yanıtlar: Durum Kodu: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Örnek

Azure Arama vektör verilerini, önceki yardımcı iletisini ve kullanıcı tarafından atanan yönetilen kimliği temel alan bir tamamlama oluşturur.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-21

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a cat?"
  },
  {
   "role": "assistant",
   "content": "Content of the completion [doc1].",
   "context": {
    "intent": "cat care"
   }
  },
  {
   "role": "user",
   "content": "how about dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "authentication": {
     "type": "user_assigned_managed_identity",
     "managed_identity_resource_id": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resource-name}"
    },
    "index_name": "{index name}",
    "query_type": "vector",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "in_scope": true,
    "top_n_documents": 5,
    "strictness": 3,
    "role_information": "You are an AI assistant that helps people find information.",
    "fields_mapping": {
     "content_fields_separator": "\\n",
     "content_fields": [
      "content"
     ],
     "filepath_field": "filepath",
     "title_field": "title",
     "url_field": "url",
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

Yanıtlar: Durum Kodu: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content 2.",
                "title": "Citation Title 2",
                "filepath": "contoso2.txt",
                "url": "https://contoso.blob.windows.net/container/contoso2.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Örnek

Sağlanan Azure Cosmos DB için bir tamamlama oluşturur.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-21

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_cosmos_db",
   "parameters": {
    "authentication": {
     "type": "connection_string",
     "connection_string": "mongodb+srv://rawantest:{password}$@{cluster-name}.mongocluster.cosmos.azure.com/?tls=true&authMechanism=SCRAM-SHA-256&retrywrites=false&maxIdleTimeMS=120000"
    },
    "database_name": "vectordb",
    "container_name": "azuredocs",
    "index_name": "azuredocindex",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "content_fields": [
      "content"
     ],
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

Yanıtlar: Durum Kodu: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Transkripsiyonlar - Oluşturma

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2024-10-21

Sesi giriş diline ayırır.

URI Parametreleri

Adı	Inç	Gerekli	Türü	Açıklama
Bitiş noktası	Yolu	Evet	Dize Url	OpenAI uç noktaları Azure desteklenir (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
deployment-id	Yolu	Evet	Dize	Konuşmayı metin modeline dağıtma kimliği. Desteklenen modeller hakkında bilgi için bkz. [/azure/ai-foundry/openai/concepts/models#audio-models].
api sürümü	Sorgu	Evet	Dize	API sürümü

İstek Üst Bilgisi

Adı	Gerekli	Türü	Açıklama
api-key	True	Dize	Burada Azure OpenAI API anahtarı sağlayın

İstek Gövdesi

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

Adı	Türü	Açıklama	Gerekli	Varsayılan
Dosya	Dize	Dökümü yapılan ses dosyası nesnesi.	Evet
Istemi	Dize	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.	No
response_format	audioResponseFormat	Çıkışın biçimini tanımlar.	No
Sıcaklık	Numarası	Ö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.	No	0
Dil	Dize	Giriş sesinin dili. Giriş dilini ISO-639-1 biçiminde sağlamak doğruluğu ve gecikme süresini artırır.	No

Yanıt

Durum Kodu: 200

Açıklama: Tamam

İçerik Türü	Türü	Açıklama
application/json	audioResponse veya audioVerboseResponse
metin/düz	Dize	Çıktı biçimindeki metinlerin dökümünü alın (response_format metin, vtt veya srt'lerden biri olduğunda).

Örnekler

Örnek

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

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2024-10-21

Yanıtlar: Durum Kodu: 200

{
  "body": {
    "text": "A structured object when requesting json or verbose_json"
  }
}

Örnek

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

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2024-10-21

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

Yanıtlar: Durum Kodu: 200

{
  "type": "string",
  "example": "plain text when requesting text, srt, or vtt"
}

Çeviriler - Oluşturma

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2024-10-21

Giriş sesinin dökümünü alır ve İngilizce metne çevirir.

URI Parametreleri

Adı	Inç	Gerekli	Türü	Açıklama
Bitiş noktası	Yolu	Evet	Dize Url	OpenAI uç noktaları Azure desteklenir (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
deployment-id	Yolu	Evet	Dize	Dağıtılan fısıltı modelinin dağıtım kimliği. Desteklenen modeller hakkında bilgi için bkz. [/azure/ai-foundry/openai/concepts/models#audio-models].
api sürümü	Sorgu	Evet	Dize	API sürümü

İstek Üst Bilgisi

Adı	Gerekli	Türü	Açıklama
api-key	True	Dize	Burada Azure OpenAI API anahtarı sağlayın

İstek Gövdesi

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

Adı	Türü	Açıklama	Gerekli	Varsayılan
Dosya	Dize	Çevrilecek ses dosyası.	Evet
Istemi	Dize	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.	No
response_format	audioResponseFormat	Çıkışın biçimini tanımlar.	No
Sıcaklık	Numarası	Ö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.	No	0

Yanıt

Durum Kodu: 200

Açıklama: Tamam

İçerik Türü	Türü	Açıklama
application/json	audioResponse veya audioVerboseResponse
metin/düz	Dize	Çıktı biçimindeki metinlerin dökümünü alın (response_format metin, vtt veya srt'lerden biri olduğunda).

Örnekler

Örnek

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

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2024-10-21

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

Yanıtlar: Durum Kodu: 200

{
  "body": {
    "text": "A structured object when requesting json or verbose_json"
  }
}

Örnek

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

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2024-10-21

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

Yanıtlar: Durum Kodu: 200

{
  "type": "string",
  "example": "plain text when requesting text, srt, or vtt"
}

Görüntü oluşturma

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2024-10-21

Belirli bir dall-e modeli dağıtımında metin başlığından bir toplu görüntü oluşturur

URI Parametreleri

Adı	Inç	Gerekli	Türü	Açıklama
Bitiş noktası	Yolu	Evet	Dize Url	OpenAI uç noktaları Azure desteklenir (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
deployment-id	Yolu	Evet	Dize	Dağıtılan dall-e modelinin dağıtım kimliği.
api sürümü	Sorgu	Evet	Dize	API sürümü

İstek Üst Bilgisi

Adı	Gerekli	Türü	Açıklama
api-key	True	Dize	Burada Azure OpenAI API anahtarı sağlayın

İstek Gövdesi

İçerik Türü: application/json

Adı	Türü	Açıklama	Gerekli	Varsayılan
Istemi	Dize	İstenen resimlerin metin açıklaması. Uzunluk üst sınırı 4.000 karakterdir.	Evet
n	Tamsayı	Oluşturulacak görüntü sayısı.	No	1
Boyutu	ımagesize	Oluşturulan görüntülerin boyutu.	No	1024x1024
response_format	imagesResponseFormat	Oluşturulan görüntülerin döndürüldiği biçim.	No	Url
Kullanıcı	Dize	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ı.	No
Kalite	imageQuality	Oluşturulacak görüntünün kalitesi.	No	Standart
Stil	imageStyle	Oluşturulan görüntülerin stili.	No	Canlı

Yanıt

Durum Kodu: 200

Açıklama: Tamam

İçerik Türü	Türü	Açıklama
application/json	generateImagesResponse

Durum Kodu: varsayılan

Açıklama: Bir hata oluştu.

İçerik Türü	Türü	Açıklama
application/json	dalleErrorResponse

Örnekler

Örnek

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

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2024-10-21

{
 "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
          }
        },
        "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
          }
        }
      }
    ]
  }
}

Bileşen

errorResponse

Adı	Türü	Açıklama	Gerekli	Varsayılan
Hata	Hata		No

errorBase

Adı	Türü	Açıklama	Gerekli	Varsayılan
Kod	Dize		No
İleti	Dize		No

Hata

Adı	Türü	Açıklama	Gerekli
param	Dize		No
Türü	Dize		No
inner_error	innerError	Ek ayrıntılar içeren iç hata.	No

innerError

Ek ayrıntılar içeren iç hata.

Adı	Türü	Açıklama	Gerekli	Varsayılan
Kod	innerErrorCode	İç hata nesnesi için hata kodları.	No
content_filter_results	contentFilterPromptResults	İçerik filtreleme kategorisi (nefret, cinsel, şiddet, self_harm), algılanıp algılanmadığı, önem düzeyi (zararlı içeriğin yoğunluğunu ve risk düzeyini belirleyen very_low, düşük, orta, yüksek ölçekli) ve filtrelenip filtrelenmediği hakkında bilgi. Jailbreak içeriği ve küfür, algılanıp algılanmadığı ve filtrelenip filtrelenmediği hakkında bilgiler. Filtrelenip filtrelenmediği ve kimliği olan müşteri blok listesi hakkındaki bilgileri de bulabilirsiniz.	No

innerErrorCode

İç hata nesnesi için hata kodları.

Açıklama: İç hata nesnesi için hata kodları.

Tür: dize

Varsayılan:

Enum Adı: InnerErrorCode

Sabit Listesi Değerleri:

Değer	Açıklama
ResponsibleAIPolicyViolation	İstem, diğer içerik filtresi kurallarından birini ihlal etti.

dalleErrorResponse

Adı	Türü	Açıklama	Gerekli	Varsayılan
Hata	dalleError		No

dalleError

Adı	Türü	Açıklama	Gerekli
param	Dize		No
Türü	Dize		No
inner_error	dalleInnerError	Ek ayrıntılar içeren iç hata.	No

dalleInnerError

Ek ayrıntılar içeren iç hata.

Adı	Türü	Açıklama	Gerekli
Kod	innerErrorCode	İç hata nesnesi için hata kodları.	No
content_filter_results	dalleFilterResults	İçerik filtreleme kategorisi (nefret, cinsel, şiddet, self_harm), algılanıp algılanmadığı, önem düzeyi (zararlı içeriğin yoğunluğunu ve risk düzeyini belirleyen very_low, düşük, orta, yüksek ölçekli) ve filtrelenip filtrelenmediği hakkında bilgi. Jailbreak içeriği ve küfür, algılanıp algılanmadığı ve filtrelenip filtrelenmediği hakkında bilgiler. Filtrelenip filtrelenmediği ve kimliği olan müşteri blok listesi hakkındaki bilgileri de bulabilirsiniz.	No
revised_prompt	Dize	İstemde herhangi bir düzeltme varsa, görüntüyü oluşturmak için kullanılan istem.	No

contentFilterResultBase

Adı	Türü	Açıklama	Gerekli	Varsayılan
Filtre	Boolean		Evet

contentFilterSeverityResult

Adı	Türü	Açıklama	Gerekli	Varsayılan
Filtre	Boolean		Evet
Önem	Dize		No

contentFilterDetectedResult

Adı	Türü	Açıklama	Gerekli	Varsayılan
Filtre	Boolean		Evet
Algılandı	Boolean		No

contentFilterDetectedWithCitationResult

Adı	Türü	Açıklama	Gerekli	Varsayılan
Alıntı	Nesne		No

Alıntı özellikleri

URL

Adı	Türü	Açıklama	Varsayılan
URL	Dize

Lisans

Adı	Türü	Açıklama	Varsayılan
Lisans	Dize

contentFilterResultsBase

İçerik filtreleme sonuçları hakkında bilgi.

Adı	Türü	Gerekli
Cinsel	contentFilterSeverityResult	No
Şiddet	contentFilterSeverityResult	No
Nefret	contentFilterSeverityResult	No
self_harm	contentFilterSeverityResult	No
Küfür	contentFilterDetectedResult	No
Hata	errorBase	No

contentFilterPromptResults

İçerik filtreleme kategorisi (nefret, cinsel, şiddet, self_harm), algılanıp algılanmadığı, önem düzeyi (zararlı içeriğin yoğunluğunu ve risk düzeyini belirleyen very_low, düşük, orta, yüksek ölçekli) ve filtrelenip filtrelenmediği hakkında bilgi. Jailbreak içeriği ve küfür, algılanıp algılanmadığı ve filtrelenip filtrelenmediği hakkında bilgiler. Filtrelenip filtrelenmediği ve kimliği olan müşteri blok listesi hakkındaki bilgileri de bulabilirsiniz.

Adı	Türü	Gerekli
Cinsel	contentFilterSeverityResult	No
Şiddet	contentFilterSeverityResult	No
Nefret	contentFilterSeverityResult	No
self_harm	contentFilterSeverityResult	No
Küfür	contentFilterDetectedResult	No
Hata	errorBase	No
Jailbreak	contentFilterDetectedResult	No

contentFilterChoiceResults

İçerik filtreleme kategorisi (nefret, cinsel, şiddet, self_harm), algılanıp algılanmadığı, önem düzeyi (zararlı içeriğin yoğunluğunu ve risk düzeyini belirleyen very_low, düşük, orta, yüksek ölçekli) ve filtrelenip filtrelenmediği hakkında bilgi. Üçüncü taraf metin ve küfür, algılanıp algılanmadığı ve filtrelenip filtrelenmediği hakkında bilgiler. Filtrelenip filtrelenmediği ve kimliği olan müşteri blok listesi hakkındaki bilgileri de bulabilirsiniz.

Adı	Türü	Gerekli
Cinsel	contentFilterSeverityResult	No
Şiddet	contentFilterSeverityResult	No
Nefret	contentFilterSeverityResult	No
self_harm	contentFilterSeverityResult	No
Küfür	contentFilterDetectedResult	No
Hata	errorBase	No
protected_material_text	contentFilterDetectedResult	No
protected_material_code	contentFilterDetectedWithCitationResult	No

promptFilterResult

İstekteki tek bir istem için içerik filtreleme sonuçları.

Adı	Türü	Açıklama	Gerekli	Varsayılan
prompt_index	Tamsayı		No
content_filter_results	contentFilterPromptResults	İçerik filtreleme kategorisi (nefret, cinsel, şiddet, self_harm), algılanıp algılanmadığı, önem düzeyi (zararlı içeriğin yoğunluğunu ve risk düzeyini belirleyen very_low, düşük, orta, yüksek ölçekli) ve filtrelenip filtrelenmediği hakkında bilgi. Jailbreak içeriği ve küfür, algılanıp algılanmadığı ve filtrelenip filtrelenmediği hakkında bilgiler. Filtrelenip filtrelenmediği ve kimliği olan müşteri blok listesi hakkındaki bilgileri de bulabilirsiniz.	No

promptFilterResults

İstekte sıfır veya daha fazla istem için içerik filtreleme sonuçları. Akış isteğinde, farklı istemlerin sonuçları farklı zamanlarda veya farklı siparişlerde gelebilir.

Bu bileşen için tanımlı özellik yok.

dalleContentFilterResults

İçerik filtreleme sonuçları hakkında bilgi.

Adı	Türü	Gerekli
Cinsel	contentFilterSeverityResult	No
Şiddet	contentFilterSeverityResult	No
Nefret	contentFilterSeverityResult	No
self_harm	contentFilterSeverityResult	No

dalleFilterResults

Adı	Türü	Gerekli
Cinsel	contentFilterSeverityResult	No
Şiddet	contentFilterSeverityResult	No
Nefret	contentFilterSeverityResult	No
self_harm	contentFilterSeverityResult	No
Küfür	contentFilterDetectedResult	No
Jailbreak	contentFilterDetectedResult	No

chatCompletionsRequestCommon

Adı	Türü	Açıklama	Gerekli	Varsayılan
Sıcaklık	Numarası	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.	No	1
top_p	Numarası	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.	No	1
Akışı	Boolean	Ayarlanırsa, ChatGPT'deki gibi kısmi ileti değişimleri gönderilir. Belirteçler, kullanılabilir hale geldikçe yalnızca veri sunucu tarafından gönderilen olaylar olarak gönderilir ve akış bir `data: [DONE]` ileti tarafından sonlandırılır.	No	False
Durdurmak	dize veya dizi	API'nin başka belirteçler üretmeyi durduracağı en fazla dört dizi.	No
max_tokens	Tamsayı	Oluşturulan yanıt için izin verilen en fazla belirteç sayısı. Varsayılan olarak, modelin döndürebileceği belirteç sayısı olacaktır (4096 - istem belirteçleri). Bu değer artık yerine kullanım dışı bırakılmıştır `max_completion_tokens`ve o1 serisi modelleriyle uyumlu değildir.	No	4096
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.	No
presence_penalty	Numarası	-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.	No	0
frequency_penalty	Numarası	-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.	No	0
logit_bias	Nesne	Belirtilen belirteçlerin tamamlanmada görünme olasılığını değiştirin. Belirteçleri (belirteç oluşturucudaki belirteç kimliğiyle belirtilen) -100'den 100'e ilişkilendirilmiş bir sapma değeriyle eşleyen bir json nesnesini 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.	No
Kullanıcı	Dize	Uygunsuz kullanımı izlemek ve algılamak için OpenAI'Azure yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı.	No

createCompletionRequest

Adı	Türü	Açıklama	Gerekli	Varsayılan
Istemi	dize veya dizi	Dize olarak kodlanmış, dize dizisi, belirteç dizisi veya belirteç dizi dizisi için tamamlamalar oluşturma istemi. \|endoftext\|> öğesinin<, modelin eğitim sırasında gördüğü belge ayırıcısı olduğunu unutmayın. Bu nedenle, bir istem belirtilmezse model, yeni belgenin başından itibaren oluşturulmuş gibi oluşturulur.	Evet
best_of	Tamsayı	Tamamlamaları `best_of` sunucu tarafı oluşturur ve "en iyi" değerini (belirteç başına en yüksek günlük olasılığına sahip olan) döndürür. Sonuçlar akışla aktarılamaz. ile `n`kullanıldığında, `best_of` aday tamamlama sayısını denetler ve `n` döndürülecek sayı sayısını belirtir â€" `best_of` değerinin değerinden `n`büyük olması gerekir. Not: Bu parametre birçok tamamlama oluşturduğundan, belirteç kotanızı hızla kullanabilir. dikkatle kullanın ve ve `stop`için `max_tokens` makul ayarlara sahip olduğunuzdan emin olun.	No	1
Yankı	Boolean	Tamamlamaya ek olarak istemi geri yankıla	No	False
frequency_penalty	Numarası	-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.	No	0
logit_bias	Nesne	Belirtilen belirteçlerin tamamlanmada görünme olasılığını değiştirin. Belirteçleri (GPT belirteç oluşturucusunda belirteç kimliğiyle belirtilen) -100 ile 100 arasındaki ilişkili bir sapma değeriyle eşleyen bir JSON nesnesini kabul eder. Matematiksel olarak sapma, örneklemeden önce model tarafından oluşturulan logit'lere eklenir. Tam etki modele göre değişir, ancak -1 ile 1 arasındaki değerler seçim olasılığını azaltmalı veya artırmalıdır; -100 veya 100 gibi değerler, ilgili belirtecin yasaklanması veya özel olarak seçilmesiyle sonuçlanmalıdır. Örneğin, \|endoftext\|> belirtecinin oluşturulmasını <önlemek için geçirebilirsiniz`{"50256": -100}`.	No	Hiçbiri
logprobs	Tamsayı	Günlük olasılıklarını `logprobs` en olası çıkış belirteçlerine ve seçilen belirteçlere ekleyin. Örneğin, 5 ise `logprobs` , API en olası beş belirtecin listesini döndürür. API her zaman örneklenen belirtecin değerini döndürür `logprob` , bu nedenle yanıtta en `logprobs+1` fazla öğe olabilir. için `logprobs` en büyük değer 5'tir.	No	Hiçbiri
max_tokens	Tamsayı	Tamamlanma sırasında oluşturulabilecek en fazla belirteç sayısı. İsteminizin ve artı `max_tokens` değerin belirteç sayısı modelin bağlam uzunluğunu aşamaz.	No	16
n	Tamsayı	Her istem için kaç tamamlama oluşturulacağı. Not: Bu parametre birçok tamamlama oluşturduğundan, belirteç kotanızı hızla kullanabilir. dikkatle kullanın ve ve `stop`için `max_tokens` makul ayarlara sahip olduğunuzdan emin olun.	No	1
presence_penalty	Numarası	-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.	No	0
Tohum	Tamsayı	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.	No
Durdurmak	dize veya dizi	API'nin başka belirteçler üretmeyi durduracağı en fazla dört dizi. Döndürülen metin durdurma sırasını içermez.	No
Akışı	Boolean	Kısmi ilerlemenin akışla geri aktarılıp aktarılmayacağı. Ayarlanırsa, belirteçler kullanılabilir hale geldikçe yalnızca veri sunucu tarafından gönderilen olaylar olarak gönderilir ve akış bir `data: [DONE]` ileti tarafından sonlandırılır.	No	False
Soneki	Dize	Eklenen metnin tamamlanmasından sonra gelen sonek. Bu parametre yalnızca için `gpt-3.5-turbo-instruct`desteklenir.	No	Hiçbiri
Sıcaklık	Numarası	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.	No	1
top_p	Numarası	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.	No	1
Kullanıcı	Dize	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ı.	No

createCompletionResponse

API'den bir tamamlama yanıtını temsil eder. Not: Hem akışlı hem de akışsız yanıt nesneleri aynı şekli paylaşır (sohbet uç noktasından farklı olarak).

Adı	Türü	Açıklama	Gerekli
Kimliği	Dize	Tamamlanma için benzersiz bir tanımlayıcı.	Evet
Seçenek	Dizi	Giriş istemi için modelin oluşturduğu tamamlama seçeneklerinin listesi.	Evet
Oluşturulan	Tamsayı	Tamamlanmanın oluşturulduğu Unix zaman damgası (saniye olarak).	Evet
Modeli	Dize	Tamamlanmak için kullanılan model.	Evet
prompt_filter_results	promptFilterResults	İstekte sıfır veya daha fazla istem için içerik filtreleme sonuçları. Akış isteğinde, farklı istemlerin sonuçları farklı zamanlarda veya farklı siparişlerde gelebilir.	No
system_fingerprint	Dize	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.	No
Nesne	Enum	Her zaman "text_completion" olan nesne türü Olası değerler: text_completion	Evet
Kullanım	completionUsage	Tamamlanma isteği için kullanım istatistikleri.	No

createChatCompletionRequest

Adı	Türü	Açıklama	Gerekli	Varsayılan
Sıcaklık	Numarası	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.	No	1
top_p	Numarası	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.	No	1
Akışı	Boolean	Ayarlanırsa, ChatGPT'deki gibi kısmi ileti değişimleri gönderilir. Belirteçler, kullanılabilir hale geldikçe yalnızca veri sunucu tarafından gönderilen olaylar olarak gönderilir ve akış bir `data: [DONE]` ileti tarafından sonlandırılır.	No	False
Durdurmak	dize veya dizi	API'nin başka belirteçler üretmeyi durduracağı en fazla dört dizi.	No
max_tokens	Tamsayı	Sohbet tamamlandığında oluşturulabilecek en fazla belirteç sayısı. Giriş belirteçlerinin ve oluşturulan belirteçlerin toplam uzunluğu modelin bağlam uzunluğuyla sınırlıdır.	No
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.	No
presence_penalty	Numarası	-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.	No	0
frequency_penalty	Numarası	-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.	No	0
logit_bias	Nesne	Belirtilen belirteçlerin tamamlanmada görünme olasılığını değiştirin. Belirteçleri (belirteç oluşturucudaki belirteç kimliğiyle belirtilen) -100'den 100'e ilişkilendirilmiş 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.	No	Hiçbiri
Kullanıcı	Dize	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ı.	No
Ileti	Dizi	Şu ana kadarki konuşmayı içeren iletilerin listesi.	Evet
data_sources	Dizi	Bunları kullanan Azure OpenAI sohbet uzantıları için yapılandırma girişleri. Bu ek belirtim yalnızca Azure OpenAI ile uyumludur.	No
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 `contentmessage`her çıkış belirtecinin günlük olasılıklarını döndürür.	No	False
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ı. `logprobs` bu parametre kullanılıyorsa olarak ayarlanmalıdır `true` .	No
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 ücretlendirileceksiniz. Maliyetleri en aza indirmek için farklı `1` tutun`n`.	No	1
parallel_tool_calls	ParallelToolCalls	Araç kullanımı sırasında paralel işlev çağrısının etkinleştirilip etkinleştirilmeyileceği.	No	True
response_format	ResponseFormatText veya ResponseFormatJsonObject veya ResponseFormatJsonSchema	Modelin çıkış yapması gereken biçimi belirten bir nesne. GPT-4o, GPT-4o mini, GPT-4 Turbo ve tüm GPT-3.5 Turbo modelleri ile `gpt-3.5-turbo-1106`uyumludur. ayarı, `{ "type": "json_schema", "json_schema": {...} }` modelin sağlanan JSON şemanızla eşleşeceğini garanti eden Yapılandırılmış Çıkışlar'ı etkinleştirir. ayarı `{ "type": "json_object" }` , modelin oluşturduğu iletinin geçerli JSON olduğunu garanti eden JSON modunu etkinleştirir. Önemli: JSON modunu kullanırken, modele bir sistem veya kullanıcı iletisi aracılığıyla kendiniz JSON üretmesini de belirtmeniz gerekir . Bu olmadan model, nesil belirteç sınırına ulaşana kadar bitmeyen bir boşluk akışı oluşturabilir ve bu da uzun süre çalışan ve görünüşe göre "takılmış" bir istekle sonuçlanır. Ayrıca, neslin aşıldığını veya konuşmanın maksimum bağlam uzunluğunu aştığını `max_tokens` gösteren ileti `finish_reason="length"`içeriğinin kısmen kesilebileceğini unutmayın.	No
Tohum	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.	No
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.	No
tool_choice	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.	No
function_call	string veya chatCompletionFunctionCallOption	yerine `tool_choice`kullanım dışı bırakıldı. Model tarafından çağrılan (varsa) işlevi denetler. `none` modelin işlev çağırmayacağı ve bunun yerine bir ileti oluşturduğu anlamına gelir. `auto` , modelin ileti oluşturma veya işlev çağırma arasında seçim yapabileceğiniz anlamına gelir. aracılığıyla `{"name": "my_function"}` belirli bir işlevin belirtilmesi, modeli bu işlevi çağırmaya zorlar. `none` , hiçbir işlev mevcut olmadığında varsayılan değerdir. `auto` , işlevler varsa varsayılan değerdir.	No
Işlev	Dizi	yerine `tools`kullanım dışı bırakıldı. Modelin JSON girişleri oluşturabileceği işlevlerin listesi.	No

chatCompletionFunctions

Adı	Türü	Açıklama	Gerekli
Açıklama	Dize	İşlevin ne zaman ve nasıl çağrıldığını seçmek için model tarafından kullanılan işlevin ne yaptığının açıklaması.	No
Adı	Dize	Ç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
Parametre	FunctionParameters	İşlevlerin kabullediği, JSON Şeması nesnesi olarak tanımlanan parametreler. Örnekler için kılavuza ve biçimle ilgili belgeler için JSON Şeması başvurusuna bakın. Atlama `parameters` , boş parametre listesi olan bir işlevi tanımlar.	No

chatCompletionFunctionCallOption

aracılığıyla {"name": "my_function"} belirli bir işlevin belirtilmesi, modeli bu işlevi çağırmaya zorlar.

Adı	Türü	Açıklama	Gerekli	Varsayılan
Adı	Dize	Çağrılacak işlevin adı.	Evet

chatCompletionRequestMessage

Bu bileşen aşağıdakilerden biri olabilir:

chatCompletionRequestSystemMessage

Adı	Türü	Açıklama	Gerekli
Içerik	dize veya dizi	Sistem iletisinin içeriği.	Evet
Rolü	Enum	İleti yazarının rolü( bu örnekte `system`). Olası değerler: sistem	Evet
Adı	Dize	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.	No

chatCompletionRequestUserMessage

Adı	Türü	Açıklama	Gerekli
Içerik	dize veya dizi	Kullanıcı iletisinin içeriği.	Evet
Rolü	Enum	İleti yazarının rolü( bu örnekte `user`). Olası değerler: kullanıcı	Evet
Adı	Dize	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.	No

chatCompletionRequestAssistantMessage

Adı	Türü	Açıklama	Gerekli
Içerik	dize veya dizi	Yardımcı iletisinin içeriği. Veya belirtilmediği sürece `tool_callsfunction_call` gereklidir.	No
Ret	Dize	Asistanın reddetme mesajı.	No
Rolü	Enum	İleti yazarının rolü( bu örnekte `assistant`). Olası değerler: yardımcı	Evet
Adı	Dize	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.	No
tool_calls	chatCompletionMessageToolCalls	Araç, işlev çağrıları gibi model tarafından oluşturulan çağrılar.	No
function_call	Nesne	kullanım dışı bırakıldı ve tarafından `tool_calls`değiştirildi. Model tarafından oluşturulduğu gibi çağrılması gereken bir işlevin adı ve bağımsız değişkenleri.	No

function_call özellikleri

Bağımsız değişken

Adı	Türü	Açıklama	Varsayılan
Bağımsız değişken	Dize	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 parametreler oluşturabileceğini unutmayın. İşlevinizi çağırmadan önce kodunuzdaki bağımsız değişkenleri doğrulayın.

Adı

Adı	Türü	Açıklama	Varsayılan
Adı	Dize	Çağrılacak işlevin adı.

chatCompletionRequestToolMessage

Adı	Türü	Açıklama	Gerekli
Rolü	Enum	İleti yazarının rolü( bu örnekte `tool`). Olası değerler: araç	Evet
Içerik	dize veya dizi	Araç iletisinin içeriği.	Evet
tool_call_id	Dize	Bu iletinin yanıt verdiği araç çağrısı.	Evet

chatCompletionRequestFunctionMessage

Adı	Türü	Açıklama	Gerekli
Rolü	Enum	İleti yazarının rolü( bu örnekte `function`). Olası değerler: işlev	Evet
Içerik	Dize	İşlev iletisinin içeriği.	Evet
Adı	Dize	Çağrılacak işlevin adı.	Evet

chatCompletionRequestSystemMessageContentPart

Bu bileşen aşağıdakilerden biri olabilir:

chatCompletionRequestUserMessageContentPart

Bu bileşen aşağıdakilerden biri olabilir:

chatCompletionRequestAssistantMessageContentPart

Bu bileşen aşağıdakilerden biri olabilir:

chatCompletionRequestToolMessageContentPart

Bu bileşen aşağıdakilerden biri olabilir:

chatCompletionRequestMessageContentPartText

Adı	Türü	Açıklama	Gerekli	Varsayılan
Türü	Enum	İçerik bölümünün türü. Olası değerler: metin	Evet
Metin	Dize	Metin içeriği.	Evet

chatCompletionRequestMessageContentPartImage

Adı	Türü	Açıklama	Gerekli	Varsayılan
Türü	Enum	İçerik bölümünün türü. Olası değerler: image_url	Evet
image_url	Nesne		Evet

image_url özellikleri

Url

Adı	Türü	Açıklama	Varsayılan
Url	Dize	Görüntünün URL'si veya base64 kodlanmış görüntü verileri.

Ayrıntı

Adı	Türü	Açıklama	Varsayılan
Ayrıntı	Dize	Görüntünün ayrıntı düzeyini belirtir. Görüntü İşleme kılavuzunda daha fazla bilgi edinin.	Otomatik

chatCompletionRequestMessageContentPartRefusal

Adı	Türü	Açıklama	Gerekli	Varsayılan
Türü	Enum	İçerik bölümünün türü. Olası değerler: reddetme	Evet
Ret	Dize	Model tarafından oluşturulan reddetme iletisi.	Evet

azureChatExtensionConfiguration

Tek bir Azure OpenAI sohbet uzantısı 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.

Adı	Türü	Açıklama	Gerekli	Varsayılan
Türü	azureChatExtensionType	Tek bir Azure OpenAI sohbet uzantısı için yapılandırma verilerinin gösterimi. Bu, bir sohbet tarafından kullanılır yanıt davranışını artırmak için Azure OpenAI sohbet uzantılarını kullanması gereken tamamlama isteği. Bu yapılandırmanın kullanımı yalnızca Azure OpenAI ile uyumludur.	Evet

azureChatExtensionType

Description: Tek bir Azure OpenAI sohbet uzantısı 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.

Tür: dize

Varsayılan:

Sabit Listesi Adı: AzureChatExtensionType

Sabit Listesi Değerleri:

Değer	Açıklama
azure_search	Azure Arama'nın Azure OpenAI sohbet uzantısı olarak kullanımını temsil eder.
azure_cosmos_db	Azure OpenAI sohbet uzantısı olarak Azure Cosmos DB kullanımını temsil eder.

azureSearchChatExtensionConfiguration

Azure OpenAI sohbet uzantısı olarak kullanırken Azure Arama için yapılandırılabilir seçeneklerin belirli bir gösterimi.

Adı	Türü	Açıklama	Gerekli	Varsayılan
Türü	azureChatExtensionType	Tek bir Azure OpenAI sohbet uzantısı için yapılandırma verilerinin gösterimi. Bu, bir sohbet tarafından kullanılır yanıt davranışını artırmak için Azure OpenAI sohbet uzantılarını kullanması gereken tamamlama isteği. Bu yapılandırmanın kullanımı yalnızca Azure OpenAI ile uyumludur.	Evet
Parametre	azureSearchChatExtensionParameters	Azure OpenAI sohbet uzantısı olarak kullanıldığında Azure Arama parametreleri.	No

azureSearchChatExtensionParameters

Azure OpenAI sohbet uzantısı olarak kullanıldığında Azure Arama parametreleri.

Adı	Türü	Açıklama	Gerekli
Kimlik doğrulama	onYourDataApiKeyAuthenticationOptions veya onYourDataSystemAssignedManagedIdentityAuthenticationOptions veya onYourDataUserAssignedManagedIdentityAuthenticationOptions		Evet
top_n_documents	Tamsayı	Yapılandırılan sorgu için öne çıkan en fazla belge sayısı.	No
in_scope	Boolean	Sorguların dizine alınan verilerin kullanımıyla sınırlandırılıp kısıtlanmaması gerektiği.	No
katılık	Tamsayı	Arama ilgi filtresinin yapılandırılmış katılığı. Katılık ne kadar yüksekse, duyarlık o kadar yüksektir ancak yanıtın daha düşük geri çağrılır.	No
role_information	Dize	Modele nasıl davranması gerektiği ve yanıt oluştururken başvurması gereken bağlamlar hakkında yönergeler verin. Yardımcının kişiliğini açıklayabilir ve yanıtları nasıl biçimlendirebileceğini anlatabilirsiniz. Bunun için 100 belirteç sınırı vardır ve genel belirteç sınırına göre sayılır.	No
Bitiş noktası	Dize	Kullanılacak Azure Arama kaynağının mutlak uç nokta yolu.	Evet
index_name	Dize	Başvuruda bulunulan Azure Arama kaynağında kullanılabilir olarak kullanılacak dizinin adı.	Evet
fields_mapping	azureSearchIndexFieldMappingOptions	Yapılandırılmış bir Azure Arama kaynağı kullanılırken alanların nasıl işlendiğini denetlemek için isteğe bağlı ayarlar.	No
query_type	azureSearchQueryType	Azure OpenAI sohbet uzantısı olarak kullanılırken yürütülmesi gereken Azure Arama alma sorgusunun türü.	No
semantic_configuration	Dize	Sorgu için ek anlamsal yapılandırma.	No
Filtre	Dize	Arama filtresi.	No
embedding_dependency	onYourDataEndpointVectorizationSource veya onYourDataDeploymentNameVectorizationSource		No

azureSearchIndexFieldMappingOptions

Yapılandırılmış bir Azure Arama kaynağı kullanılırken alanların nasıl işlendiğini denetlemek için isteğe bağlı ayarlar.

Adı	Türü	Açıklama	Gerekli
title_field	Dize	Başlık olarak kullanılacak dizin alanının adı.	No
url_field	Dize	URL olarak kullanılacak dizin alanının adı.	No
filepath_field	Dize	Dosya yolu olarak kullanılacak dizin alanının adı.	No
content_fields	Dizi	İçerik olarak ele alınması gereken dizin alanlarının adları.	No
content_fields_separator	Dize	İçerik alanlarının kullanması gereken ayırıcı desen.	No
vector_fields	Dizi	Vektör verilerini temsil eden alanların adları.	No

azureSearchQueryType

Azure OpenAI sohbet uzantısı olarak kullanılırken yürütülmesi gereken Azure Arama alma sorgusunun türü.

Description: Azure OpenAI sohbet uzantısı olarak kullanılırken yürütülmesi gereken Azure Arama alma sorgusunun türü.

Tür: dize

Varsayılan:

Sabit Listesi Adı: AzureSearchQueryType

Sabit Listesi Değerleri:

Değer	Açıklama
Basit	Varsayılan, basit sorgu ayrıştırıcısını temsil eder.
Semantik	Gelişmiş anlamsal modelleme için anlamsal sorgu ayrıştırıcısını temsil eder.
Vektör	Hesaplanan veriler üzerinde vektör aramalarını temsil eder.
vector_simple_hybrid	Vektör verileriyle basit sorgu stratejisinin bir birleşimini temsil eder.
vector_semantic_hybrid	Anlamsal arama ve vektör verileri sorgulamanın bir bileşimini temsil eder.

azureCosmosDBChatExtensionConfiguration

Azure OpenAI sohbet uzantısı olarak kullanılırken Azure Cosmos DB için yapılandırılabilir seçeneklerin belirli bir gösterimi.

Adı	Türü	Açıklama	Gerekli	Varsayılan
Türü	azureChatExtensionType	Tek bir Azure OpenAI sohbet uzantısı için yapılandırma verilerinin gösterimi. Bu, bir sohbet tarafından kullanılır yanıt davranışını artırmak için Azure OpenAI sohbet uzantılarını kullanması gereken tamamlama isteği. Bu yapılandırmanın kullanımı yalnızca Azure OpenAI ile uyumludur.	Evet
Parametre	azureCosmosDBChatExtensionParameters	için Azure Cosmos DB kullanırken Verinizde OpenAI Azure sohbet uzantılarını yapılandırırken kullanılacak parametreler MongoDB sanal çekirdeği.	No

azureCosmosDBChatExtensionParameters

MongoDB sanal çekirdeği için Azure Cosmos DB kullanırken Veri sohbeti uzantılarınızda OpenAI Azure yapılandırırken kullanılacak parametreler.

Adı	Türü	Açıklama	Gerekli
Kimlik doğrulama	onYourDataConnectionStringAuthenticationOptions	bağlantı dizesi kullanırken Verilerinizde OpenAI Azure için kimlik doğrulama seçenekleri.	Evet
top_n_documents	Tamsayı	Yapılandırılan sorgu için öne çıkan en fazla belge sayısı.	No
in_scope	Boolean	Sorguların dizine alınan verilerin kullanımıyla sınırlandırılıp kısıtlanmaması gerektiği.	No
katılık	Tamsayı	Arama ilgi filtresinin yapılandırılmış katılığı. Katılık ne kadar yüksekse, duyarlık o kadar yüksektir ancak yanıtın daha düşük geri çağrılır.	No
role_information	Dize	Modele nasıl davranması gerektiği ve yanıt oluştururken başvurması gereken bağlamlar hakkında yönergeler verin. Yardımcının kişiliğini açıklayabilir ve yanıtları nasıl biçimlendirebileceğini anlatabilirsiniz. Bunun için 100 belirteç sınırı vardır ve genel belirteç sınırına göre sayılır.	No
Veritabanı_adı	Dize	Azure Cosmos DB ile kullanılacak MongoDB sanal çekirdek veritabanı adı.	Evet
container_name	Dize	Azure Cosmos DB kaynak kapsayıcısının adı.	Evet
index_name	Dize	Azure Cosmos DB ile kullanılacak MongoDB sanal çekirdek dizin adı.	Evet
fields_mapping	azureCosmosDBFieldMappingOptions	Yapılandırılmış Azure Cosmos DB kaynağı kullanılırken alanların nasıl işlendiğini denetlemek için isteğe bağlı ayarlar.	Evet
embedding_dependency	onYourDataEndpointVectorizationSource veya onYourDataDeploymentNameVectorizationSource		Evet

azureCosmosDBFieldMappingOptions

Yapılandırılmış Azure Cosmos DB kaynağı kullanılırken alanların nasıl işlendiğini denetlemek için isteğe bağlı ayarlar.

Adı	Türü	Açıklama	Gerekli
title_field	Dize	Başlık olarak kullanılacak dizin alanının adı.	No
url_field	Dize	URL olarak kullanılacak dizin alanının adı.	No
filepath_field	Dize	Dosya yolu olarak kullanılacak dizin alanının adı.	No
content_fields	Dizi	İçerik olarak ele alınması gereken dizin alanlarının adları.	Evet
content_fields_separator	Dize	İçerik alanlarının kullanması gereken ayırıcı desen.	No
vector_fields	Dizi	Vektör verilerini temsil eden alanların adları.	Evet

onYourDataAuthenticationOptions

Verilerinizde OpenAI Azure için kimlik doğrulama seçenekleri.

Adı	Türü	Açıklama	Gerekli	Varsayılan
Türü	onYourDataAuthenticationType	Verilerinizde OpenAI Azure ile desteklenen kimlik doğrulama türleri.	Evet

onYourDataAuthenticationType

Verilerinizde OpenAI Azure ile desteklenen kimlik doğrulama türleri.

Description: Verilerinizde OpenAI Azure ile desteklenen kimlik doğrulama türleri.

Tür: dize

Varsayılan:

Sabit Listesi Adı: OnYourDataAuthenticationType

Sabit Listesi Değerleri:

Değer	Açıklama
api_key	API anahtarı aracılığıyla kimlik doğrulaması.
connection_string	bağlantı dizesi aracılığıyla kimlik doğrulaması.
system_assigned_managed_identity	Sistem tarafından atanan yönetilen kimlik aracılığıyla kimlik doğrulaması.
user_assigned_managed_identity	Kullanıcı tarafından atanan yönetilen kimlik aracılığıyla kimlik doğrulaması.

onYourDataApiKeyAuthenticationOptions

API anahtarı kullanırken Verilerinizde OpenAI Azure için kimlik doğrulama seçenekleri.

Adı	Türü	Açıklama	Gerekli	Varsayılan
Türü	onYourDataAuthenticationType	Verilerinizde OpenAI Azure ile desteklenen kimlik doğrulama türleri.	Evet
Anahtar	Dize	Kimlik doğrulaması için kullanılacak API anahtarı.	No

onYourDataConnectionStringAuthenticationOptions

bağlantı dizesi kullanırken Verilerinizde OpenAI Azure için kimlik doğrulama seçenekleri.

Adı	Türü	Açıklama	Gerekli	Varsayılan
Türü	onYourDataAuthenticationType	Verilerinizde OpenAI Azure ile desteklenen kimlik doğrulama türleri.	Evet
connection_string	Dize	Kimlik doğrulaması için kullanılacak bağlantı dizesi.	No

onYourDataSystemAssignedManagedIdentityAuthenticationOptions

Sistem tarafından atanan yönetilen kimlik kullanılırken Verilerinizde OpenAI Azure için kimlik doğrulama seçenekleri.

Adı	Türü	Açıklama	Gerekli	Varsayılan
Türü	onYourDataAuthenticationType	Verilerinizde OpenAI Azure ile desteklenen kimlik doğrulama türleri.	Evet

onYourDataUserAssignedManagedIdentityAuthenticationOptions

Kullanıcı tarafından atanan yönetilen kimlik kullanılırken Verilerinizde OpenAI Azure için kimlik doğrulama seçenekleri.

Adı	Türü	Açıklama	Gerekli	Varsayılan
Türü	onYourDataAuthenticationType	Verilerinizde OpenAI Azure ile desteklenen kimlik doğrulama türleri.	Evet
managed_identity_resource_id	Dize	Kimlik doğrulaması için kullanılacak kullanıcı tarafından atanan yönetilen kimliğin kaynak kimliği.	No

onYourDataVectorizationSource

Vektör araması ile Verilerinizde OpenAI Azure için vektörleştirme kaynağının soyut gösterimi.

Adı	Türü	Açıklama	Gerekli	Varsayılan
Türü	onYourDataVectorizationSourceType	Verilerinizde OpenAI Azure ile kullanılacak verilerin vektörleştirilmesini yapılandırmak için kullanabileceği kullanılabilir kaynakları temsil eder vektör araması.	Evet

onYourDataVectorizationSourceType

Verilerinizde OpenAI Azure vektör arama ile kullanılacak verilerin vektörleştirilmesini yapılandırmak için kullanabileceği kullanılabilir kaynakları temsil eder.

Description: Verilerinizde OpenAI Azure ile kullanılacak verilerin vektörleştirilmesini yapılandırmak için kullanabileceği kullanılabilir kaynakları temsil eder
vektör araması.

Tür: dize

Varsayılan:

Sabit Listesi Adı: OnYourDataVectorizationSourceType

Sabit Listesi Değerleri:

Değer	Açıklama
Bitiş noktası	Azure OpenAI ekleme modeline yapılan genel hizmet çağrıları tarafından gerçekleştirilen vektörleştirmeyi temsil eder.
deployment_name	Kullanılacak Ada modeli dağıtım adını temsil eder. Bu model dağıtımı aynı Azure OpenAI kaynağında olmalıdır, ancak Verilerinizde bu model dağıtımını vektöre olanak tanıyan genel bir çağrı yerine iç çağrı aracılığıyla kullanır özel ağlarda bile arama.

onYourDataDeploymentNameVectorizationSource

Aynı Azure OpenAI kaynağındaki iç ekleme modeli dağıtım adını temel alan vektör arama uygularken Verilerinizde OpenAI Azure tarafından kullanılan vektörleştirme kaynağının ayrıntıları.

Adı	Türü	Açıklama	Gerekli	Varsayılan
Türü	onYourDataVectorizationSourceType	Verilerinizde OpenAI Azure ile kullanılacak verilerin vektörleştirilmesini yapılandırmak için kullanabileceği kullanılabilir kaynakları temsil eder vektör araması.	Evet
deployment_name	Dize	Vektörleştirme için kullanılacak model dağıtımının adını belirtir. Bu model dağıtımı aynı Azure OpenAI kaynağında olmalıdır, ancak Verilerinizde bu model dağıtımını özel ağlarda bile vektör aramasını etkinleştiren genel bir çağrı yerine iç çağrı aracılığıyla kullanır.	No

onYourDataEndpointVectorizationSource

Vektör arama uygularken Verilerinizde OpenAI Azure tarafından kullanılan ve eklemeler için genel Azure OpenAI uç nokta çağrısına dayanan vektörleştirme kaynağının ayrıntıları.

Adı	Türü	Açıklama	Gerekli
Türü	onYourDataVectorizationSourceType	Verilerinizde OpenAI Azure ile kullanılacak verilerin vektörleştirilmesini yapılandırmak için kullanabileceği kullanılabilir kaynakları temsil eder vektör araması.	Evet
Kimlik doğrulama	onYourDataApiKeyAuthenticationOptions	API anahtarı kullanırken Verilerinizde OpenAI Azure için kimlik doğrulama seçenekleri.	No
Bitiş noktası	Dize	Vektörleştirme için kullanılacak uç noktayı belirtir. Bu uç nokta aynı Azure OpenAI kaynağında olmalıdır, ancak Verilerinizde bu uç nokta özel ağlarda bile vektör aramasını etkinleştiren genel bir çağrı yerine iç çağrı aracılığıyla kullanılır.	No

azureChatExtensionsMessageContext

Azure OpenAI sohbet uzantıları ilgili sohbet tamamlama yanıtının oluşturulmasına dahil olduğunda sağlanan ek bağlam bilgilerinin gösterimi. Bu bağlam bilgileri yalnızca eşleşen bir uzantı kullanmak üzere yapılandırılmış bir Azure OpenAI isteği kullanılırken doldurulur.

Adı	Türü	Açıklama	Gerekli	Varsayılan
Alıntı	Dizi	Yanıtta yardımcı iletisini oluşturmak için kullanılan veri kaynağı alma sonucu.	No
Niyet	Dize	Bağlamı taşımak için bir sonraki dönüşe geçmek için kullanılan sohbet geçmişinden algılanan amaç.	No

Alıntı

sohbet tamamlamaları yanıt iletisi için alıntı bilgileri.

Adı	Türü	Açıklama	Gerekli
Içerik	Dize	Alıntının içeriği.	Evet
Başlık	Dize	Alıntının başlığı.	No
Url	Dize	Alıntının URL'si.	No
Filepath	Dize	Alıntının dosya yolu.	No
chunk_id	Dize	Alıntının öbek kimliği.	No

chatCompletionMessageToolCall

Adı	Türü	Açıklama	Gerekli
Kimliği	Dize	Araç çağrısının kimliği.	Evet
Türü	toolCallType	Bu durumda `function`araç çağrısının türü.	Evet
Işlev	Nesne	Modelin çağırdığını işlev.	Evet

İşlevin özellikleri

Adı

Adı	Türü	Açıklama	Varsayılan
Adı	Dize	Çağrılacak işlevin adı.

Bağımsız değişken

Adı	Türü	Açıklama	Varsayılan
Bağımsız değişken	Dize	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 parametreler oluşturabileceğini unutmayın. İşlevinizi çağırmadan önce kodunuzdaki bağımsız değişkenleri doğrulayın.

toolCallType

Bu durumda functionaraç çağrısının türü.

Açıklama: Bu örnekte functionaraç çağrısının türü.

Tür: dize

Varsayılan:

Sabit Listesi Adı: ToolCallType

Sabit Listesi Değerleri:

Değer	Açıklama
Işlev	Araç çağrı türü işlevdir.

chatCompletionRequestMessageTool

Adı	Türü	Açıklama	Gerekli	Varsayılan
tool_call_id	Dize	Bu iletinin yanıt verdiği araç çağrısı.	No
Içerik	Dize	İletinin içeriği.	No

chatCompletionRequestMessageFunction

Adı	Türü	Açıklama	Gerekli
Rolü	Enum	İleti yazarının rolü( bu örnekte `function`). Olası değerler: işlev	No
Adı	Dize	İletinin içeriği.	No
Içerik	Dize	İletinin içeriği.	No

createChatCompletionResponse

Sağlanan girişe göre model tarafından döndürülen sohbet tamamlama yanıtını temsil eder.

Adı	Türü	Açıklama	Gerekli
Kimliği	Dize	Sohbetin tamamlanması için benzersiz bir tanımlayıcı.	Evet
prompt_filter_results	promptFilterResults	İstekte sıfır veya daha fazla istem için içerik filtreleme sonuçları. Akış isteğinde, farklı istemlerin sonuçları farklı zamanlarda veya farklı siparişlerde gelebilir.	No
Seçenek	Dizi	Sohbet tamamlama seçeneklerinin listesi. 1'den büyükse `n` birden fazla olabilir.	Evet
Oluşturulan	Tamsayı	Sohbet tamamlamanın oluşturulduğu Unix zaman damgası (saniye olarak).	Evet
Modeli	Dize	Sohbetin tamamlanması için kullanılan model.	Evet
system_fingerprint	Dize	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.	No
Nesne	Enum	Her zaman `chat.completion`olan nesne türü. Olası değerler: chat.completion	Evet
Kullanım	completionUsage	Tamamlanma isteği için kullanım istatistikleri.	No

createChatCompletionStreamResponse

Sağlanan girişe göre model tarafından döndürülen sohbet tamamlama yanıtının akışlı bir öbeği temsil eder.

Adı	Türü	Açıklama	Gerekli
Kimliği	Dize	Sohbetin tamamlanması için benzersiz bir tanımlayıcı. Her öbek aynı kimliktedir.	Evet
Seçenek	Dizi	Sohbet tamamlama seçeneklerinin listesi. 1'den büyükse `n` birden fazla öğe içerebilir.	Evet
Oluşturulan	Tamsayı	Sohbet tamamlamanın oluşturulduğu Unix zaman damgası (saniye olarak). Her öbek aynı zaman damgasına sahiptir.	Evet
Modeli	Dize	Tamamlanmayı oluşturmak için model.	Evet
system_fingerprint	Dize	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.	No
Nesne	Enum	Her zaman `chat.completion.chunk`olan nesne türü. Olası değerler: chat.completion.chunk	Evet

chatCompletionStreamResponseDelta

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

Adı	Türü	Açıklama	Gerekli
Içerik	Dize	Öbek iletisinin içeriği.	No
function_call	Nesne	kullanım dışı bırakıldı ve tarafından `tool_calls`değiştirildi. Model tarafından oluşturulduğu gibi çağrılması gereken bir işlevin adı ve bağımsız değişkenleri.	No
tool_calls	Dizi		No
Rolü	Enum	Bu iletinin yazarının rolü. Olası değerler: sistem, kullanıcı, yardımcı, araç	No
Ret	Dize	Model tarafından oluşturulan reddetme iletisi.	No

function_call özellikleri

Bağımsız değişken

Adı	Türü	Açıklama	Varsayılan
Bağımsız değişken	Dize	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 parametreler oluşturabileceğini unutmayın. İşlevinizi çağırmadan önce kodunuzdaki bağımsız değişkenleri doğrulayın.

Adı

Adı	Türü	Açıklama	Varsayılan
Adı	Dize	Çağrılacak işlevin adı.

chatCompletionMessageToolCallChunk

Adı	Türü	Açıklama	Gerekli
Dizin	Tamsayı		Evet
Kimliği	Dize	Araç çağrısının kimliği.	No
Türü	Enum	Aracın türü. Şu anda yalnızca `function` desteklenmektedir. Olası değerler: işlev	No
Işlev	Nesne		No

İşlevin özellikleri

Adı

Adı	Türü	Açıklama	Varsayılan
Adı	Dize	Çağrılacak işlevin adı.

Bağımsız değişken

Adı	Türü	Açıklama	Varsayılan
Bağımsız değişken	Dize	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 parametreler oluşturabileceğini unutmayın. İşlevinizi çağırmadan önce kodunuzdaki bağımsız değişkenleri doğrulayın.

chatCompletionStreamOptions

Akış yanıtı seçenekleri. Bunu yalnızca ayarladığınızda ayarlayın stream: true.

Adı	Türü	Açıklama	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.	No

chatCompletionChoiceLogProbs

Seçim için olasılık bilgilerini günlüğe kaydedin.

Adı	Türü	Açıklama	Gerekli	Varsayılan
Içerik	Dizi	Günlük olasılık bilgilerini içeren ileti içerik belirteçlerinin listesi.	Evet
Ret	Dizi	Günlük olasılık bilgilerini içeren ileti reddetme belirteçlerinin listesi.	No

chatCompletionTokenLogprob

Adı	Türü	Açıklama	Gerekli
Belirte -ci	Dize	Belirteç.	Evet
logprob	Numarası	Bu belirtecin günlük olasılığı.	Evet
Bayt	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
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

chatCompletionResponseMessage

Model tarafından oluşturulan bir sohbet tamamlama iletisi.

Adı	Türü	Açıklama	Gerekli
Rolü	chatCompletionResponseMessageRole	Yanıt iletisinin yazarının rolü.	Evet
Ret	Dize	Model tarafından oluşturulan reddetme iletisi.	Evet
Içerik	Dize	İletinin içeriği.	Evet
tool_calls	Dizi	Araç, işlev çağrıları gibi model tarafından oluşturulan çağrılar.	No
function_call	chatCompletionFunctionCall	kullanım dışı bırakıldı ve tarafından `tool_calls`değiştirildi. Model tarafından oluşturulduğu gibi çağrılması gereken bir işlevin adı ve bağımsız değişkenleri.	No
Bağlam	azureChatExtensionsMessageContext	Azure OpenAI sohbet uzantıları söz konusu olduğunda sağlanan ek bağlam bilgilerinin gösterimi ilgili sohbet tamamlama yanıtının oluşturulmasında. Bu bağlam bilgileri yalnızca eşleşen bir uzantı kullanmak üzere yapılandırılmış bir Azure OpenAI isteği kullanma.	No

chatCompletionResponseMessageRole

Yanıt iletisinin yazarının rolü.

Açıklama: Yanıt iletisinin yazarının rolü.

Tür: dize

Varsayılan:

Sabit Listesi Değerleri:

Yardımcısı

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.

Bu bileşen aşağıdakilerden biri olabilir:

chatCompletionNamedToolChoice

Modelin kullanması gereken aracı belirtir. Modeli belirli bir işlevi çağırmaya zorlamak için kullanın.

Adı	Türü	Açıklama	Gerekli	Varsayılan
Türü	Enum	Aracın türü. Şu anda yalnızca `function` desteklenmektedir. Olası değerler: işlev	Evet
Işlev	Nesne		Evet

İşlevin özellikleri

Adı

Adı	Türü	Açıklama	Varsayılan
Adı	Dize	Çağrılacak işlevin adı.

ParallelToolCalls

Araç kullanımı sırasında paralel işlev çağrısının etkinleştirilip etkinleştirilmeyileceği.

Bu bileşen için tanımlı özellik yok.

chatCompletionMessageToolCalls

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

Bu bileşen için tanımlı özellik yok.

chatCompletionFunctionCall

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.

Adı	Türü	Açıklama	Gerekli	Varsayılan
Adı	Dize	Çağrılacak işlevin adı.	Evet
Bağımsız değişken	Dize	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 parametreler oluşturabileceğini unutmayın. İşlevinizi çağırmadan önce kodunuzdaki bağımsız değişkenleri doğrulayın.	Evet

completionUsage

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

Adı	Türü	Açıklama	Gerekli
prompt_tokens	Tamsayı	İstemdeki belirteç sayısı.	Evet
completion_tokens	Tamsayı	Oluşturulan tamamlamadaki belirteçlerin sayısı.	Evet
total_tokens	Tamsayı	İstekte kullanılan toplam belirteç sayısı (istem + tamamlama).	Evet
completion_tokens_details	Nesne	Tamamlanmada kullanılan belirteçlerin dökümü.	No

completion_tokens_details özellikleri

reasoning_tokens

Adı	Türü	Açıklama	Varsayılan
reasoning_tokens	Tamsayı	Model tarafından mantık yürütme için oluşturulan belirteçler.

chatCompletionTool

Adı	Türü	Açıklama	Gerekli	Varsayılan
Türü	Enum	Aracın türü. Şu anda yalnızca `function` desteklenmektedir. Olası değerler: işlev	Evet
Işlev	Functionobject		Evet

FunctionParameters

İşlevlerin kabullediği, JSON Şeması nesnesi olarak tanımlanan parametreler. Örnekler için kılavuza ve biçimle ilgili belgeler için JSON Şeması başvurusuna bakın.

Atlama parameters , boş parametre listesi olan bir işlevi tanımlar.

Bu bileşen için tanımlı özellik yok.

Functionobject

Adı	Türü	Açıklama	Gerekli	Varsayılan
Açıklama	Dize	İşlevin ne zaman ve nasıl çağrıldığını seçmek için model tarafından kullanılan işlevin ne yaptığının açıklaması.	No
Adı	Dize	Ç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
Parametre	FunctionParameters	İşlevlerin kabullediği, JSON Şeması nesnesi olarak tanımlanan parametreler. Örnekler için kılavuza ve biçimle ilgili belgeler için JSON Şeması başvurusuna bakın. Atlama `parameters` , boş parametre listesi olan bir işlevi tanımlar.	No
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. olduğunda `stricttrue`JSON Şemasının yalnızca bir alt kümesi desteklenir.	No	False

ResponseFormatText

Adı	Türü	Açıklama	Gerekli	Varsayılan
Türü	Enum	Tanımlanan yanıt biçiminin türü: `text` Olası değerler: metin	Evet

ResponseFormatJsonObject

Adı	Türü	Açıklama	Gerekli	Varsayılan
Türü	Enum	Tanımlanan yanıt biçiminin türü: `json_object` Olası değerler: json_object	Evet

ResponseFormatJsonSchemaSchema

JSON Şeması nesnesi olarak tanımlanan yanıt biçimi şeması.

Bu bileşen için tanımlı özellik yok.

ResponseFormatJsonSchema

Adı	Türü	Açıklama	Gerekli	Varsayılan
Türü	Enum	Tanımlanan yanıt biçiminin türü: `json_schema` Olası değerler: json_schema	Evet
json_schema	Nesne		Evet

json_schema özellikleri

Açıklama

Adı	Türü	Açıklama	Varsayılan
Açıklama	Dize	Yanıt biçiminin ne için olduğuna ilişkin bir açıklama, model tarafından biçimde nasıl yanıt verileceğini belirlemek için kullanılır.

Adı

Adı	Türü	Açıklama	Varsayılan
Adı	Dize	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.

Şema

Adı	Türü	Açıklama	Varsayılan
Şema	ResponseFormatJsonSchemaSchema	JSON Şeması nesnesi olarak tanımlanan yanıt biçimi şeması.

Sıkı

Adı	Türü	Açıklama	Varsayılan
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. olduğunda `stricttrue`JSON Şemasının yalnızca bir alt kümesi desteklenir.	False

chatCompletionChoiceCommon

Adı	Türü	Açıklama	Gerekli	Varsayılan
Dizin	Tamsayı		No
finish_reason	Dize		No

createTranslationRequest

Çeviri isteği.

Adı	Türü	Açıklama	Gerekli	Varsayılan
Dosya	Dize	Çevrilecek ses dosyası.	Evet
Istemi	Dize	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.	No
response_format	audioResponseFormat	Çıkışın biçimini tanımlar.	No
Sıcaklık	Numarası	Ö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.	No	0

audioResponse

response_format json olduğunda çeviri veya transkripsiyon yanıtı

Adı	Türü	Açıklama	Gerekli	Varsayılan
Metin	Dize	Çevrilmiş veya dökümü alınmış metin.	Evet

audioVerboseResponse

response_format verbose_json çeviri veya transkripsiyon yanıtı

Adı	Türü	Açıklama	Gerekli
Metin	Dize	Çevrilmiş veya dökümü alınmış metin.	Evet
Görev	Dize	Ses görevinin türü.	No
Dil	Dize	Dil.	No
Süre	Numarası	Süre.	No
Segment	Dizi		No

audioResponseFormat

Çıkışın biçimini tanımlar.

Açıklama: Çıkışın biçimini tanımlar.

Tür: dize

Varsayılan:

Sabit Listesi Değerleri:

Json
Metin
Srt
verbose_json
Vtt

createTranscriptionRequest

Transkripsiyon isteği.

Adı	Türü	Açıklama	Gerekli	Varsayılan
Dosya	Dize	Dökümü yapılan ses dosyası nesnesi.	Evet
Istemi	Dize	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.	No
response_format	audioResponseFormat	Çıkışın biçimini tanımlar.	No
Sıcaklık	Numarası	Ö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.	No	0
Dil	Dize	Giriş sesinin dili. Giriş dilini ISO-639-1 biçiminde sağlamak doğruluğu ve gecikme süresini artırır.	No

audioSegment

Transkripsiyon veya çeviri segmenti.

Adı	Türü	Açıklama	Gerekli
Kimliği	Tamsayı	Segment tanımlayıcısı.	No
Arama	Numarası	Segmentin uzaklığı.	No
Başlatmak	Numarası	Segment başlangıç uzaklığı.	No
Son -unda	Numarası	Segment sonu uzaklığı.	No
Metin	Dize	Segment metni.	No
Belirteç -leri	Dizi	Metnin belirteçleri.	No
Sıcaklık	Numarası	Sıcaklık.	No
avg_logprob	Numarası	Ortalama günlük olasılığı.	No
compression_ratio	Numarası	Sıkıştırma oranı.	No
no_speech_prob	Numarası	olasılığı `no speech`.	No

imageQuality

Oluşturulacak görüntünün kalitesi.

Açıklama: Oluşturulacak görüntünün kalitesi.

Tür: dize

Varsayılan: standart

Sabit Listesi Adı: Kalite

Sabit Listesi Değerleri:

Değer	Açıklama
Standart	Standart kalite, standart kalitede görüntüler oluşturur.
Hd	HD kalitesi, görüntü genelinde daha ayrıntılı ve daha tutarlı görüntüler oluşturur.

imagesResponseFormat

Oluşturulan görüntülerin döndürüldiği biçim.

Açıklama: Oluşturulan görüntülerin döndürülme biçimi.

Tür: dize

Varsayılan: url

Sabit Listesi Adı: ImagesResponseFormat

Sabit Listesi Değerleri:

Değer	Açıklama
Url	Oluşturulan görüntüleri indirmek için geçici erişim sağlayan URL.
b64_json	Oluşturulan görüntüler base64 kodlanmış dize olarak döndürülür.

ımagesize

Oluşturulan görüntülerin boyutu.

Açıklama: Oluşturulan görüntülerin boyutu.

Tür: dize

Varsayılan: 1024x1024

Sabit Listesi Adı: Boyut

Sabit Listesi Değerleri:

Değer	Açıklama
1792x1024	Oluşturulan görüntünün istenen boyutu 1792x1024 pikseldir.
1024x1792	Oluşturulan görüntünün istenen boyutu 1024x1792 pikseldir.
1024x1024	Oluşturulan görüntünün istenen boyutu 1024x1024 pikseldir.

imageStyle

Oluşturulan görüntülerin stili.

Açıklama: Oluşturulan görüntülerin stili.

Tür: dize

Varsayılan: canlı

Sabit Listesi Adı: Stil

Sabit Listesi Değerleri:

Değer	Açıklama
Canlı	Canlı, hiper gerçekçi ve dramatik görüntüler oluşturur.
Doğal	Doğal, daha doğal ve daha az hiper gerçekçi görüntüler oluşturur.

imageGenerationsRequest

Adı	Türü	Açıklama	Gerekli	Varsayılan
Istemi	Dize	İstenen resimlerin metin açıklaması. Uzunluk üst sınırı 4.000 karakterdir.	Evet
n	Tamsayı	Oluşturulacak görüntü sayısı.	No	1
Boyutu	ımagesize	Oluşturulan görüntülerin boyutu.	No	1024x1024
response_format	imagesResponseFormat	Oluşturulan görüntülerin döndürüldiği biçim.	No	Url
Kullanıcı	Dize	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ı.	No
Kalite	imageQuality	Oluşturulacak görüntünün kalitesi.	No	Standart
Stil	imageStyle	Oluşturulan görüntülerin stili.	No	Canlı

generateImagesResponse

Adı	Türü	Açıklama	Gerekli	Varsayılan
Oluşturulan	Tamsayı	İşlemin oluşturulduğu unix zaman damgası.	Evet
Veri	Dizi	Başarılı olursa işlemin sonuç verileri	Evet

imageResult

Başarılı olursa resim URL'si veya kodlanmış görüntü ve aksi takdirde bir hata.

Adı	Türü	Açıklama	Gerekli
Url	Dize	Resim URL'si.	No
b64_json	Dize	base64 kodlanmış görüntüsü	No
content_filter_results	dalleContentFilterResults	İçerik filtreleme sonuçları hakkında bilgi.	No
revised_prompt	Dize	İstemde herhangi bir düzeltme varsa, görüntüyü oluşturmak için kullanılan istem.	No
prompt_filter_results	dalleFilterResults	İçerik filtreleme kategorisi (nefret, cinsel, şiddet, self_harm), algılanıp algılanmadığı, önem düzeyi (zararlı içeriğin yoğunluğunu ve risk düzeyini belirleyen very_low, düşük, orta, yüksek ölçekli) ve filtrelenip filtrelenmediği hakkında bilgi. Jailbreak içeriği ve küfür, algılanıp algılanmadığı ve filtrelenip filtrelenmediği hakkında bilgiler. Filtrelenip filtrelenmediği ve kimliği olan müşteri blok listesi hakkındaki bilgileri de bulabilirsiniz.	No

Tamamlama uzantıları

Tamamlama uzantıları, OpenAI veri düzlemi çıkarım belirtiminin Azure en son GA sürümünün bir parçası değildir.

Sohbet iletisi

Sohbet iletisi nesnesi, Azure OpenAI veri düzlemi çıkarım belirtiminin en son GA sürümünün bir parçası değildir.

Metin okuma (Önizleme)

Şu anda Azure OpenAI veri düzlemi çıkarım belirtiminin en son Azure OpenAI GA sürümünün parçası değildir. Bu özelliğin en son preview sürümüne bakın.

Sonraki adımlar

Modeller hakkında bilgi edinin ve REST API ile ince ayarlamalar yapın. OpenAI Azure destekleyen underlying modelleri hakkında daha fazla bilgi edinin.

Geri Bildirim

Bu sayfayı yararlı buldunuz mu?

Last updated on 2026-04-30